API Gateway Service, REST: ApiGateway.getOpenapiSpec
Written by
Updated at May 26, 2023
Returns the OpenAPI specification of specified API gateway.
HTTP request
GET https://serverless-apigateway.api.cloud.yandex.net/apigateways/v1/apigateways/{apiGatewayId}:spec
Path parameters
Parameter | Description |
---|---|
apiGatewayId | Required. ID of the API gateway to get specification from. |
Query parameters
Parameter | Description |
---|---|
format | Format of returned specification. Default is the original format used in |
Response
HTTP Code: 200 - OK
{
"apiGatewayId": "string",
"openapiSpec": "string"
}
Field | Description |
---|---|
apiGatewayId | string ID of the API gateway. |
openapiSpec | string The text of specification, JSON or YAML. |