Skip to content

[ECT-2482] Improve documentation to redirect common events usage to V1 endpoint #2621

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
api-clients-generation-pipeline merged 1 commit into from
Dec 16, 2024
Merged

[ECT-2482] Improve documentation to redirect common events usage to V1 endpoint #2621

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
View file
Open in desktop
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 16:09:25.530948",
"spec_repo_commit": "936a5463"
"regenerated": "2024-12-16 18:27:49.012621",
"spec_repo_commit": "a179b579"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-12-13 16:09:25.549581",
"spec_repo_commit": "936a5463"
"regenerated": "2024-12-16 18:27:49.028559",
"spec_repo_commit": "a179b579"
}
}
}
10 changes: 4 additions & 6 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31987,12 +31987,10 @@ paths:
permissions:
- events_read
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
8 changes: 5 additions & 3 deletions src/main/java/com/datadog/api/client/v2/api/EventsApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,11 @@ public CompletableFuture<EventCreateResponsePayload> createEventAsync(
/**
* This endpoint allows you to post events.
*
* <p>Only events with <strong><code>change</code> category</strong> are under General
* Availability. Refer to <a href="https://docs.datadoghq.com/change_tracking">Change Tracking</a>
* for further details.
* <p>✅ <strong>Only events with the <code>change</code> category</strong> are in General
* Availability. See <a href="https://docs.datadoghq.com/change_tracking">Change Tracking</a> for
* more details.
*
* <p>❌ For use cases involving other event categories, please use the V1 endpoint.
*
* @param body Event request object (required)
* @return ApiResponse&lt;EventCreateResponsePayload&gt;
Expand Down
2 changes: 1 addition & 1 deletion ...esources/cassettes/features/v1/Get_all_hosts_with_metadata_deserializes_successfully.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@
"timeToLive": {
"unlimited": true
},
"id": "d5bade64-6ebb-4f4d-903d-8069b52bb31e"
"id": "d5bade64-6ebb-4f4d-903d-8069b52bb31d"
}
]
2 changes: 1 addition & 1 deletion ...es/features/v1/Get_all_hosts_with_metadata_for_your_organization_returns_OK_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@
"timeToLive": {
"unlimited": true
},
"id": "d5bade64-6ebb-4f4d-903d-8069b52bb31d"
"id": "d5bade64-6ebb-4f4d-903d-8069b52bb31e"
}
]
2 changes: 1 addition & 1 deletion ...eatures/v2/AWS_Integration_Create_account_config_returns_AWS_Account_object_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"timeToLive": {
"unlimited": true
},
"id": "c206b9cd-771e-14f0-5d18-42a3a48556ce"
"id": "c206b9cd-771e-14f0-5d18-42a3a48556cf"
},
{
"httpRequest": {
Expand Down
2 changes: 1 addition & 1 deletion ...assettes/features/v2/AWS_Integration_Create_account_config_returns_Conflict_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"timeToLive": {
"unlimited": true
},
"id": "c206b9cd-771e-14f0-5d18-42a3a48556d1"
"id": "c206b9cd-771e-14f0-5d18-42a3a48556d0"
},
{
"httpRequest": {
Expand Down
2 changes: 1 addition & 1 deletion ...ettes/features/v2/AWS_Integration_Delete_account_config_returns_Bad_Request_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@
"timeToLive": {
"unlimited": true
},
"id": "73fd406e-d686-10bd-50ee-83f2c499e8a9"
"id": "73fd406e-d686-10bd-50ee-83f2c499e8a8"
}
]
2 changes: 1 addition & 1 deletion ...settes/features/v2/AWS_Integration_Delete_account_config_returns_No_Content_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"timeToLive": {
"unlimited": true
},
"id": "194b15fb-fcae-9b9a-e1a7-0daa19dc9eeb"
"id": "194b15fb-fcae-9b9a-e1a7-0daa19dc9eee"
},
{
"httpRequest": {
Expand Down
4 changes: 2 additions & 2 deletions ...ssettes/features/v2/AWS_Integration_Delete_account_config_returns_Not_Found_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"timeToLive": {
"unlimited": true
},
"id": "194b15fb-fcae-9b9a-e1a7-0daa19dc9eea"
"id": "194b15fb-fcae-9b9a-e1a7-0daa19dc9eeb"
},
{
"httpRequest": {
Expand All @@ -53,7 +53,7 @@
"timeToLive": {
"unlimited": true
},
"id": "ab2123e3-6fb5-0f90-fe98-365e086c9c6f"
"id": "ab2123e3-6fb5-0f90-fe98-365e086c9c6e"
},
{
"httpRequest": {
Expand Down
2 changes: 1 addition & 1 deletion ...v2/AWS_Integration_Get_all_account_configs_returns_AWS_Accounts_List_object_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@
"timeToLive": {
"unlimited": true
},
"id": "101a55f5-5a26-d616-5fb4-8d0451d83d11"
"id": "101a55f5-5a26-d616-5fb4-8d0451d83d10"
}
]
2 changes: 1 addition & 1 deletion ...tures/v2/AWS_Integration_List_namespaces_returns_AWS_Namespaces_List_object_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@
"timeToLive": {
"unlimited": true
},
"id": "d0ec7736-ef6c-d071-3390-4a5c3a301d10"
"id": "d0ec7736-ef6c-d071-3390-4a5c3a301d0e"
}
]
2 changes: 1 addition & 1 deletion ...features/v2/AWS_Integration_Patch_account_config_returns_AWS_Account_object_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"timeToLive": {
"unlimited": true
},
"id": "194b15fb-fcae-9b9a-e1a7-0daa19dc9eee"
"id": "194b15fb-fcae-9b9a-e1a7-0daa19dc9eea"
},
{
"httpRequest": {
Expand Down
2 changes: 1 addition & 1 deletion ...assettes/features/v2/AWS_Integration_Patch_account_config_returns_Not_Found_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@
"timeToLive": {
"unlimited": true
},
"id": "6796bfb2-5496-6f6a-d702-4bc629b25991"
"id": "6796bfb2-5496-6f6a-d702-4bc629b25992"
}
]
2 changes: 1 addition & 1 deletion src/test/resources/cassettes/features/v2/Archive_case_returns_Bad_Request_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"timeToLive": {
"unlimited": true
},
"id": "0a6534d0-42f2-5075-64f8-7ab28f449a97"
"id": "0a6534d0-42f2-5075-64f8-7ab28f449a94"
},
{
"httpRequest": {
Expand Down
2 changes: 1 addition & 1 deletion src/test/resources/cassettes/features/v2/Archive_case_returns_OK_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"timeToLive": {
"unlimited": true
},
"id": "0a6534d0-42f2-5075-64f8-7ab28f449a99"
"id": "0a6534d0-42f2-5075-64f8-7ab28f449a91"
},
{
"httpRequest": {
Expand Down
2 changes: 1 addition & 1 deletion src/test/resources/cassettes/features/v2/Assign_case_returns_Bad_Request_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"timeToLive": {
"unlimited": true
},
"id": "0a6534d0-42f2-5075-64f8-7ab28f449a94"
"id": "0a6534d0-42f2-5075-64f8-7ab28f449a98"
},
{
"httpRequest": {
Expand Down
2 changes: 1 addition & 1 deletion src/test/resources/cassettes/features/v2/Assign_case_returns_OK_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"timeToLive": {
"unlimited": true
},
"id": "0a6534d0-42f2-5075-64f8-7ab28f449a8e"
"id": "0a6534d0-42f2-5075-64f8-7ab28f449a92"
},
{
"httpRequest": {
Expand Down
2 changes: 1 addition & 1 deletion src/test/resources/cassettes/features/v2/Cancel_a_historical_job_returns_OK_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"timeToLive": {
"unlimited": true
},
"id": "6bb82102-e994-f0d1-ee96-e1e3f1d81000"
"id": "6bb82102-e994-f0d1-ee96-e1e3f1d80ffe"
},
{
"httpRequest": {
Expand Down
2 changes: 1 addition & 1 deletion .../resources/cassettes/features/v2/Cancels_a_data_deletion_request_returns_OK_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"timeToLive": {
"unlimited": true
},
"id": "599b5d26-fcc8-db18-1a6e-dfc958964914"
"id": "599b5d26-fcc8-db18-1a6e-dfc958964915"
},
{
"httpRequest": {
Expand Down
2 changes: 1 addition & 1 deletion src/test/resources/cassettes/features/v2/Create_Scanning_Group_returns_OK_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"timeToLive": {
"unlimited": true
},
"id": "01611a93-5e74-0630-3c51-f707c3b51e82"
"id": "01611a93-5e74-0630-3c51-f707c3b51e7c"
},
{
"httpRequest": {
Expand Down
4 changes: 2 additions & 2 deletions ...st/resources/cassettes/features/v2/Create_Scanning_Rule_returns_Bad_Request_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"timeToLive": {
"unlimited": true
},
"id": "01611a93-5e74-0630-3c51-f707c3b51e7b"
"id": "01611a93-5e74-0630-3c51-f707c3b51e7f"
},
{
"httpRequest": {
Expand Down Expand Up @@ -53,7 +53,7 @@
"timeToLive": {
"unlimited": true
},
"id": "33fa4a39-57ef-afdd-007a-0db82f7ed15b"
"id": "33fa4a39-57ef-afdd-007a-0db82f7ed15d"
},
{
"httpRequest": {
Expand Down
4 changes: 2 additions & 2 deletions src/test/resources/cassettes/features/v2/Create_Scanning_Rule_returns_OK_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"timeToLive": {
"unlimited": true
},
"id": "01611a93-5e74-0630-3c51-f707c3b51e7e"
"id": "01611a93-5e74-0630-3c51-f707c3b51e82"
},
{
"httpRequest": {
Expand Down Expand Up @@ -53,7 +53,7 @@
"timeToLive": {
"unlimited": true
},
"id": "33fa4a39-57ef-afdd-007a-0db82f7ed15d"
"id": "33fa4a39-57ef-afdd-007a-0db82f7ed160"
},
{
"httpRequest": {
Expand Down
2 changes: 1 addition & 1 deletion ...rces/cassettes/features/v2/Create_an_AWS_account_returns_AWS_Account_object_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"timeToLive": {
"unlimited": true
},
"id": "c206b9cd-771e-14f0-5d18-42a3a48556cf"
"id": "c206b9cd-771e-14f0-5d18-42a3a48556ce"
},
{
"httpRequest": {
Expand Down
4 changes: 2 additions & 2 deletions .../resources/cassettes/features/v2/Create_an_AWS_integration_returns_Conflict_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"timeToLive": {
"unlimited": true
},
"id": "cd59362c-7df2-d349-9880-5b5536151a0b"
"id": "cd59362c-7df2-d349-9880-5b5536151a0a"
},
{
"httpRequest": {
Expand Down Expand Up @@ -57,7 +57,7 @@
"timeToLive": {
"unlimited": true
},
"id": "c206b9cd-771e-14f0-5d18-42a3a48556d0"
"id": "c206b9cd-771e-14f0-5d18-42a3a48556d1"
},
{
"httpRequest": {
Expand Down
2 changes: 1 addition & 1 deletion ...st/resources/cassettes/features/v2/Create_role_with_a_permission_returns_OK_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"timeToLive": {
"unlimited": true
},
"id": "ab2c08c1-60c7-9278-3246-d650bb89216f"
"id": "ab2c08c1-60c7-9278-3246-d650bb89216e"
},
{
"httpRequest": {
Expand Down
2 changes: 1 addition & 1 deletion .../resources/cassettes/features/v2/Creates_a_data_deletion_request_returns_OK_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"timeToLive": {
"unlimited": true
},
"id": "599b5d26-fcc8-db18-1a6e-dfc958964916"
"id": "599b5d26-fcc8-db18-1a6e-dfc958964914"
},
{
"httpRequest": {
Expand Down
4 changes: 2 additions & 2 deletions src/test/resources/cassettes/features/v2/Delete_Scanning_Group_returns_OK_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"timeToLive": {
"unlimited": true
},
"id": "01611a93-5e74-0630-3c51-f707c3b51e80"
"id": "01611a93-5e74-0630-3c51-f707c3b51e7a"
},
{
"httpRequest": {
Expand Down Expand Up @@ -53,7 +53,7 @@
"timeToLive": {
"unlimited": true
},
"id": "33fa4a39-57ef-afdd-007a-0db82f7ed15f"
"id": "33fa4a39-57ef-afdd-007a-0db82f7ed15a"
},
{
"httpRequest": {
Expand Down
4 changes: 2 additions & 2 deletions src/test/resources/cassettes/features/v2/Delete_Scanning_Rule_returns_OK_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"timeToLive": {
"unlimited": true
},
"id": "01611a93-5e74-0630-3c51-f707c3b51e78"
"id": "01611a93-5e74-0630-3c51-f707c3b51e83"
},
{
"httpRequest": {
Expand Down Expand Up @@ -53,7 +53,7 @@
"timeToLive": {
"unlimited": true
},
"id": "33fa4a39-57ef-afdd-007a-0db82f7ed158"
"id": "33fa4a39-57ef-afdd-007a-0db82f7ed161"
},
{
"httpRequest": {
Expand Down
2 changes: 1 addition & 1 deletion src/test/resources/cassettes/features/v2/Delete_a_retention_filter_returns_OK_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"timeToLive": {
"unlimited": true
},
"id": "b2404278-8cc9-cba4-e3eb-03a7fdff0699"
"id": "b2404278-8cc9-cba4-e3eb-03a7fdff0697"
},
{
"httpRequest": {
Expand Down
2 changes: 1 addition & 1 deletion ...sources/cassettes/features/v2/Delete_an_AWS_integration_returns_Bad_Request_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@
"timeToLive": {
"unlimited": true
},
"id": "73fd406e-d686-10bd-50ee-83f2c499e8a8"
"id": "73fd406e-d686-10bd-50ee-83f2c499e8a9"
}
]
4 changes: 2 additions & 2 deletions ...resources/cassettes/features/v2/Delete_an_AWS_integration_returns_Not_Found_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"timeToLive": {
"unlimited": true
},
"id": "cd59362c-7df2-d349-9880-5b5536151a09"
"id": "cd59362c-7df2-d349-9880-5b5536151a08"
},
{
"httpRequest": {
Expand All @@ -53,7 +53,7 @@
"timeToLive": {
"unlimited": true
},
"id": "ab2123e3-6fb5-0f90-fe98-365e086c9c6e"
"id": "ab2123e3-6fb5-0f90-fe98-365e086c9c6f"
},
{
"httpRequest": {
Expand Down
2 changes: 1 addition & 1 deletion src/test/resources/cassettes/features/v2/Delete_an_incident_type_returns_OK_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"timeToLive": {
"unlimited": true
},
"id": "7bcfec66-5300-9891-51e5-e4d7e0833bd1"
"id": "7bcfec66-5300-9891-51e5-e4d7e0833bd3"
},
{
"httpRequest": {
Expand Down
2 changes: 1 addition & 1 deletion ...resources/cassettes/features/v2/Get_a_given_APM_retention_filter_returns_OK_response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"timeToLive": {
"unlimited": true
},
"id": "b2404278-8cc9-cba4-e3eb-03a7fdff069b"
"id": "b2404278-8cc9-cba4-e3eb-03a7fdff0698"
},
{
"httpRequest": {
Expand Down
Loading
Loading