Skip to content

Commit 1a1f298

Browse files
api-clients-generation-pipeline[bot]therveci.datadog-api-spec
authored
Fix model docs for oneOf (#500)
* Fix oneOf model docs * Regenerate client from commit 3dc8157 of spec repo Co-authored-by: Thomas Hervé <[email protected]> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com> Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent e232aa0 commit 1a1f298

27 files changed

+109
-236
lines changed

‎.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.4.1.dev8",
7-
"regenerated": "2021-07-01 19:05:29.738551",
8-
"spec_repo_commit": "1847a67"
7+
"regenerated": "2021-07-05 09:40:16.099125",
8+
"spec_repo_commit": "3dc8157"
99
},
1010
"v2": {
1111
"apigentools_version": "1.4.1.dev8",
12-
"regenerated": "2021-07-01 19:05:55.554024",
13-
"spec_repo_commit": "1847a67"
12+
"regenerated": "2021-07-05 09:40:40.074245",
13+
"spec_repo_commit": "3dc8157"
1414
}
1515
}
1616
}

‎.generator/templates/model_doc.mustache

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
## Properties
77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
9+
{{#oneOf}}
10+
**{{.}}** | [**{{.}}**]({{.}}.md) | Container class of the relevant properties. |
11+
{{/oneOf}}
12+
{{^oneOf}}
913
{{#isEnum}}
1014
**value** | {{^arrayModelType}}**{{dataType}}**{{/arrayModelType}} | {{description}} | {{#defaultValue}}{{#hasRequired}} if omitted the server will use the default value of {{/hasRequired}}{{^hasRequired}}defaults to {{/hasRequired}}{{{.}}}{{/defaultValue}}{{#allowableValues}}{{#defaultValue}}, {{/defaultValue}} must be one of [{{#enumVars}}{{{value}}}, {{/enumVars}}]{{/allowableValues}}
1115
{{/isEnum}}
@@ -31,6 +35,7 @@ Name | Type | Description | Notes
3135
{{#additionalPropertiesType}}
3236
**any string name** | **{{additionalPropertiesType}}** | any string name can be used but the value must be the correct type | [optional]
3337
{{/additionalPropertiesType}}
38+
{{/oneOf}}
3439

3540
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
3641

‎docs/v1/FormulaAndFunctionQueryDefinition.md

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,9 @@ A formula and function query.
55
## Properties
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**aggregator** | [**FormulaAndFunctionMetricAggregation**](FormulaAndFunctionMetricAggregation.md) | | [optional]
9-
**group_by** | [**[FormulaAndFunctionEventQueryGroupBy]**](FormulaAndFunctionEventQueryGroupBy.md) | Group by options. | [optional]
10-
**indexes** | **[str]** | An array of index names to query in the stream. Omit or use &#x60;[]&#x60; to query all indexes at once. | [optional]
11-
**search** | [**FormulaAndFunctionEventQueryDefinitionSearch**](FormulaAndFunctionEventQueryDefinitionSearch.md) | | [optional]
12-
**is_normalized_cpu** | **bool** | Whether to normalize the CPU percentages. | [optional]
13-
**limit** | **int** | Number of hits to return. | [optional]
14-
**sort** | [**QuerySortOrder**](QuerySortOrder.md) | | [optional]
15-
**tag_filters** | **[str]** | An array of tags to filter by. | [optional]
16-
**text_filter** | **str** | Text to use as filter. | [optional]
17-
**data_source** | [**FormulaAndFunctionProcessQueryDataSource**](FormulaAndFunctionProcessQueryDataSource.md) | | [optional]
18-
**name** | **str** | Name of query for use in formulas. | [optional]
19-
**query** | **str** | Metrics query definition. | [optional]
20-
**compute** | [**FormulaAndFunctionEventQueryDefinitionCompute**](FormulaAndFunctionEventQueryDefinitionCompute.md) | | [optional]
21-
**metric** | **str** | Process metric name. | [optional]
22-
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
8+
**FormulaAndFunctionEventQueryDefinition** | [**FormulaAndFunctionEventQueryDefinition**](FormulaAndFunctionEventQueryDefinition.md) | Container class of the relevant properties. |
9+
**FormulaAndFunctionMetricQueryDefinition** | [**FormulaAndFunctionMetricQueryDefinition**](FormulaAndFunctionMetricQueryDefinition.md) | Container class of the relevant properties. |
10+
**FormulaAndFunctionProcessQueryDefinition** | [**FormulaAndFunctionProcessQueryDefinition**](FormulaAndFunctionProcessQueryDefinition.md) | Container class of the relevant properties. |
2311

2412
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
2513

‎docs/v1/LogsProcessor.md

Lines changed: 15 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,21 @@ Definition of a logs processor.
55
## Properties
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**is_enabled** | **bool** | Whether or not the processor is enabled. | [optional] if omitted the server will use the default value of False
9-
**name** | **str** | Name of the processor. | [optional]
10-
**samples** | **[str]** | List of sample logs to test this grok parser. | [optional]
11-
**override_on_conflict** | **bool** | Override or not the target element if already set, | [optional] if omitted the server will use the default value of False
12-
**preserve_source** | **bool** | Remove or preserve the remapped source element. | [optional] if omitted the server will use the default value of False
13-
**source_type** | **str** | Defines if the sources are from log &#x60;attribute&#x60; or &#x60;tag&#x60;. | [optional] if omitted the server will use the default value of "attribute"
14-
**target_format** | [**TargetFormatType**](TargetFormatType.md) | | [optional]
15-
**target_type** | **str** | Defines if the final attribute or tag name is from log &#x60;attribute&#x60; or &#x60;tag&#x60;. | [optional] if omitted the server will use the default value of "attribute"
16-
**normalize_ending_slashes** | **bool, none_type** | Normalize the ending slashes or not. | [optional] if omitted the server will use the default value of False
17-
**is_encoded** | **bool** | Define if the source attribute is URL encoded or not. | [optional] if omitted the server will use the default value of False
18-
**is_replace_missing** | **bool** | If true, it replaces all missing attributes of &#x60;template&#x60; by an empty string. If &#x60;false&#x60; (default), skips the operation for missing attributes. | [optional] if omitted the server will use the default value of False
19-
**filter** | [**LogsFilter**](LogsFilter.md) | | [optional]
20-
**processors** | [**[LogsProcessor]**](LogsProcessor.md) | Ordered list of processors in this pipeline. | [optional]
21-
**default_lookup** | **str** | Value to set the target attribute if the source value is not found in the list. | [optional]
22-
**grok** | [**LogsGrokParserRules**](LogsGrokParserRules.md) | | [optional]
23-
**source** | **str** | Source attribute used to perform the lookup. | [optional]
24-
**type** | [**LogsTraceRemapperType**](LogsTraceRemapperType.md) | | [optional]
25-
**sources** | **[str]** | Array of source attributes. | [optional] if omitted the server will use the default value of ["dd.trace_id"]
26-
**target** | **str** | Name of the attribute that contains the corresponding value in the mapping list or the &#x60;default_lookup&#x60; if not found in the mapping list. | [optional]
27-
**categories** | [**[LogsCategoryProcessorCategory]**](LogsCategoryProcessorCategory.md) | Array of filters to match or not a log and their corresponding &#x60;name&#x60;to assign a custom value to the log. | [optional]
28-
**expression** | **str** | Arithmetic operation between one or more log attributes. | [optional]
29-
**template** | **str** | A formula with one or more attributes and raw text. | [optional]
30-
**lookup_table** | **[str]** | Mapping table of values for the source attribute and their associated target attribute values, formatted as &#x60;[\&quot;source_key1,target_value1\&quot;, \&quot;source_key2,target_value2\&quot;]&#x60; | [optional]
31-
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
8+
**LogsArithmeticProcessor** | [**LogsArithmeticProcessor**](LogsArithmeticProcessor.md) | Container class of the relevant properties. |
9+
**LogsAttributeRemapper** | [**LogsAttributeRemapper**](LogsAttributeRemapper.md) | Container class of the relevant properties. |
10+
**LogsCategoryProcessor** | [**LogsCategoryProcessor**](LogsCategoryProcessor.md) | Container class of the relevant properties. |
11+
**LogsDateRemapper** | [**LogsDateRemapper**](LogsDateRemapper.md) | Container class of the relevant properties. |
12+
**LogsGeoIPParser** | [**LogsGeoIPParser**](LogsGeoIPParser.md) | Container class of the relevant properties. |
13+
**LogsGrokParser** | [**LogsGrokParser**](LogsGrokParser.md) | Container class of the relevant properties. |
14+
**LogsLookupProcessor** | [**LogsLookupProcessor**](LogsLookupProcessor.md) | Container class of the relevant properties. |
15+
**LogsMessageRemapper** | [**LogsMessageRemapper**](LogsMessageRemapper.md) | Container class of the relevant properties. |
16+
**LogsPipelineProcessor** | [**LogsPipelineProcessor**](LogsPipelineProcessor.md) | Container class of the relevant properties. |
17+
**LogsServiceRemapper** | [**LogsServiceRemapper**](LogsServiceRemapper.md) | Container class of the relevant properties. |
18+
**LogsStatusRemapper** | [**LogsStatusRemapper**](LogsStatusRemapper.md) | Container class of the relevant properties. |
19+
**LogsStringBuilderProcessor** | [**LogsStringBuilderProcessor**](LogsStringBuilderProcessor.md) | Container class of the relevant properties. |
20+
**LogsTraceRemapper** | [**LogsTraceRemapper**](LogsTraceRemapper.md) | Container class of the relevant properties. |
21+
**LogsURLParser** | [**LogsURLParser**](LogsURLParser.md) | Container class of the relevant properties. |
22+
**LogsUserAgentParser** | [**LogsUserAgentParser**](LogsUserAgentParser.md) | Container class of the relevant properties. |
3223

3324
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
3425

‎docs/v1/NotebookCellCreateRequestAttributes.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@ The attributes of a notebook cell in create cell request. Valid cell types are `
55
## Properties
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) | | [optional]
9-
**split_by** | [**NotebookSplitBy**](NotebookSplitBy.md) | | [optional]
10-
**time** | [**NotebookCellTime**](NotebookCellTime.md) | | [optional]
11-
**definition** | [**LogStreamWidgetDefinition**](LogStreamWidgetDefinition.md) | | [optional]
12-
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
8+
**NotebookDistributionCellAttributes** | [**NotebookDistributionCellAttributes**](NotebookDistributionCellAttributes.md) | Container class of the relevant properties. |
9+
**NotebookHeatMapCellAttributes** | [**NotebookHeatMapCellAttributes**](NotebookHeatMapCellAttributes.md) | Container class of the relevant properties. |
10+
**NotebookLogStreamCellAttributes** | [**NotebookLogStreamCellAttributes**](NotebookLogStreamCellAttributes.md) | Container class of the relevant properties. |
11+
**NotebookMarkdownCellAttributes** | [**NotebookMarkdownCellAttributes**](NotebookMarkdownCellAttributes.md) | Container class of the relevant properties. |
12+
**NotebookTimeseriesCellAttributes** | [**NotebookTimeseriesCellAttributes**](NotebookTimeseriesCellAttributes.md) | Container class of the relevant properties. |
13+
**NotebookToplistCellAttributes** | [**NotebookToplistCellAttributes**](NotebookToplistCellAttributes.md) | Container class of the relevant properties. |
1314

1415
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
1516

‎docs/v1/NotebookCellResponseAttributes.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@ The attributes of a notebook cell response. Valid cell types are `markdown`, `ti
55
## Properties
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) | | [optional]
9-
**split_by** | [**NotebookSplitBy**](NotebookSplitBy.md) | | [optional]
10-
**time** | [**NotebookCellTime**](NotebookCellTime.md) | | [optional]
11-
**definition** | [**LogStreamWidgetDefinition**](LogStreamWidgetDefinition.md) | | [optional]
12-
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
8+
**NotebookDistributionCellAttributes** | [**NotebookDistributionCellAttributes**](NotebookDistributionCellAttributes.md) | Container class of the relevant properties. |
9+
**NotebookHeatMapCellAttributes** | [**NotebookHeatMapCellAttributes**](NotebookHeatMapCellAttributes.md) | Container class of the relevant properties. |
10+
**NotebookLogStreamCellAttributes** | [**NotebookLogStreamCellAttributes**](NotebookLogStreamCellAttributes.md) | Container class of the relevant properties. |
11+
**NotebookMarkdownCellAttributes** | [**NotebookMarkdownCellAttributes**](NotebookMarkdownCellAttributes.md) | Container class of the relevant properties. |
12+
**NotebookTimeseriesCellAttributes** | [**NotebookTimeseriesCellAttributes**](NotebookTimeseriesCellAttributes.md) | Container class of the relevant properties. |
13+
**NotebookToplistCellAttributes** | [**NotebookToplistCellAttributes**](NotebookToplistCellAttributes.md) | Container class of the relevant properties. |
1314

1415
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
1516

‎docs/v1/NotebookCellTime.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,8 @@ Timeframe for the notebook cell. When 'null', the notebook global time is used.
55
## Properties
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**live** | **bool** | Indicates whether the timeframe should be shifted to end at the current time. | [optional]
9-
**live_span** | [**WidgetLiveSpan**](WidgetLiveSpan.md) | | [optional]
10-
**end** | **datetime** | The end time. | [optional]
11-
**start** | **datetime** | The start time. | [optional]
12-
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
8+
**NotebookAbsoluteTime** | [**NotebookAbsoluteTime**](NotebookAbsoluteTime.md) | Container class of the relevant properties. |
9+
**NotebookRelativeTime** | [**NotebookRelativeTime**](NotebookRelativeTime.md) | Container class of the relevant properties. |
1310

1411
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
1512

‎docs/v1/NotebookCellUpdateRequestAttributes.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@ The attributes of a notebook cell in update cell request. Valid cell types are `
55
## Properties
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) | | [optional]
9-
**split_by** | [**NotebookSplitBy**](NotebookSplitBy.md) | | [optional]
10-
**time** | [**NotebookCellTime**](NotebookCellTime.md) | | [optional]
11-
**definition** | [**LogStreamWidgetDefinition**](LogStreamWidgetDefinition.md) | | [optional]
12-
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
8+
**NotebookDistributionCellAttributes** | [**NotebookDistributionCellAttributes**](NotebookDistributionCellAttributes.md) | Container class of the relevant properties. |
9+
**NotebookHeatMapCellAttributes** | [**NotebookHeatMapCellAttributes**](NotebookHeatMapCellAttributes.md) | Container class of the relevant properties. |
10+
**NotebookLogStreamCellAttributes** | [**NotebookLogStreamCellAttributes**](NotebookLogStreamCellAttributes.md) | Container class of the relevant properties. |
11+
**NotebookMarkdownCellAttributes** | [**NotebookMarkdownCellAttributes**](NotebookMarkdownCellAttributes.md) | Container class of the relevant properties. |
12+
**NotebookTimeseriesCellAttributes** | [**NotebookTimeseriesCellAttributes**](NotebookTimeseriesCellAttributes.md) | Container class of the relevant properties. |
13+
**NotebookToplistCellAttributes** | [**NotebookToplistCellAttributes**](NotebookToplistCellAttributes.md) | Container class of the relevant properties. |
1314

1415
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
1516

‎docs/v1/NotebookGlobalTime.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,8 @@ Notebook global timeframe.
55
## Properties
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**live** | **bool** | Indicates whether the timeframe should be shifted to end at the current time. | [optional]
9-
**live_span** | [**WidgetLiveSpan**](WidgetLiveSpan.md) | | [optional]
10-
**end** | **datetime** | The end time. | [optional]
11-
**start** | **datetime** | The start time. | [optional]
12-
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
8+
**NotebookAbsoluteTime** | [**NotebookAbsoluteTime**](NotebookAbsoluteTime.md) | Container class of the relevant properties. |
9+
**NotebookRelativeTime** | [**NotebookRelativeTime**](NotebookRelativeTime.md) | Container class of the relevant properties. |
1310

1411
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
1512

‎docs/v1/NotebookUpdateCell.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,8 @@ Updating a notebook can either insert new cell(s) or update existing cell(s) by
55
## Properties
66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**attributes** | [**NotebookCellUpdateRequestAttributes**](NotebookCellUpdateRequestAttributes.md) | | [optional]
9-
**type** | [**NotebookCellResourceType**](NotebookCellResourceType.md) | | [optional]
10-
**id** | **str** | Notebook cell ID. | [optional]
11-
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
8+
**NotebookCellCreateRequest** | [**NotebookCellCreateRequest**](NotebookCellCreateRequest.md) | Container class of the relevant properties. |
9+
**NotebookCellUpdateRequest** | [**NotebookCellUpdateRequest**](NotebookCellUpdateRequest.md) | Container class of the relevant properties. |
1210

1311
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)
1412

0 commit comments

Comments
 (0)