github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/openapi-generator/templates/ruby-client/api_doc.mustache (about)

     1  # {{moduleName}}::{{classname}}{{#description}}
     2  
     3  {{description}}{{/description}}
     4  
     5  All URIs are relative to *{{basePath}}*
     6  
     7  Method | HTTP request | Description
     8  ------------- | ------------- | -------------
     9  {{#operations}}{{#operation}}[**{{operationId}}**]({{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}}
    10  {{/operation}}{{/operations}}
    11  
    12  {{#operations}}
    13  {{#operation}}
    14  
    15  ## {{operationId}}
    16  
    17  > {{#returnType}}{{returnType}} {{/returnType}}{{operationId}}{{#hasParams}}({{#requiredParams}}{{{paramName}}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#optionalParams}}{{#-last}}{{#hasRequiredParams}}, {{/hasRequiredParams}}opts{{/-last}}{{/optionalParams}}){{/hasParams}}
    18  
    19  {{{summary}}}{{#notes}}
    20  
    21  {{{notes}}}{{/notes}}
    22  
    23  ### Example
    24  
    25  ```ruby
    26  # load the gem
    27  require '{{{gemName}}}'
    28  {{#hasAuthMethods}}
    29  # setup authorization
    30  {{{moduleName}}}.configure do |config|{{#authMethods}}{{#isBasic}}{{#isBasicBasic}}
    31    # Configure HTTP basic authorization: {{{name}}}
    32    config.username = 'YOUR USERNAME'
    33    config.password = 'YOUR PASSWORD'{{/isBasicBasic}}{{#isBasicBearer}}
    34    # Configure Bearer authorization{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}: {{{name}}}
    35    config.access_token = 'YOUR_BEARER_TOKEN'{{/isBasicBearer}}{{/isBasic}}{{#isApiKey}}
    36    # Configure API key authorization: {{{name}}}
    37    config.api_key['{{{keyParamName}}}'] = 'YOUR API KEY'
    38    config.api_key_prefix['{{{keyParamName}}}'] = 'token'{{/isApiKey}}{{#isOAuth}}
    39    # Configure OAuth2 access token for authorization: {{{name}}}
    40    config.access_token = 'YOUR ACCESS TOKEN'{{/isOAuth}}
    41  {{/authMethods}}end
    42  {{/hasAuthMethods}}
    43  
    44  api_instance = {{{moduleName}}}::{{{classname}}}.new
    45  {{#requiredParams}}
    46  {{{paramName}}} = {{{vendorExtensions.x-ruby-example}}} # {{{dataType}}} | {{{description}}}
    47  {{/requiredParams}}
    48  {{#optionalParams}}
    49  {{#-first}}
    50  opts = {
    51  {{/-first}}
    52    {{{paramName}}}: {{{vendorExtensions.x-ruby-example}}}{{^-last}},{{/-last}} # {{{dataType}}} | {{{description}}}
    53  {{#-last}}
    54  }
    55  {{/-last}}
    56  {{/optionalParams}}
    57  
    58  begin
    59  {{#summary}}  #{{{.}}}
    60  {{/summary}}  {{#returnType}}result = {{/returnType}}api_instance.{{{operationId}}}{{#hasParams}}({{#requiredParams}}{{{paramName}}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#optionalParams}}{{#-last}}{{#hasRequiredParams}}, {{/hasRequiredParams}}opts{{/-last}}{{/optionalParams}}){{/hasParams}}{{#returnType}}
    61    pp result{{/returnType}}
    62  rescue {{{moduleName}}}::ApiError => e
    63    puts "Exception when calling {{classname}}->{{{operationId}}}: #{e}"
    64  end
    65  ```
    66  
    67  ### Parameters
    68  
    69  {{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}}
    70  Name | Type | Description  | Notes
    71  ------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}
    72  {{#allParams}} **{{paramName}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}[**{{dataType}}**]({{baseType}}.md){{/isFile}}{{/isPrimitiveType}}| {{description}} | {{^required}}[optional] {{/required}}{{#defaultValue}}[default to {{defaultValue}}]{{/defaultValue}}
    73  {{/allParams}}
    74  
    75  ### Return type
    76  
    77  Response<({{#returnType}}{{#returnTypeIsPrimitive}}**{{returnType}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{returnType}}**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}nil (empty response body){{/returnType}})>
    78  
    79  ### Authorization
    80  
    81  {{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{name}}](../README.md#{{name}}){{^-last}}, {{/-last}}{{/authMethods}}
    82  
    83  ### HTTP request headers
    84  
    85  - **Content-Type**: {{#consumes}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}
    86  - **Accept**: {{#produces}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/produces}}{{^produces}}Not defined{{/produces}}
    87  
    88  {{/operation}}
    89  {{/operations}}