Skip to content

Commit ae9393e

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add more information on snapshots (#2607)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 01974c4 commit ae9393e

File tree

3 files changed

+10
-6
lines changed

3 files changed

+10
-6
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:35.755139",
8-
"spec_repo_commit": "01341d5b"
7+
"regenerated": "2025-06-09 14:45:37.430557",
8+
"spec_repo_commit": "79e7c933"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-06-06 17:43:35.770681",
13-
"spec_repo_commit": "01341d5b"
12+
"regenerated": "2025-06-09 14:45:37.519358",
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/datadog_api_client/v1/api/snapshots_api.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,8 @@ def get_graph_snapshot(
9797
) -> GraphSnapshot:
9898
"""Take graph snapshots.
9999
100-
Take graph snapshots.
100+
Take graph snapshots. Snapshots are PNG images generated by rendering a specified widget in a web page and capturing it once the data is available. The image is then uploaded to cloud storage.
101+
101102
**Note** : When a snapshot is created, there is some delay before it is available.
102103
103104
:param start: The POSIX timestamp of the start of the query in seconds.

0 commit comments

Comments
 (0)