OpenAPI 3

This page lists all supported OpenAPI 3 elements and rules.

Supported OpenAPI 3 versions are 3.0.0, 3.0.1, 3.0.2, and 3.0.3. The OpenApi version 3.1 is not supported at the moment.

Supported REST Service Elements And Rules

Services are defined using the following elements:

Element				Supported by Connector	Description	More Information at ...
`openapi`					Supported versions are 3.0.0, 3.0.1, 3.0.2, and 3.0.3. 3.1.0 is not supported.
`info`					Provides metadata about the API.
	`title`				Used as name for the REST interface. This is the name of the connector. If you create a connector with the same title it will replace the connector.
	`description`				Used as documentation for the REST interface.
	`termsOfService`				A URL to the Terms of Service for the API. It must be in the format of a URL.
	`contact`				Contact information for the exposed API.
	`license`				License information for the exposed API.
	`version`				Version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).
`server`					The host (name or IP) serving the API.
	`url`				A URL to the target host. Only the first url will be used. The URL will be split to the following attributes of the REST alias: Protocol Port Host Base Path If the URL is relative, then Host is empty. The REST adapter only supports HTTP and HTTPS.	REST Adapter Reference
	`description`				An optional string describing the host designated by the URL.
	`variables`				The variables will not be expanded.
`produces`					A list of MIME types the APIs can produce. The REST adapter only parses JSON and XML.
`paths`					Available paths and operations for the API. REST resource classes are created to reproduce each paths structure. Paths that contain encoded characters are imported as follows: Encoded Characters: `:` (colon) `%3A` (encoded colon) <a parameter>`=`{<a parameter value>} Replaced by: and 2. class name: `_` (underscore) relative path: `::` 3. parameter: curly brackets ignored, result is `<a parameter>=<a parameter value>`
	`$ref`				Allows for an external definition of this path item.
	`summary`				Optional string summary, intended to apply to all operations in this path.
	`description`				Optional string description, intended to apply to all operations in this path.
	`server`				Alternative `server` array to service all operations in this path.
	`methods`				HTTP methods defined for this path. A REST operation is created for each methods. Supported HTTP methods are get, put, post, delete, options, head, patch, trace.
		`tags`			List of tags for API documentation control.
		`summary`			Short summary of what the operation does. If the description if empty, the summary is used as documentation for the operation.
		`description`			Verbose explanation of the operation behavior. The description is used as documentation for the operation.
		`externalDocs`			Additional external documentation for this operation.
		`operationId`			Unique string used to identify the operation.
		`requestBody`			Request body applicable for this operation.
			`description`		Brief description of the request body.
			`content`		Content of the request body. The key is a media type or media type range and the value describes it.	Media Type Object
			`required`		Determines if the request body is required in the request.
		`produces`			List of MIME types the operation can produce. As the REST adapter only support JSON and XML if produces is defined and none of these are in the list the responses are ignored.
		`parameters`			List of parameters of parameter reference that are applicable for this operation. A REST parameter is created for each parameter object.	Parameter Object
		`responses`			List of possible responses as they are returned from executing this operation. An output parameter is created for the default response status code (201 for POST, 200 for the others).
			`description`		Short description of the response. The description is used as a documentation for the parameter or the usage.
			`content`		Definition or definition reference of the response structure. The adapter does not support primitives as response therefore a responses of these types are ignored.	Media Type Object
			`headers`		List of headers that are sent with the response. Will be generated as out parameters.
			`links`		Map of operations links that can be followed from the response.
		`callbacks`			Map of possible out-of band callbacks related to the parent operation.
		`deprecated`			Declares this operation to be deprecated.
		`security`			Declaration of which security schemes are applied to this operation.
		`servers`			Alternative `server` array to service this operation.
	`parameters`				List of parameters that are applicable to all the operations described under this path.
`components`					Holds a set of reusable objects for different aspects of the OpenAPI specification.
	`schemas`				List to hold data types produced and consumed by operations. A class is created for each schema object.	Schema Object
	`responses`				List to hold responses that can be used across operations.
	`parameters`				List to hold parameters that can be used across operations.	Parameter Object
	`examples`				List to hold parameters that can be used across operations.
	`requestBodies`				List to hold requestBodies that can be used across operations.
	`headers`				List to hold headers that can be used across operations.
	`securitySchemes`				List to hold securitySchemes that can be used across operations.
	`links`				List to hold links that can be used across operations.
	`callbacks`				List to hold callbacks that can be used across operations.

Supported REST Parameter Elements And Rules

Element	Used By Connector	Description	More Information at ...
`name`		The name of the parameter. Parameter names are case sensitive. If in is "path", the name field must correspond to the associated path segment from the path. For all other cases, the name corresponds to the parameter name based on the in property.	See Path Templating for further information.
`in`	( )	The location of the parameter. Possible values are "query", "header" or "path". "cookie" is not supported by the importer and ignored
`description`		A brief description of the parameter
`required`		Determines whether this parameter is mandatory.
deprecated		Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
`allowEmptyValue`		Sets the ability to pass empty-valued parameters.
`style`		Describes how the parameter value will be serialized depending on the type of the parameter value.
`explode`		When this is true, parameter values of type `array` or `object` generate separate parameters for each value of the array or key-value pair of the map.
`allowReserved`		Determines whether the parameter value SHOULD allow reserved characters.
`schema`		The schema defining the type used for the parameter.	Schema Object
`example`		Example of the parameter's potential value.
`examples`		Examples of the parameter's potential value.

Supported REST Media Type Elements and Rules

Element	Used By Connector	Description	More Information at ...
`schema`		The schema defining the type used for the parameter.	Schema Object
`example`		Example of the parameter's potential value.
`examples`		Examples of the parameter's potential value.
`encoding`		A map between a property name and its encoding information.

Supported REST Schema Elements And Rules

Element	Supported By Connector	Description	More Information at ...
`$ref`		A reference to a schema defined in the definitions list. the schema object is replaced by the definition. If the schema reference defines a schema object without any properties, and the `type` of this object is a simple type (not object), the importer generates this simple type to the parameter (see description of `type` below).
`type`		The type of the object. Open API Type: integer Base Type: Integer Open API Type: number Base Type: Float Open API Type: boolean Base Type: Boolean Open API Type: string Base Type: depends on the format byte or binary: Blob date-time or date: DateTime Other formats: String Open API Type: array Base Type: If used as type of a parameter or property, it will be an array of items (see below). Open API Type: object Base Type: A class and properties are created regarding the allOf and properties values. If `type` is not given at all, and the definition has no properties, it will be imported as `urn:Base Types.Any`.
`description`		Description of the class or property.
`format`		The format of the object is used to be more specific when the type is string.
`items`		The item is a schema object to defined the type of element in the array. Only used if type is array.
`allOf`		List of schema object. The resulting class will contain all properties of all listed schema objects.
`oneOf`		Type Any is used.
`anyOf`		Type Any is used.
`not`		Type Any is used.
`properties`		List of properties. Each property is define by a name and a schema object. A property is created on the resulting class for each properties defined.
`additionalProperties`		This should allow to define a map/dictionary.
`default`		The default value represents what would be assumed by the consumer of the input as the value of the schema if one is not provided.
`multipleOf`
`maximum`
`exclusiveMaximum`
`minimum`
`exclusiveMinimum`
`maxLength`
`minLength`
`pattern`		This string must be a valid regular expression, according to the Ecma-262 Edition 5.1 regular expression dialect.
`maxItems`
`minItems`
`uniqueItems`
`maxProperties`
`minProperties`
`required`
`enum`
`nullable`		A `true` value adds `"null"` to the allowed type specified by the `type` keyword, only if `type` is explicitly defined within the same Schema Object.
`discriminator`		Adds support for polymorphism. The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description.
`readOnly`		Declares the property as read only. This means that it may be sent as part of a response but should not be sent as part of the request.
`writeOnly`		Declares the property as write only. This means that it may be sent as part of a request but should not be sent as part of the response.
`xml`		May be used on properties schemas only. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property.
`externalDocs`		Additional external documentation for this schema.
`example`		Example.
`deprecated`		Specifies that a schema is deprecated and should be transitioned out of usage.

📘

Related Documentation:

OpenAPI Specification