OpenAPI 3.0.x (Swagger 3.0) 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:// and wss:// .
  • 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 and style properties used for parameter descriptions.
  • API Definitions does not support the nullable attribute used to specify that a parameter value may be null.

OpenAPI Object

Field nameNested elementsNested elementsSupported
openapisupported
info
titlesupported
descriptionsupported
termsOfServiceignored
contactignored
licenseignored
servers
urlSupported:
  • one base path per API configuration.
    In case of multiple base paths, only the first one is accepted.
  • multiple hostnames pointing to the same base path.
  • http and https schemas.
    no schema is treated as http.

    Not supported:
  • variable names in { brackets }
  • descriptionignored
    variablesignored
    paths
    $refCan refer internally in file only to schema definition.
    summaryignored
    descriptionimported as Resource Description
    parameterssupported
    serversnot supported
    You cannot override the servers object on the path level.
    get / post and other operations
    parameterssupported
    serversnot supported
    You cannot override the servers object on the operation level.
    media typeYou can only refer to one media type (for example, application/json) in a request body definition.
    In case you have multiple media types, only the first one is imported.
    Note, that when xml and json have identical schemas, we support xml and json 2 media types.
    responsesup to 2 responses supported, if the schemas are the same for some status codes we merge them under list of those status codes.
    descriptionignored (with a warning)
    components
    schemassupported
    parameterssupported
    requestBodiessupported
    securitySchemasonly apiKey object supported
    responsesup to 2 responses supported, if the schemas are the same for some status codes, they are merged them under list of those status codes.
    descriptionignored (with a warning)
    headerssupported.
    Imported as response headers into api definition
    exampleignored
    linksignored
    callbacksignored
    security + (securitySchemes)supported type: apiKey In case you have multiple API keys, only the first one is imported.
    tagsignored (with a warning)
    externalDocsignored (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.