List API Specifications

DEPRECATED

Returns a list of specifications for an API. The specification can be of type OpenAPI or AsyncAPI.
Note: You can only have one specification for an API. This endpoint is deprecated and will be removed: use /versions instead.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filters API Specs in the response.

Show Child Parameters

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

Response

application/json

List of API specifications (OpenAPI or AsyncAPI)

ListApiSpecResponse

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
get/apis/{apiId}/specifications
 
application/json

Get API Specification

DEPRECATED

Fetches the specification (OpenAPI or AsyncAPI) of an API.
Note: This endpoint is deprecated and will be removed: use /versions instead.

get

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

specIdstring(uuid)required

The API specification identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

API specification (OpenAPI or AsyncAPI)

API Specification

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The API specification identifier.

Example:7710d5c4-d902-410b-992f-18b814155b53

contentstringrequired

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

Example:{"openapi":"3.0.3","info":{"title":"Example API","version":"1.0.0"},"paths":{"/example":{"get":{"summary":"Example endpoint","responses":{"200":{"description":"Successful response"}}}}}}

validation_messagesarray[object]requiredread-only

The errors that occurred while parsing the API specification.

* Additional properties are NOT allowed.
Show Child Parameters
typestringrequired

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

Allowed values:oas2oas3asyncapi

Example:oas3

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/apis/{apiId}/specifications/{specId}
 
application/json

Update API Specification

DEPRECATED

Updates the specification (OpenAPI or AsyncAPI) of an API.
Note: This endpoint is deprecated and will be removed: use /versions instead.

patch

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

specIdstring(uuid)required

The API specification identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

API Specification

* Additional properties are NOT allowed.
contentstring

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

Example:{"openapi":"3.0.3","info":{"title":"Example API","version":"1.0.0"},"paths":{"/example":{"get":{"summary":"Example endpoint","responses":{"200":{"description":"Successful response"}}}}}}

typestring

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

Allowed values:oas2oas3asyncapi

Example:oas3

Response

application/json

API specification (OpenAPI or AsyncAPI)

API Specification

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The API specification identifier.

Example:7710d5c4-d902-410b-992f-18b814155b53

contentstringrequired

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

Example:{"openapi":"3.0.3","info":{"title":"Example API","version":"1.0.0"},"paths":{"/example":{"get":{"summary":"Example endpoint","responses":{"200":{"description":"Successful response"}}}}}}

validation_messagesarray[object]requiredread-only

The errors that occurred while parsing the API specification.

* Additional properties are NOT allowed.
Show Child Parameters
typestringrequired

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

Allowed values:oas2oas3asyncapi

Example:oas3

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

patch/apis/{apiId}/specifications/{specId}

Body

{ "content": "{\"openapi\":\"3.0.3\",\"info\":{\"title\":\"Example API\",\"version\":\"1.0.1\"},\"paths\":{\"/example\":{\"get\":{\"summary\":\"Example endpoint\",\"responses\":{\"200\":{\"description\":\"Successful response\"}}}}}}" }
 
application/json

Delete API Specification

DEPRECATED

Deletes the specification (OpenAPI or AsyncAPI) of an API.
Note: This endpoint is deprecated and will be removed: use /versions instead.

delete

Path Parameters

apiIdstring(uuid)required

The UUID API identifier

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

specIdstring(uuid)required

The API specification identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

API Specification was deleted successfully.

delete/apis/{apiId}/specifications/{specId}
 

API Publication