OasModelHelper (Server :: API Generator 1.12.0 API)

java.lang.Object
- io.syndesis.server.api.generator.openapi.util.OasModelHelper

public final class OasModelHelper
extends Object

Field Summary

Fields
Modifier and Type Field and Description

static String URL_EXTENSION

Fields
Modifier and Type	Field and Description
`static String`	`URL_EXTENSION`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Map<String,io.apicurio.datamodels.openapi.models.OasOperation>`	`getOperationMap(io.apicurio.datamodels.openapi.models.OasPathItem pathItem)` Construct map of all specified operations for given path item.
`static <T extends io.apicurio.datamodels.openapi.models.OasOperation> Map<String,T>`	`getOperationMap(io.apicurio.datamodels.openapi.models.OasPathItem pathItem, Class<T> type)` Construct map of all specified operations for given path item.
`static List<io.apicurio.datamodels.openapi.models.OasParameter>`	`getParameters(io.apicurio.datamodels.openapi.models.OasOperation operation)`
`static List<io.apicurio.datamodels.openapi.models.OasParameter>`	`getParameters(io.apicurio.datamodels.openapi.models.OasPathItem pathItem)`
`static List<io.apicurio.datamodels.openapi.models.OasPathItem>`	`getPathItems(io.apicurio.datamodels.openapi.models.OasPaths paths)` Iterate through list of generic path items and collect path items of given type.
`static String`	`getPropertyName(io.apicurio.datamodels.openapi.models.OasSchema schema)` Applies property name getter on given schema object if applicable.
`static String`	`getPropertyName(io.apicurio.datamodels.openapi.models.OasSchema schema, String defaultName)` Applies property name getter on given schema object if applicable.
`static String`	`getReferenceName(String reference)` Get pure name from reference path.
`static boolean`	`isArrayType(io.apicurio.datamodels.openapi.models.OasSchema schema)` Determines if given schema is of type array.
`static boolean`	`isBody(io.apicurio.datamodels.openapi.models.OasParameter parameter)` Determines if given parameter lives in body.
`static boolean`	`isReferenceType(io.apicurio.datamodels.openapi.models.OasParameter parameter)` Determines if given parameter has a reference to another schema object.
`static boolean`	`isReferenceType(io.apicurio.datamodels.openapi.models.OasSchema schema)` Determines if given schema has a reference to another schema object.
`static boolean`	`isSerializable(io.apicurio.datamodels.openapi.models.OasParameter parameter)` Checks for serializable nature of given parameter.
`static OperationDescription`	`operationDescriptionOf(io.apicurio.datamodels.openapi.models.OasDocument openApiDoc, io.apicurio.datamodels.openapi.models.OasOperation operation, BiFunction<String,String,String> consumer)`
`static String`	`sanitizeTag(String tag)` Makes sure that the tag used as a key in a JSON object is a valid key determined by io.syndesis.server.jsondb.impl.JsonRecordSupport::validateKey.
`static Stream<String>`	`sanitizeTags(List<String> list)`
`static boolean`	`schemaIsNotSpecified(io.apicurio.datamodels.openapi.models.OasSchema schema)`
`static URI`	`specificationUriFrom(io.apicurio.datamodels.openapi.models.OasDocument openApiDoc)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - URL_EXTENSION
```
public static final String URL_EXTENSION
```
    See Also:
    
    Constant Field Values
- Method Detail
  - operationDescriptionOf
```
public static OperationDescription operationDescriptionOf(io.apicurio.datamodels.openapi.models.OasDocument openApiDoc,
                                                          io.apicurio.datamodels.openapi.models.OasOperation operation,
                                                          BiFunction<String,String,String> consumer)
```
  - getPathItems
```
public static List<io.apicurio.datamodels.openapi.models.OasPathItem> getPathItems(io.apicurio.datamodels.openapi.models.OasPaths paths)
```
    Iterate through list of generic path items and collect path items of given type.
    
    Parameters:
    
    paths - given path items.
    
    Returns:
    
    typed list of path items.
  - getParameters
```
public static List<io.apicurio.datamodels.openapi.models.OasParameter> getParameters(io.apicurio.datamodels.openapi.models.OasOperation operation)
```
  - getParameters
```
public static List<io.apicurio.datamodels.openapi.models.OasParameter> getParameters(io.apicurio.datamodels.openapi.models.OasPathItem pathItem)
```
  - sanitizeTag
```
public static String sanitizeTag(String tag)
```
    Makes sure that the tag used as a key in a JSON object is a valid key determined by io.syndesis.server.jsondb.impl.JsonRecordSupport::validateKey.
  - sanitizeTags
```
public static Stream<String> sanitizeTags(List<String> list)
```
  - getOperationMap
```
public static Map<String,io.apicurio.datamodels.openapi.models.OasOperation> getOperationMap(io.apicurio.datamodels.openapi.models.OasPathItem pathItem)
```
    Construct map of all specified operations for given path item. Only non-null operations are added to the map where the key is the http method name.
    
    Parameters:
    
    pathItem - path holding operations.
    
    Returns:
    
    map of operations on the given path where Http method name is the key.
  - getOperationMap
```
public static <T extends io.apicurio.datamodels.openapi.models.OasOperation> Map<String,T> getOperationMap(io.apicurio.datamodels.openapi.models.OasPathItem pathItem,
                                                                                                           Class<T> type)
```
    Construct map of all specified operations for given path item. Only non-null operations are added to the map where the key is the http method name.
    
    Parameters:
    
    pathItem - path holding operations.
    
    type - operation type for version 2.x or 3.x.
    
    Returns:
    
    map of operations on the given path where Http method name is the key.
  - getReferenceName
```
public static String getReferenceName(String reference)
```
    Get pure name from reference path. Usually reference definitions start with '#/definitions/' for OpenAPI 2.x and '#/components/schemas/' for OpenAPI 3.x and this method removes the basic reference path part and just returns the reference object name.
    
    Parameters:
    
    reference - path expression.
    
    Returns:
    
    the name of the reference object.
  - isArrayType
```
public static boolean isArrayType(io.apicurio.datamodels.openapi.models.OasSchema schema)
```
    Determines if given schema is of type array.
    
    Parameters:
    
    schema - to check
    
    Returns:
    
    true if given schema is an array.
  - isReferenceType
```
public static boolean isReferenceType(io.apicurio.datamodels.openapi.models.OasSchema schema)
```
    Determines if given schema has a reference to another schema object.
    
    Parameters:
    
    schema - to check
    
    Returns:
    
    true if given schema has a reference.
  - isReferenceType
```
public static boolean isReferenceType(io.apicurio.datamodels.openapi.models.OasParameter parameter)
```
    Determines if given parameter has a reference to another schema object.
    
    Parameters:
    
    parameter - to check
    
    Returns:
    
    true if given parameter has a reference.
  - isBody
```
public static boolean isBody(io.apicurio.datamodels.openapi.models.OasParameter parameter)
```
    Determines if given parameter lives in body.
    
    Parameters:
    
    parameter - to check.
    
    Returns:
    
    true if given parameter is a body parameter.
  - getPropertyName
```
public static String getPropertyName(io.apicurio.datamodels.openapi.models.OasSchema schema)
```
    Applies property name getter on given schema object if applicable. Otherwise use null.
    
    Parameters:
    
    schema - the provided schema
    
    Returns:
    
    property name or null.
  - getPropertyName
```
public static String getPropertyName(io.apicurio.datamodels.openapi.models.OasSchema schema,
                                     String defaultName)
```
    Applies property name getter on given schema object if applicable. Otherwise use given default name.
    
    Parameters:
    
    schema - the provided schema.
    
    defaultName - the default name if property name is not applicable.
    
    Returns:
    
    property name or default value.
  - isSerializable
```
public static boolean isSerializable(io.apicurio.datamodels.openapi.models.OasParameter parameter)
```
    Checks for serializable nature of given parameter. These are parameters that live in form data, query, header, request path or cookies.
    
    Parameters:
    
    parameter - to check.
    
    Returns:
    
    true if parameter is serializable.
  - schemaIsNotSpecified
```
public static boolean schemaIsNotSpecified(io.apicurio.datamodels.openapi.models.OasSchema schema)
```
  - specificationUriFrom
```
public static URI specificationUriFrom(io.apicurio.datamodels.openapi.models.OasDocument openApiDoc)
```

Class OasModelHelper

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

URL_EXTENSION

Method Detail

operationDescriptionOf

getPathItems

getParameters

getParameters

sanitizeTag

sanitizeTags

getOperationMap

getOperationMap

getReferenceName

isArrayType

isReferenceType

isReferenceType

isBody

getPropertyName

getPropertyName

isSerializable

schemaIsNotSpecified

specificationUriFrom