API Gateway Service, REST: ApiGateway.GetOpenapiSpec
Written by
Updated at January 14, 2025
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
|
Field |
Description |
|
apiGatewayId |
string Required field. ID of the API gateway to get specification from. |
Query parameters
|
Field |
Description |
|
format |
enum (Format) Format of returned specification. Default is the original format used in CreateApiGatewayRequest.
|
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. |