[AAWF-638] Remove description requirements (#2908)

* handle missing discription

* Regenerate client from commit 77596ba of spec repo

---------

Co-authored-by: skarimo <sherzod.karimov@datadoghq.com>
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
Co-authored-by: skarimo <40482491+skarimo@users.noreply.github.com>

Author: 3 people

.generator/schemas/v1/openapi.yaml

@@ -9646,6 +9646,8 @@ components:
       type: object
     NotebookGlobalTime:
       description: Notebook global timeframe.
+      example:
+        live_span: 1h
       oneOf:
       - $ref: '#/components/schemas/NotebookRelativeTime'
       - $ref: '#/components/schemas/NotebookAbsoluteTime'
@@ -14820,6 +14822,7 @@ components:
     SyntheticsAssertionTargetValue:
       description: Value used by the operator in assertions. Can be either a number
         or string.
+      example: 0.0
       oneOf:
       - $ref: '#/components/schemas/SyntheticsAssertionTargetValueNumber'
       - $ref: '#/components/schemas/SyntheticsAssertionTargetValueString'

.generator/schemas/v2/openapi.yaml

@@ -2361,6 +2361,7 @@ components:
       - $ref: '#/components/schemas/ActionQueryMockedOutputsObject'
     ActionQueryMockedOutputsEnabled:
       description: Whether to enable the mocked outputs for testing.
+      example: false
       oneOf:
       - type: boolean
       - description: If this is a string, it must be a valid JavaScript expression
@@ -2450,6 +2451,7 @@ components:
         type: string
     ActionQuerySpec:
       description: The definition of the action query.
+      example: ''
       oneOf:
       - type: string
       - $ref: '#/components/schemas/ActionQuerySpecObject'
@@ -13516,6 +13518,7 @@ components:
       type: object
     CustomAttributeValuesUnion:
       description: Union of supported value for a custom attribute
+      example: ''
       oneOf:
       - $ref: '#/components/schemas/CustomAttributeStringValue'
       - $ref: '#/components/schemas/CustomAttributeMultiStringValue'
@@ -33546,6 +33549,7 @@ components:
     ObservabilityPipelineOcsfMapperProcessorMappingMapping:
       description: Defines a single mapping rule for transforming logs into the OCSF
         schema.
+      example: CloudTrail Account Change
       oneOf:
       - $ref: '#/components/schemas/ObservabilityPipelineOcsfMappingLibrary'
     ObservabilityPipelineOcsfMapperProcessorType:

.generator/src/generator/formatter.py

@@ -166,6 +166,8 @@ def header(self, text, level, raw=None):
 
 
 def docstring(text):
+    if not text:
+        return text
     return (
         m2r2.convert((text or "").replace("\\n", "\\\\n"), renderer=CustomRenderer())[1:-1]
         .replace("\\ ", " ")

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

@@ -25,7 +25,7 @@ from {{ package }}.{{ version }}.model.{{ model|safe_snake_case }} import {{ mod
 {% set classname = name|class_name %}
 class {{ classname }}:
     """
-    {{ description|docstring|indent(4) }}
+    {{ (description or "")|docstring|indent(4) }}
     """
     def __init__(self, api_client=None):
         if api_client is None:
@@ -140,18 +140,18 @@ class {{ classname }}:
 {%- for path, method, operation in operations|sort(attribute="2.operationId") %}
 {%- set returnType = operation|return_type %}
     def {{ operation.operationId|safe_snake_case }}(self, {% for name, parameter in operation|parameters if parameter.required %}{{name|attribute_name}}: {{ get_type_for_parameter(parameter, typing=True) }}, {% endfor %}{% for name, parameter in operation|parameters if not parameter.required %}{% if loop.first %}*, {% endif %}{{name|attribute_name}}: Union[{{ get_type_for_parameter(parameter, typing=True) }}, UnsetType]=unset, {% endfor %}) -> {% if returnType %}{{ returnType.replace("[", "List[") }}{% else %}None{% endif %}:
-        """{{ operation.summary|indent(8) }}.{% if operation.deprecated %} **Deprecated**.{% endif %}
+        """{{ (operation.summary or "")|indent(8) }}.{% if operation.deprecated %} **Deprecated**.{% endif %}
 {% if operation.description %}
-        {{ operation.description|docstring|indent(8) }}
+        {{ (operation.description or "")|docstring|indent(8) }}
 {% endif %}
 {%- for name, parameter in operation|parameters if parameter.required %}
 {%- if parameter.description %}
-        :param {{ name|attribute_name }}: {{ parameter.description|docstring|indent(12) }}{% if parameter.default %} Defaults to {{ parameter.default }}.{% endif %}{% endif %}
+        :param {{ name|attribute_name }}: {{ (parameter.description or "")|docstring|indent(12) }}{% if parameter.default %} Defaults to {{ parameter.default }}.{% endif %}{% endif %}
         :type {{ name|attribute_name }}: {{ get_type_for_parameter(parameter) }}
 {%- endfor %}
 {%- for name, parameter in operation|parameters if not parameter.required %}
 {%- if parameter.description %}
-        :param {{ name|attribute_name }}: {{ parameter.description|docstring|indent(12) }}{%- if parameter.default %} If omitted the server will use the default value of {{ parameter.default }}.{% endif %}{% endif %}
+        :param {{ name|attribute_name }}: {{ (parameter.description or "")|docstring|indent(12) }}{%- if parameter.default %} If omitted the server will use the default value of {{ parameter.default }}.{% endif %}{% endif %}
         :type {{ name|attribute_name }}: {{ get_type_for_parameter(parameter) }}, optional
 {%- endfor %}
 
@@ -175,18 +175,18 @@ class {{ classname }}:
     {%- set pagination = operation["x-pagination"] %}
 
     def {{ operation.operationId|safe_snake_case }}_with_pagination(self, {% for name, parameter in operation|parameters if parameter.required %}{{name|attribute_name}}: {{ get_type_for_parameter(parameter, typing=True) }}, {% endfor %}{% for name, parameter in operation|parameters if not parameter.required %}{% if loop.first %}*, {% endif %}{{name|attribute_name}}: Union[{{ get_type_for_parameter(parameter, typing=True) }}, UnsetType]=unset, {% endfor %}) -> collections.abc.Iterable[{{ get_type_at_path(operation, pagination.resultsPath) }}]:
-        """{{ operation.summary|indent(8) }}.
+        """{{ (operation.summary or "")|indent(8) }}.
 
         Provide a paginated version of :meth:`{{ operation.operationId|safe_snake_case }}`, returning all items.
 {# keep new line #}
 {%- for name, parameter in operation|parameters if parameter.required %}
 {%- if parameter.description %}
-        :param {{ name|attribute_name }}: {{ parameter.description|docstring|indent(12) }}{% if parameter.default %} Defaults to {{ parameter.default }}.{% endif %}{% endif %}
+        :param {{ name|attribute_name }}: {{ (parameter.description or "")|docstring|indent(12) }}{% if parameter.default %} Defaults to {{ parameter.default }}.{% endif %}{% endif %}
         :type {{ name|attribute_name }}: {{ get_type_for_parameter(parameter) }}
 {%- endfor %}
 {%- for name, parameter in operation|parameters if not parameter.required %}
 {%- if parameter.description %}
-        :param {{ name|attribute_name }}: {{ parameter.description|docstring|indent(12) }}{%- if parameter.default %} If omitted the server will use the default value of {{ parameter.default }}.{% endif %}{% endif %}
+        :param {{ name|attribute_name }}: {{ (parameter.description or "")|docstring|indent(12) }}{%- if parameter.default %} If omitted the server will use the default value of {{ parameter.default }}.{% endif %}{% endif %}
         :type {{ name|attribute_name }}: {{ get_type_for_parameter(parameter) }}, optional
 {%- endfor %}
 

.generator/src/generator/templates/model_enum.j2

@@ -3,9 +3,7 @@ from typing import ClassVar
 
 class {{ name }}(ModelSimple):
     """
-{%- if "description" in model %}
-    {{ model.description|indent(8) }}
-{%- endif %}
+    {{ (model.description or "")|indent(8) }}
 
     :param value: {%- if default != None %} If omitted defaults to {{ default|format_value }}.{%- endif %} Must be one of [{%- for value in model.enum %}{{ value|format_value }}{% if not loop.last %}, {% endif %}{%- endfor %}].
     :type value: {{ get_enum_type(model) }}

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

@@ -122,12 +122,10 @@ class {{ name }}(ModelNormal):
         {%- if attr not in model.get("required", []) %} {{ attr|attribute_name }}: {{ get_typing_for_attribute(model, attr, current_name=name, optional=True) }}=unset,{% endif %}
 {%- endfor %} **kwargs):
         """
-{%- if "description" in model %}
-        {{ model.description|docstring|indent(8) }}
-{%- endif %}
+        {{ (model.description or "")|docstring|indent(8) }}
 {%- for attr, definition in model.get("properties", {}).items() %}
 {# keep new line #}
-        :param {{ attr|attribute_name }}: {% if "description" in definition %}{{ definition.description|docstring|indent(12) }}{% if definition.deprecated %} **Deprecated**.{% endif %}{% endif %}
+        :param {{ attr|attribute_name }}: {{ (definition.description or "")|docstring|indent(12) }}{% if definition.deprecated %} **Deprecated**.{% endif %}
         :type {{ attr|attribute_name }}: {{ get_type_for_attribute(model, attr, current_name=name) }}{% if definition.nullable %}, none_type{% endif %}{% if attr not in model.get("required", []) %}, optional{% endif %}
 {%- endfor %}
         """

.generator/src/generator/templates/model_oneof.j2

@@ -8,12 +8,10 @@ class {{ name }}(ModelComposed):
 
     def __init__(self, **kwargs):
         """
-{%- if "description" in model %}
-        {{ model.description|docstring|indent(8) }}
-{%- endif %}
+        {{ (model.description or "")|docstring|indent(8) }}
 {%- for attr, definition, schema in get_oneof_parameters(model) %}
 {# keep new line #}
-        :param {{ attr|attribute_name }}: {% if "description" in definition %}{{ definition.description|indent(12) }}{% endif %}
+        :param {{ attr|attribute_name }}: {{ (definition.description or "")|indent(12) }}
         :type {{ attr|attribute_name }}: {{ get_type_for_attribute(schema, attr, current_name=name) }}{% if definition.nullable %}, none_type{% endif %}{% if attr not in schema.get("required", []) %}, optional{% endif %}
 {%- endfor %}
         """

.generator/src/generator/templates/model_simple.j2

@@ -2,9 +2,7 @@
 
 class {{ name }}(ModelSimple):
     """
-{%- if "description" in model %}
-    {{ model.description|docstring|indent(8) }}
-{%- endif %}
+    {{ (model.description or "")|docstring|indent(8) }}
 
 {# empty line #}
 {%- if "default" in model and model.default != None %}