github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/openapi-generator/templates/python/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}}}({{#allParams}}{{#required}}{{{paramName}}}{{/required}}{{^required}}{{{paramName}}}={{{paramName}}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}})
    15  
    16  {{{summary}}}{{#notes}}
    17  
    18  {{{notes}}}{{/notes}}
    19  
    20  ### Example
    21  
    22  {{> api_doc_example }}
    23  
    24  ### Parameters
    25  {{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}}
    26  Name | Type | Description  | Notes
    27  ------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}
    28  {{#allParams}} **{{paramName}}** | {{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}{{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{baseType}}.md){{/isPrimitiveType}}{{/isFile}}| {{description}} | {{^required}}[optional] {{/required}}{{#defaultValue}}[default to {{defaultValue}}]{{/defaultValue}}
    29  {{/allParams}}
    30  
    31  ### Return type
    32  
    33  {{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{{returnType}}}**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}void (empty response body){{/returnType}}
    34  
    35  ### Authorization
    36  
    37  {{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{{name}}}](../README.md#{{{name}}}){{^-last}}, {{/-last}}{{/authMethods}}
    38  
    39  ### HTTP request headers
    40  
    41   - **Content-Type**: {{#consumes}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}
    42   - **Accept**: {{#produces}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/produces}}{{^produces}}Not defined{{/produces}}
    43  
    44  {{#responses.0}}
    45  ### HTTP response details
    46  | Status code | Description | Response headers |
    47  |-------------|-------------|------------------|
    48  {{#responses}}
    49  **{{code}}** | {{message}} | {{#headers}} * {{baseName}} - {{description}} <br> {{/headers}}{{^headers.0}} - {{/headers.0}} |
    50  {{/responses}}
    51  {{/responses.0}}
    52  
    53  [[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)
    54  
    55  {{/operation}}
    56  {{/operations}}