Skip to content

Commit 5053f69

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
[ECT-2482] Improve documentation to redirect common events usage to V1 endpoint (#431)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 7c7141d commit 5053f69

File tree

3 files changed

+14
-12
lines changed

3 files changed

+14
-12
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:25.555961",
8-
"spec_repo_commit": "936a5463"
7+
"regenerated": "2024-12-16 18:27:46.210937",
8+
"spec_repo_commit": "a179b579"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-12-13 16:09:25.575458",
13-
"spec_repo_commit": "936a5463"
12+
"regenerated": "2024-12-16 18:27:46.225187",
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:

src/datadogV2/api/api_events.rs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,9 @@ impl EventsAPI {
170170

171171
/// This endpoint allows you to post events.
172172
///
173-
/// Only events with **`change` category** are under General Availability. Refer to [Change Tracking](<https://docs.datadoghq.com/change_tracking>) for further details.
173+
/// ✅ **Only events with the `change` category** are in General Availability. See [Change Tracking](<https://docs.datadoghq.com/change_tracking>) for more details.
174+
///
175+
/// ❌ For use cases involving other event categories, please use the V1 endpoint.
174176
pub async fn create_event(
175177
&self,
176178
body: crate::datadogV2::model::EventCreateRequestPayload,
@@ -192,7 +194,9 @@ impl EventsAPI {
192194

193195
/// This endpoint allows you to post events.
194196
///
195-
/// Only events with **`change` category** are under General Availability. Refer to [Change Tracking](<https://docs.datadoghq.com/change_tracking>) for further details.
197+
/// ✅ **Only events with the `change` category** are in General Availability. See [Change Tracking](<https://docs.datadoghq.com/change_tracking>) for more details.
198+
///
199+
/// ❌ For use cases involving other event categories, please use the V1 endpoint.
196200
pub async fn create_event_with_http_info(
197201
&self,
198202
body: crate::datadogV2::model::EventCreateRequestPayload,

0 commit comments

Comments
 (0)