Delete API Product Version

Removes an API product version.

delete

Path Parameters

apiProductIdstring(uuid)required

The API product identifier

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

idstring(uuid)required

The API product version identifier

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

Response

API product version was deleted successfully.

delete/api-products/{apiProductId}/product-versions/{id}
 

API Product Version Specification

Create API Product Version Specification

Creates a specification for a version of an API product.
Note: You can only have one specification for a product version.

post

Path Parameters

apiProductIdstring(uuid)required

The API product identifier

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

apiProductVersionIdstring(uuid)required

The API product version identifier

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

Body

application/json

Create API Product Version Specification Request

The request schema to create a specification for a version of an API product.

* Additional properties are NOT allowed.
namestringrequired

The name of the API product version specification

Match pattern:^.+(?:\.yaml|\.yml|\.json)$

>= 1 characters<= 255 characters

Example:oas.yaml

contentstring(byte)required

The base64 encoded contents of the API product version specification

>= 1 characters

Example:TXkgWUFNTCBvciBKU09OIGZvcm1hdHRlZCBPQVMgY29udGVudA==

Response

application/json

API product version specification

API Product Version Spec

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

The API product version specification identifier.

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

namestringrequired

The name of the API product version specification

Match pattern:^.+(?:\.yaml|\.yml|\.json)$

Example:oas.yaml

contentstringrequired

The contents of the API product version specification

Example:My YAML or JSON formatted OAS content

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

post/api-products/{apiProductId}/product-versions/{apiProductVersionId}/specifications

Body

{ "name": "oas.yaml", "content": "TXkgWUFNTCBvciBKU09OIGZvcm1hdHRlZCBPQVMgY29udGVudA==" }
 
application/json

List API Product Version Specifications

Returns a list of specification for the version of an API product.
Note: You can only have one specification for a product version.

get

Path Parameters

apiProductIdstring(uuid)required

The API product identifier

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

apiProductVersionIdstring(uuid)required

The API product version identifier

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

Response

application/json

List of API product version specification

ListAPIProductVersionSpecResponse

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
get/api-products/{apiProductId}/product-versions/{apiProductVersionId}/specifications
 
application/json

Get an API Product Version Specification

Returns a specification for the version of an API product.

get

Path Parameters

apiProductIdstring(uuid)required

The API product identifier

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

apiProductVersionIdstring(uuid)required

The API product version identifier

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

specificationIdstring(uuid)required

The API product version specification identifier

Example:742ff9f1-fb89-4aeb-a599-f0e278c7aeaa

Response

application/json

API product version specification

API Product Version Spec

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

The API product version specification identifier.

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

namestringrequired

The name of the API product version specification

Match pattern:^.+(?:\.yaml|\.yml|\.json)$

Example:oas.yaml

contentstringrequired

The contents of the API product version specification

Example:My YAML or JSON formatted OAS content

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/api-products/{apiProductId}/product-versions/{apiProductVersionId}/specifications/{specificationId}
 
application/json