{{/* Render a single HTTP API operation: that is, a method+endpoint combination, given: * `method`: the method, e.g. GET, PUT * `endpoint`: the endpoint * `operation_data`: the OpenAPI/Swagger data for the operation * `path`: the path where this definition was found, to enable us to resolve "$ref" This template renders the operation as a `
` containing: * an `

` heading containing the method and endpoint * a `
` element containing the details, including: * operation description * basic info about the operation * request details * response details */}} {{ $method := .method }} {{ $endpoint := .endpoint }} {{ $operation_data := .operation_data }} {{ $path := .path }}

{{ $method }} {{ $endpoint }}


{{ if $operation_data.deprecated }} {{ partial "alert" (dict "type" "warning" "omit_title" "true" "content" "This API is deprecated and will be removed from a future release.") }} {{ end }}

{{ $operation_data.description | markdownify }}

{{ $rate_limited := index $operation_data.responses "429" }}
Rate-limited:{{ if $rate_limited }}Yes{{ else }}No{{ end }}
Requires authentication: {{ if $operation_data.security }}Yes{{ else }}No{{ end }}

{{ partial "openapi/render-request" (dict "parameters" $operation_data.parameters "path" $path) }}
{{ partial "openapi/render-responses" (dict "responses" $operation_data.responses "path" $path) }}