Skip to content

Commit 893d232

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Document behavior of absent Splunk sourcetype in Custom Destinations (#3960)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 53dcb13 commit 893d232

File tree

3 files changed

+16
-12
lines changed

3 files changed

+16
-12
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18679,9 +18679,10 @@ components:
1867918679
description: |-
1868018680
The Splunk sourcetype for the events sent to this Splunk destination.
1868118681

18682-
If absent, the default sourcetype `_json` is used. If set to null, the `sourcetype`
18683-
field is omitted from the Splunk HEC payload entirely. Otherwise, the provided string
18684-
value is used as the sourcetype.
18682+
If the field is absent from the request and no sourcetype has been previously set on this destination, the default sourcetype `_json` is used.
18683+
On update, if the field is absent from the request but a sourcetype was previously set, the previous value is kept.
18684+
If set to `null`, the sourcetype field is omitted from the forwarded event entirely.
18685+
Otherwise, the provided string value is used as the sourcetype.
1868518686
example: my-source
1868618687
nullable: true
1868718688
type: string
@@ -18964,9 +18965,10 @@ components:
1896418965
description: |-
1896518966
The Splunk sourcetype for the events sent to this Splunk destination.
1896618967

18967-
If absent, the default sourcetype `_json` is used. If set to null, the `sourcetype`
18968-
field is omitted from the Splunk HEC payload entirely. Otherwise, the provided string
18969-
value is used as the sourcetype.
18968+
If the field is absent from the request and no sourcetype has been previously set on this destination, the default sourcetype `_json` is used.
18969+
On update, if the field is absent from the request but a sourcetype was previously set, the previous value is kept.
18970+
If set to `null`, the sourcetype field is omitted from the forwarded event entirely.
18971+
Otherwise, the provided string value is used as the sourcetype.
1897018972
example: my-source
1897118973
nullable: true
1897218974
type: string

packages/datadog-api-client-v2/models/CustomDestinationForwardDestinationSplunk.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,10 @@ export class CustomDestinationForwardDestinationSplunk {
2323
/**
2424
* The Splunk sourcetype for the events sent to this Splunk destination.
2525
*
26-
* If absent, the default sourcetype `_json` is used. If set to null, the `sourcetype`
27-
* field is omitted from the Splunk HEC payload entirely. Otherwise, the provided string
28-
* value is used as the sourcetype.
26+
* If the field is absent from the request and no sourcetype has been previously set on this destination, the default sourcetype `_json` is used.
27+
* On update, if the field is absent from the request but a sourcetype was previously set, the previous value is kept.
28+
* If set to `null`, the sourcetype field is omitted from the forwarded event entirely.
29+
* Otherwise, the provided string value is used as the sourcetype.
2930
*/
3031
"sourcetype"?: string;
3132
/**

packages/datadog-api-client-v2/models/CustomDestinationResponseForwardDestinationSplunk.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,10 @@ export class CustomDestinationResponseForwardDestinationSplunk {
1919
/**
2020
* The Splunk sourcetype for the events sent to this Splunk destination.
2121
*
22-
* If absent, the default sourcetype `_json` is used. If set to null, the `sourcetype`
23-
* field is omitted from the Splunk HEC payload entirely. Otherwise, the provided string
24-
* value is used as the sourcetype.
22+
* If the field is absent from the request and no sourcetype has been previously set on this destination, the default sourcetype `_json` is used.
23+
* On update, if the field is absent from the request but a sourcetype was previously set, the previous value is kept.
24+
* If set to `null`, the sourcetype field is omitted from the forwarded event entirely.
25+
* Otherwise, the provided string value is used as the sourcetype.
2526
*/
2627
"sourcetype"?: string;
2728
/**

0 commit comments

Comments
 (0)