Skip to main content
GET
/
products
/
{product_id}
/
spec-details
List all Specification details included in this Documentation Product
curl --request GET \
  --url http://localhost:3001/portal-api/products/{product_id}/spec-details \
  --header 'Authorization: <api-key>'
[
  {
    "SpecAlias": "payment_api",
    "CID": "2r7p8aUnkzby17hCJk8w2XvK3K6",
    "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

Query Parameters

​
limit
integer

Maximum number of records to return for this request. Overrides the row count only, not the page offset (which is always based on per_page), so use per_page for pagination rather than combining limit with page. Defaults to the per_page value.

​
per_page
integer
default:20

Items per page. Defaults to the resource-specific page count if configured, otherwise 20

​
page
integer
default:1

Page number. Defaults to 1 when omitted

Response

200 - application/json

OK

​
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