Skip to content

Commit ac72881

Browse files
jack-edmonds-ddci.datadog-api-spec
andauthored
Allow missing descriptions. (DataDog#2730)
* Allow missing descriptions. * pre-commit fixes * Preserve blank line. * Restore lines. --------- Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent c222047 commit ac72881

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

.generator/src/generator/templates/api.j2

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ module {{ module_name }}::{{ version|upper }}
3636
#
3737
{%- endif %}
3838
{%- for name, parameter in operation|parameters if parameter.required %}
39-
# @param {{ name|attribute_name }} [{{ get_type_for_parameter(parameter) }}] {{ parameter.get("description", "").replace('\n', ' ') }}
39+
# @param {{ name|attribute_name }} [{{ get_type_for_parameter(parameter) }}] {{ (parameter.get("description") or "").replace('\n', ' ') }}
4040
{%- endfor %}
4141
# @param opts [Hash] the optional parameters
4242
{%- for name, parameter in operation|parameters if not parameter.required %}
43-
# @option opts [{{ get_type_for_parameter(parameter) }}] :{{ name|attribute_name }} {{ parameter.get("description", "").replace('\n', ' ') }}{% if "default" in parameter%} (default to {{ parameter.default|json }}) {% endif %}
43+
# @option opts [{{ get_type_for_parameter(parameter) }}] :{{ name|attribute_name }} {{ (parameter.get("description") or "").replace('\n', ' ') }}{% if "default" in parameter%} (default to {{ parameter.default|json }}) {% endif %}
4444
{%- endfor %}
4545
# @return [Array<({% if returnType %}{{ returnType }}{% else %}nil{% endif %}, Integer, Hash)>] {% if returnType %}{{ returnType }} data{% else %}nil{% endif %}, response status code and response headers
4646
def {{ operation.operationId|snake_case }}_with_http_info({% for name, parameter in operation|parameters if parameter.required %}{{ name|attribute_name }}, {% endfor %}opts = {})

.generator/src/generator/templates/model_generic.j2

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@
1616
or
1717
definition.enum is defined #}
1818

19+
{%- if "description" in definition %}
20+
{# preserve blank line #}
1921
{{ definition.description|block_comment|indent(4) }}
22+
{%- endif %}
2023
{%- if has_validation %}
2124
attr_reader :{{ attr|attribute_name }}
2225
{%- else %}

0 commit comments

Comments
 (0)