# properties.description.description
An introductory, optionally verbose, explanation supporting [CommonMark](http://commonmark.org/help/) syntax. If you'd like to load an **external markdown file**, you can use flexible configuration, for instance `"description": {{include "openapi/intro.md" | toJson }}`

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.audience.description
The list of audiences that will consume this endpoint. These values **do not define the gateway logic** in any way. They are a way to group endpoints and filter them out when generating the OpenAPI documentation. Use `*` to indicate an endpoint will be present in any audience generated.

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.base_path.description
A starting path that is appended to any endpoint.

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.components_schemas.description
The JSON Schemas you can reuse inside endpoint definitions using `ref`. You can either pass the JSON Schema object, or a bas64 string.

# properties.contact_email.description
Email where users of your API can write to.

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.contact_url.description
Contact URL that users of your API can read.

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.example.description
**Deprecated in OAS3** (use `response_definition` instead). A free form JSON object or a string you would like to show as a sample response of the endpoint. The examples assume they are JSON content types except when using the `output_encoding=string`.

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.host.description
The hostname where you will publish your API.

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.jwt_key.description
When generating an OpenAPI spec, the name of the JWT key used under components securitySchemes.

# properties.license_url.description
The URL where the license is hosted

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.operation_id.description
A unique string identifying the operation identifier. Usually the method + the endpoint. If provided, these IDs must be unique among all operations described in your API.

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.param_definition.description
Sets a description for the URL parameters (e.g.: `/foo/{param}`) required in the endpoint. Make sure to include to write the param exactly as in the endpoint definition.

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.param_definition.items.properties.name.description
The name of the parameter, as declared in `endpoint` without the curly braces `{}`

# properties.query_definition.description
Sets a description for the query strings allowed in the endpoint. Make sure to include the same strings in the endpoint's `input_query_strings`.

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.query_definition.items.properties.required.description
Set to `true` when this query string is required

# properties.query_definition.items.properties.name.description
The name of the querystring, as declared in `input_query_strings`

# properties.request_definition.description
Describes the payload needed to consume the endpoint. If a JSON Schema validation exists, it takes precedence when generating the documentation. An example use case is when you need to document a `multipart/form-data` request body.This property is an array because you can document requests with multiple content types.

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.request_definition.items.properties.description.description
The description of the payload this endpoint accepts.

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.request_definition.items.properties.content_type.description
The content type returned by this error, e.g., `application/json`. You cannot repeat this content type in another item.

# properties.request_definition.items.properties.example.description
A free form JSON object or a string you would like to show as a sample response of the endpoint. The examples assume they are JSON content types except when using the `output_encoding=string`.

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.request_definition.items.properties.example_schema.description
A JSON schema that describes the request format for the accepted payload in the endpoint. Use either example or example_schema, but not both.

# properties.request_definition.items.properties.ref.description
The relative reference to the `components/schema` OpenAPI definition that will be used as definition of the accepted request. Notice that the path `#/components/schemas/` is not needed.

# properties.response_definition.description
Describes the different status codes returned by this endpoint. Each key is the definition of the status code, represented by a string. E.g., `200` (success), `500` (internal error), etc.

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.response_definition.patternProperties.default|^[0-9]+$.properties.description.description
The description of this error code, e.g., `Page not found`.

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.response_definition.patternProperties.default|^[0-9]+$.properties.content_type.description
The content type returned by this error, e.g., `application/json`

# properties.response_definition.patternProperties.default|^[0-9]+$.properties.example.description
A free form JSON object or a string you would like to show as a sample response of the endpoint. The examples assume they are JSON content types except when using the `output_encoding=string`.

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.response_definition.patternProperties.default|^[0-9]+$.properties.example_schema.description
A JSON schema that describes the response format for the endpoint, directly as a JSON object, or encoded as a base64 string. Use either example or example_schema, but not both.

# properties.response_definition.patternProperties.default|^[0-9]+$.properties.ref.description
The relative reference to the `components/schema` OpenAPI definition that will be used as definition of the accepted request. Notice that the path `#/components/schemas/` is not needed.

# properties.schemes.description
The list of schemes supported by the API, e.g. `http` or `https`

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.summary.description
A short summary for the endpoint. Use the description field for the longest explanation.

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.tag_definition.description
Sets a description for the tags classifiying endpoints when generating the OpenAPI spec.

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.tag_definition.items.properties.name.description
The name of the tag. You will use this name in each endpoint.

# properties.tags.description
You can assign a list of tags to each API operation. If you declare tags in the `tag_definition` at the OpenAPI service level, they will have a description in the documentation. Tagged operations may be handled differently by tools and libraries. For example, Swagger UI uses tags to group the displayed operations.

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.terms_of_service.description
The URL to the terms of service for using this API.

See: https://www.krakend.io/docs/enterprise/developer/openapi/

# properties.version.description
The version numbering you want to apply to this release of API., e.g.: `1.0`.

See: https://www.krakend.io/docs/enterprise/developer/openapi/