API Gateway Service, gRPC: ApiGatewayService.GetOpenapiSpec
Written by
Updated at January 14, 2025
Returns the OpenAPI specification of specified API gateway.
gRPC request
rpc GetOpenapiSpec (GetOpenapiSpecRequest) returns (GetOpenapiSpecResponse)
GetOpenapiSpecRequest
{
"api_gateway_id": "string",
"format": "Format"
}
|
Field |
Description |
|
api_gateway_id |
string Required field. ID of the API gateway to get specification from. |
|
format |
enum Format Format of returned specification. Default is the original format used in CreateApiGatewayRequest.
|
GetOpenapiSpecResponse
{
"api_gateway_id": "string",
"openapi_spec": "string"
}
|
Field |
Description |
|
api_gateway_id |
string ID of the API gateway. |
|
openapi_spec |
string The text of specification, JSON or YAML. |