Skip to content

Commit 6d34db7

Browse files
api-clients-generation-pipeline[bot]amaskara-ddci.datadog-api-spec
authored
[ECT-2482] Improve documentation to redirect common events usage to V1 endpoint (#2156)
* older ubuntu precommit * Revert "older ubuntu precommit" This reverts commit 2a7e0c1. * Regenerate client from commit a179b579 of spec repo --------- Co-authored-by: Anika Maskara <[email protected]> Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 02c03ee commit 6d34db7

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
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.6.6",
7-
"regenerated": "2024-12-13 16:09:30.230478",
8-
"spec_repo_commit": "936a5463"
7+
"regenerated": "2024-12-16 18:28:02.794845",
8+
"spec_repo_commit": "a179b579"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-12-13 16:09:30.249799",
13-
"spec_repo_commit": "936a5463"
12+
"regenerated": "2024-12-16 18:28:02.809467",
13+
"spec_repo_commit": "a179b579"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31987,12 +31987,10 @@ paths:
3198731987
permissions:
3198831988
- events_read
3198931989
post:
31990-
description: 'This endpoint allows you to post events.
31991-
31992-
31993-
Only events with **`change` category** are under General Availability. Refer
31994-
to [Change Tracking](https://docs.datadoghq.com/change_tracking) for further
31995-
details.'
31990+
description: "This endpoint allows you to post events.\n\n\u2705 **Only events
31991+
with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking)
31992+
for more details.\n\n\u274C For use cases involving other event categories,
31993+
please use the V1 endpoint."
3199631994
operationId: CreateEvent
3199731995
requestBody:
3199831996
content:

lib/datadog_api_client/v2/api/events_api.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,9 @@ def create_event(body, opts = {})
3535
#
3636
# This endpoint allows you to post events.
3737
#
38-
# Only events with **`change` category** are under General Availability. Refer to [Change Tracking](https://docs.datadoghq.com/change_tracking) for further details.
38+
# ✅ **Only events with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking) for more details.
39+
#
40+
# ❌ For use cases involving other event categories, please use the V1 endpoint.
3941
#
4042
# @param body [EventCreateRequestPayload] Event request object
4143
# @param opts [Hash] the optional parameters

0 commit comments

Comments
 (0)