OpenAPI 3.0.x support
API Definitions supports the import of API definition files in OpenAPI 3.0 (Swagger 3.0) format with the limitations listed below. Review these limitations before importing your API definition file.
- API Definitions supports variables in base paths and resource paths, but not in hostnames, what includes schema (for example, http, https). For example, you may include this URL in the
servers
object:https://my-api.akamai.com/{username}
, but not this one:https://{username}.akamai.com
- API Definitions does not support WebSocket protocols,
ws://
andwss://
. - You can only describe one API key per API configuration.
- API Definitions does not support the
not
keyword. - API Definitions does not support the
explode
andstyle
properties used for parameter descriptions. - API Definitions does not support the
nullable
attribute used to specify that a parameter value may benull
.
OpenAPI Object
Field name | Nested elements | Nested elements | Supported |
---|---|---|---|
openapi | supported | ||
info | |||
title | supported | ||
description | supported | ||
termsOfService | ignored | ||
contact | ignored | ||
license | ignored | ||
servers | |||
url | Supported: Not supported: | ||
description | ignored | ||
variables | ignored | ||
paths | |||
$ref | Can refer internally in file only to schema definition. | ||
summary | ignored | ||
description | imported as | ||
parameters | supported | ||
servers | not supported | ||
get / post and other operations | |||
parameters | supported | ||
servers | not supported | ||
media type | You can only refer to one media type (for example, | ||
responses | up to 2 responses supported, if the schemas are the same for some status codes we merge them under list of those status codes. | ||
description | ignored (with a warning) | ||
components | |||
schemas | supported | ||
parameters | supported | ||
requestBodies | supported | ||
securitySchemas | only apiKey object supported | ||
responses | up to 2 responses supported, if the schemas are the same for some status codes, they are merged them under list of those status codes. | ||
description | ignored (with a warning) | ||
headers | supported. | ||
example | ignored | ||
links | ignored | ||
callbacks | ignored | ||
security + (securitySchemes) | supported type: | ||
tags | ignored (with a warning) | ||
externalDocs | ignored (with a warning) |
Schema Object
Supported properties:
- maxLength
- minLength
- maximum
- minimum
- maxItems
- minItems
- required
- properties
- items
- type
Ignored properties:
- additionalProperties
The rest of the properties are not supported.
Updated about 1 month ago