Skip to content

Commit

Permalink
[ECT-2482] Improve documentation to redirect common events usage to V…
Browse files Browse the repository at this point in the history
…1 endpoint (#26767)

Co-authored-by: ci.datadog-api-spec <[email protected]>
  • Loading branch information
api-clients-generation-pipeline[bot] and ci.datadog-api-spec authored Dec 16, 2024
1 parent c52f8c0 commit d43bdd6
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 19 deletions.
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2024-12-13 15:31:47.674190",
"spec_repo_commit": "e7a707af"
"regenerated": "2024-12-16 18:29:13.331043",
"spec_repo_commit": "a179b579"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-12-13 15:31:55.671458",
"spec_repo_commit": "e7a707af"
"regenerated": "2024-12-16 18:29:21.222347",
"spec_repo_commit": "a179b579"
}
}
}
2 changes: 1 addition & 1 deletion content/en/api/v1/synthetics/examples.json
Original file line number Diff line number Diff line change
Expand Up @@ -4550,7 +4550,7 @@
],
"to_ts": 0
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">from_ts&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>int64</p></div>\n <div class=\"col-6 column\"><p>Timestamp in seconds (Unix epoch) for the start of uptime.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">public_ids&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>An array of Synthetic test IDs you want to delete.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">to_ts&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>int64</p></div>\n <div class=\"col-6 column\"><p>Timestamp in seconds (Unix epoch) for the end of uptime.</p></div>\n </div>\n \n </div>\n </div></div>"
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">from_ts&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>int64</p></div>\n <div class=\"col-6 column\"><p>Timestamp in seconds (Unix epoch) for the start of uptime.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">public_ids&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>An array of Synthetic test IDs you want uptimes for.</p></div>\n </div>\n \n </div>\n </div><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">to_ts&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>int64</p></div>\n <div class=\"col-6 column\"><p>Timestamp in seconds (Unix epoch) for the end of uptime.</p></div>\n </div>\n \n </div>\n </div></div>"
}
},
"GetTest": {
Expand Down
2 changes: 1 addition & 1 deletion data/api/v1/full_spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15448,7 +15448,7 @@ components:
format: int64
type: integer
public_ids:
description: An array of Synthetic test IDs you want to delete.
description: An array of Synthetic test IDs you want uptimes for.
example: []
items:
description: A Synthetic test ID.
Expand Down
4 changes: 2 additions & 2 deletions data/api/v1/full_spec_deref.json
Original file line number Diff line number Diff line change
Expand Up @@ -508537,7 +508537,7 @@
"type": "integer"
},
"public_ids": {
"description": "An array of Synthetic test IDs you want to delete.",
"description": "An array of Synthetic test IDs you want uptimes for.",
"example": [],
"items": {
"description": "A Synthetic test ID.",
Expand Down Expand Up @@ -1108276,7 +1108276,7 @@
"type": "integer"
},
"public_ids": {
"description": "An array of Synthetic test IDs you want to delete.",
"description": "An array of Synthetic test IDs you want uptimes for.",
"example": [],
"items": {
"description": "A Synthetic test ID.",
Expand Down
10 changes: 4 additions & 6 deletions data/api/v2/full_spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32924,12 +32924,10 @@ paths:
x-undo:
type: safe
post:
description: 'This endpoint allows you to post events.


Only events with **`change` category** are under General Availability. Refer
to [Change Tracking](https://docs.datadoghq.com/change_tracking) for further
details.'
description: "This endpoint allows you to post events.\n\n\u2705 **Only events
with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking)
for more details.\n\n\u274C For use cases involving other event categories,
please use the V1 endpoint."
operationId: CreateEvent
requestBody:
content:
Expand Down
2 changes: 1 addition & 1 deletion data/api/v2/full_spec_deref.json
Original file line number Diff line number Diff line change
Expand Up @@ -230907,7 +230907,7 @@
}
},
"post": {
"description": "This endpoint allows you to post events.\n\nOnly events with **`change` category** are under General Availability. Refer to [Change Tracking](https://docs.datadoghq.com/change_tracking) for further details.",
"description": "This endpoint allows you to post events.\n\n✅ **Only events with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking) for more details.\n\n❌ For use cases involving other event categories, please use the V1 endpoint.",
"operationId": "CreateEvent",
"requestBody": {
"content": {
Expand Down
Loading

0 comments on commit d43bdd6

Please sign in to comment.