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

     1  {{#models}}{{#model}}# {{moduleName}}::{{classname}}
     2  
     3  ## Properties
     4  
     5  Name | Type | Description | Notes
     6  ------------ | ------------- | ------------- | -------------
     7  {{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}}[default to {{defaultValue}}]{{/defaultValue}}
     8  {{/vars}}
     9  
    10  ## Code Sample
    11  
    12  ```ruby
    13  require '{{moduleName}}'
    14  
    15  instance = {{moduleName}}::{{classname}}.new({{#vars}}{{name}}: {{example}}{{^-last}},
    16                                   {{/-last}}{{/vars}})
    17  ```
    18  
    19  {{/model}}{{/models}}