POST
/
products
/
{product_id}
/
spec-details
Add a new specification to this Documentation Product
curl --request POST \
  --url http://localhost:3001/portal-api/products/{product_id}/spec-details \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "CID": "2r7p8aUnkzby17hCJk8w2XvK3K6",
  "SpecAlias": "payment_api",
  "OASUrl": "https://petstore.swagger.io/v2/swagger.json",
  "Name": "Payment API Documentation"
}'
{
  "CID": "2r7p8aUnkzby17hCJk8w2XvK3K6",
  "SpecAlias": "payment_api",
  "OASUrl": "https://petstore.swagger.io/v2/swagger.json",
  "Name": "Payment API Documentation",
  "ID": 1
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
product_id
integer
required

UID of an API Product

Example:

1

Body

application/json
​
SpecAlias
string
required

Alias/identifier for this Specification

Example:

"payment_api"

​
CID
string

Client ID associated with this Specification

Example:

"2r7p8aUnkzby17hCJk8w2XvK3K6"

​
OASUrl
string

URL of OpenAPI Specification. The document must be a valid OAS document

Example:

"https://petstore.swagger.io/v2/swagger.json"

​
Name
string

Name of the Specification

Example:

"Payment API Documentation"

Response

Created

​
SpecAlias
string
required

Alias/identifier for this Specification

Example:

"payment_api"

​
CID
string

Client ID associated with this Specification

Example:

"2r7p8aUnkzby17hCJk8w2XvK3K6"

​
OASUrl
string

URL of OpenAPI Specification. The document must be a valid OAS document

Example:

"https://petstore.swagger.io/v2/swagger.json"

​
Name
string

Name of the Specification

Example:

"Payment API Documentation"

​
ID
integer

Unique identifier of the Specification

Example:

1