API Package Specification

Get the API package current specification

Changed on

Fetches the current specification of an API Package.

get/v3/api-packages/{packageId}/current-specification

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/api-packages/{packageId}/current-specification
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Response

API specification (OpenAPI or AsyncAPI)

idstring uuid required

The API specification identifier.

contentstring required

The raw content of your API specification, in json or yaml format (OpenAPI or AsyncAPI).

type'oas2' | 'oas3' | 'asyncapi' required

The type of specification being stored. This allows us to render the specification correctly.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "id": "7710d5c4-d902-410b-992f-18b814155b53",
  "content": "{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.0\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}",
  "type": "oas3",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 401.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status