All Products
Search
Document Center

API Gateway:HttpApiResponseContract

Last Updated:Nov 10, 2025
ParameterTypeDescriptionExample
object

The response format.

contentTypestring

The content type.

application/json
itemsarray<object>

The response definition.

object

The response body.

codeinteger

The response code.

200
examplestring

The sample value.

{"result": "ok"}
descriptionstring

The response description.

This is a description.
jsonSchemastring

The JSON definition description of the response body.

{ "type": "object", "required": [ "result" ], "properties": { "result": { "type": "string", "description": "This is a description." } } }