Skip to content

Commit e1ba22e

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add more information on snapshots (#2899)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 53d3ba6 commit e1ba22e

File tree

3 files changed

+14
-7
lines changed

3 files changed

+14
-7
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": "2025-06-06 17:43:33.552338",
8-
"spec_repo_commit": "01341d5b"
7+
"regenerated": "2025-06-09 14:45:35.688547",
8+
"spec_repo_commit": "79e7c933"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-06-06 17:43:33.567997",
13-
"spec_repo_commit": "01341d5b"
12+
"regenerated": "2025-06-09 14:45:35.704920",
13+
"spec_repo_commit": "79e7c933"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26423,7 +26423,10 @@ paths:
2642326423
- events_read
2642426424
/api/v1/graph/snapshot:
2642526425
get:
26426-
description: 'Take graph snapshots.
26426+
description: 'Take graph snapshots. Snapshots are PNG images generated by rendering
26427+
a specified widget in a web page and capturing it once the data is available.
26428+
The image is then uploaded to cloud storage.
26429+
2642726430

2642826431
**Note**: When a snapshot is created, there is some delay before it is available.'
2642926432
operationId: GetGraphSnapshot

src/main/java/com/datadog/api/client/v1/api/SnapshotsApi.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,8 +194,12 @@ public CompletableFuture<GraphSnapshot> getGraphSnapshotAsync(
194194
}
195195

196196
/**
197-
* Take graph snapshots. <strong>Note</strong>: When a snapshot is created, there is some delay
198-
* before it is available.
197+
* Take graph snapshots. Snapshots are PNG images generated by rendering a specified widget in a
198+
* web page and capturing it once the data is available. The image is then uploaded to cloud
199+
* storage.
200+
*
201+
* <p><strong>Note</strong>: When a snapshot is created, there is some delay before it is
202+
* available.
199203
*
200204
* @param start The POSIX timestamp of the start of the query in seconds. (required)
201205
* @param end The POSIX timestamp of the end of the query in seconds. (required)

0 commit comments

Comments
 (0)