github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/openapi-generator/templates/python/python-experimental/api_doc.mustache (about) 1 # {{packageName}}.{{classname}}{{#description}} 2 {{description}}{{/description}} 3 4 All URIs are relative to *{{basePath}}* 5 6 Method | HTTP request | Description 7 ------------- | ------------- | ------------- 8 {{#operations}}{{#operation}}[**{{operationId}}**]({{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}} 9 {{/operation}}{{/operations}} 10 11 {{#operations}} 12 {{#operation}} 13 # **{{{operationId}}}** 14 > {{#returnType}}{{{returnType}}} {{/returnType}}{{{operationId}}}({{#requiredParams}}{{^defaultValue}}{{paramName}}{{^-last}}, {{/-last}}{{/defaultValue}}{{/requiredParams}}) 15 16 {{{summary}}}{{#notes}} 17 18 {{{notes}}}{{/notes}} 19 20 ### Example 21 22 {{#hasAuthMethods}} 23 {{#authMethods}} 24 {{#isBasic}} 25 {{#isBasicBasic}} 26 * Basic Authentication ({{name}}): 27 {{/isBasicBasic}} 28 {{#isBasicBearer}} 29 * Bearer{{#bearerFormat}} ({{{.}}}){{/bearerFormat}} Authentication ({{name}}): 30 {{/isBasicBearer}} 31 {{/isBasic}} 32 {{#isApiKey}} 33 * Api Key Authentication ({{name}}): 34 {{/isApiKey }} 35 {{#isOAuth}} 36 * OAuth Authentication ({{name}}): 37 {{/isOAuth }} 38 {{/authMethods}} 39 {{/hasAuthMethods}} 40 {{> python-experimental/api_doc_example }} 41 ### Parameters 42 {{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}} 43 Name | Type | Description | Notes 44 ------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}} 45 {{#requiredParams}}{{^defaultValue}} **{{paramName}}** | {{^baseType}}**{{dataType}}**{{/baseType}}{{#baseType}}[**{{dataType}}**]({{baseType}}.md){{/baseType}}| {{description}} | 46 {{/defaultValue}}{{/requiredParams}}{{#requiredParams}}{{#defaultValue}} **{{paramName}}** | {{^baseType}}**{{dataType}}**{{/baseType}}{{#baseType}}[**{{dataType}}**]({{baseType}}.md){{/baseType}}| {{description}} | defaults to {{{.}}} 47 {{/defaultValue}}{{/requiredParams}}{{#optionalParams}} **{{paramName}}** | {{^baseType}}**{{dataType}}**{{/baseType}}{{#baseType}}[**{{dataType}}**]({{baseType}}.md){{/baseType}}| {{description}} | [optional]{{#defaultValue}} if omitted the server will use the default value of {{{.}}}{{/defaultValue}} 48 {{/optionalParams}} 49 50 ### Return type 51 52 {{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{{returnType}}}**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}void (empty response body){{/returnType}} 53 54 ### Authorization 55 56 {{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{{name}}}](../README.md#{{{name}}}){{^-last}}, {{/-last}}{{/authMethods}} 57 58 ### HTTP request headers 59 60 - **Content-Type**: {{#consumes}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/consumes}}{{^consumes}}Not defined{{/consumes}} 61 - **Accept**: {{#produces}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/produces}}{{^produces}}Not defined{{/produces}} 62 63 {{#responses.0}} 64 ### HTTP response details 65 | Status code | Description | Response headers | 66 |-------------|-------------|------------------| 67 {{#responses}} 68 **{{code}}** | {{message}} | {{#headers}} * {{baseName}} - {{description}} <br> {{/headers}}{{^headers.0}} - {{/headers.0}} | 69 {{/responses}} 70 {{/responses.0}} 71 72 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) 73 74 {{/operation}} 75 {{/operations}}