Skip to content

Commit 9e071ea

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit a738745 of spec repo
1 parent 30908d7 commit 9e071ea

21 files changed

Lines changed: 1069 additions & 0 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 238 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24622,6 +24622,184 @@ components:
2462224622
- findings
2462324623
- project
2462424624
type: object
24625+
CreateSnapshotAdditionalConfig:
24626+
description: Additional configuration options for snapshot creation.
24627+
properties:
24628+
template_variables:
24629+
$ref: "#/components/schemas/CreateSnapshotTemplateVariables"
24630+
timeseries_legend_type:
24631+
$ref: "#/components/schemas/CreateSnapshotTimeseriesLegendType"
24632+
timezone_offset_minutes:
24633+
description: Timezone offset in minutes from UTC. Positive values are west of UTC (for example, `300` for UTC-5). Use `0` for UTC.
24634+
example: 300
24635+
format: int64
24636+
type: integer
24637+
type: object
24638+
CreateSnapshotDataAttributesRequest:
24639+
description: Attributes for snapshot creation.
24640+
properties:
24641+
additional_config:
24642+
$ref: "#/components/schemas/CreateSnapshotAdditionalConfig"
24643+
end:
24644+
description: End of the time window for the snapshot, in milliseconds since Unix epoch.
24645+
example: 1692464800000
24646+
format: int64
24647+
type: integer
24648+
height:
24649+
description: The height of the rendered snapshot in pixels.
24650+
example: 185
24651+
format: int64
24652+
type: integer
24653+
is_authenticated:
24654+
description: Whether the snapshot requires authentication to view. Authenticated snapshots are scoped to the creating organization.
24655+
example: false
24656+
type: boolean
24657+
start:
24658+
description: Start of the time window for the snapshot, in milliseconds since Unix epoch.
24659+
example: 1692464000000
24660+
format: int64
24661+
type: integer
24662+
ttl:
24663+
$ref: "#/components/schemas/CreateSnapshotTTL"
24664+
widget_definition:
24665+
additionalProperties: {}
24666+
description: The widget definition to render as a snapshot. Must include a valid `type` field and non-empty `requests` array.
24667+
example:
24668+
requests:
24669+
- q: "avg:system.cpu.user{*}"
24670+
type: timeseries
24671+
type: object
24672+
width:
24673+
description: The width of the rendered snapshot in pixels.
24674+
example: 300
24675+
format: int64
24676+
type: integer
24677+
required:
24678+
- widget_definition
24679+
- start
24680+
- end
24681+
type: object
24682+
CreateSnapshotDataAttributesResponse:
24683+
description: Attributes of the created snapshot.
24684+
properties:
24685+
url:
24686+
description: The URL to access the rendered snapshot image.
24687+
example: https://app.datadoghq.com/api/v2/snapshot/view/public/60d/00000000-0000-0000-0000-000000000000/1692464400000-12345678-1234-5678-9abc-def123456789.png
24688+
type: string
24689+
required:
24690+
- url
24691+
type: object
24692+
CreateSnapshotDataRequest:
24693+
description: Data envelope for snapshot creation.
24694+
properties:
24695+
attributes:
24696+
$ref: "#/components/schemas/CreateSnapshotDataAttributesRequest"
24697+
type:
24698+
$ref: "#/components/schemas/CreateSnapshotType"
24699+
required:
24700+
- type
24701+
- attributes
24702+
type: object
24703+
CreateSnapshotDataResponse:
24704+
description: Data envelope for the snapshot creation response.
24705+
properties:
24706+
attributes:
24707+
$ref: "#/components/schemas/CreateSnapshotDataAttributesResponse"
24708+
id:
24709+
description: The unique identifier of the created snapshot.
24710+
example: 12345678-1234-5678-9abc-def123456789
24711+
type: string
24712+
type:
24713+
$ref: "#/components/schemas/CreateSnapshotType"
24714+
required:
24715+
- id
24716+
- type
24717+
- attributes
24718+
type: object
24719+
CreateSnapshotRequest:
24720+
description: Request body for creating a graph snapshot.
24721+
properties:
24722+
data:
24723+
$ref: "#/components/schemas/CreateSnapshotDataRequest"
24724+
required:
24725+
- data
24726+
type: object
24727+
CreateSnapshotResponse:
24728+
description: Response body for a snapshot creation request.
24729+
properties:
24730+
data:
24731+
$ref: "#/components/schemas/CreateSnapshotDataResponse"
24732+
required:
24733+
- data
24734+
type: object
24735+
CreateSnapshotTTL:
24736+
description: The time-to-live for the snapshot. This value corresponds to storage lifecycle policies that automatically delete the snapshot after the specified period.
24737+
enum:
24738+
- 30d
24739+
- 60d
24740+
- 90d
24741+
- 1y
24742+
- 2y
24743+
- inf
24744+
example: 60d
24745+
type: string
24746+
x-enum-varnames:
24747+
- THIRTY_DAYS
24748+
- SIXTY_DAYS
24749+
- NINETY_DAYS
24750+
- ONE_YEAR
24751+
- TWO_YEARS
24752+
- INFINITE
24753+
CreateSnapshotTemplateVariable:
24754+
description: A template variable definition for snapshot rendering.
24755+
properties:
24756+
name:
24757+
description: The template variable name.
24758+
example: host
24759+
type: string
24760+
prefix:
24761+
description: The tag prefix associated with the template variable. For example, a prefix of `host` with a value of `web-server-1` scopes the snapshot to `host:web-server-1`.
24762+
example: host
24763+
type: string
24764+
values:
24765+
description: The list of scoped values for this template variable.
24766+
example:
24767+
- web-server-1
24768+
- web-server-2
24769+
items:
24770+
description: A single scoped value for the template variable.
24771+
type: string
24772+
type: array
24773+
required:
24774+
- name
24775+
- prefix
24776+
- values
24777+
type: object
24778+
CreateSnapshotTemplateVariables:
24779+
description: List of template variable definitions for snapshot rendering.
24780+
items:
24781+
$ref: "#/components/schemas/CreateSnapshotTemplateVariable"
24782+
type: array
24783+
CreateSnapshotTimeseriesLegendType:
24784+
description: The legend display type for timeseries widgets. A value of `none` hides the legend entirely; omitting the field lets the frontend choose automatically.
24785+
enum:
24786+
- compact
24787+
- expanded
24788+
- none
24789+
example: expanded
24790+
type: string
24791+
x-enum-varnames:
24792+
- COMPACT
24793+
- EXPANDED
24794+
- NONE
24795+
CreateSnapshotType:
24796+
description: The type identifier for snapshot creation resources.
24797+
enum:
24798+
- create_snapshot
24799+
example: create_snapshot
24800+
type: string
24801+
x-enum-varnames:
24802+
- CREATE_SNAPSHOT
2462524803
CreateStatusPageRequest:
2462624804
description: Request object for creating a status page.
2462724805
example:
@@ -182746,6 +182924,63 @@ paths:
182746182924
x-unstable: |-
182747182925
**Note**: This endpoint is in public beta and it's subject to change.
182748182926
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
182927+
/api/v2/snapshot:
182928+
post:
182929+
description: Create a snapshot of a graph widget. The snapshot is rendered asynchronously; the returned URL can be polled until the image is ready.
182930+
operationId: CreateSnapshot
182931+
requestBody:
182932+
content:
182933+
application/json:
182934+
schema:
182935+
$ref: "#/components/schemas/CreateSnapshotRequest"
182936+
required: true
182937+
responses:
182938+
"200":
182939+
content:
182940+
application/json:
182941+
examples:
182942+
default:
182943+
value:
182944+
data:
182945+
attributes:
182946+
url: https://app.datadoghq.com/api/v2/snapshot/view/public/60d/00000000-0000-0000-0000-000000000000/1692464400000-12345678-1234-5678-9abc-def123456789.png
182947+
id: 12345678-1234-5678-9abc-def123456789
182948+
type: create_snapshot
182949+
schema:
182950+
$ref: "#/components/schemas/CreateSnapshotResponse"
182951+
description: OK
182952+
"400":
182953+
content:
182954+
application/json:
182955+
schema:
182956+
$ref: "#/components/schemas/JSONAPIErrorResponse"
182957+
description: Bad Request
182958+
"401":
182959+
content:
182960+
application/json:
182961+
schema:
182962+
$ref: "#/components/schemas/JSONAPIErrorResponse"
182963+
description: Unauthorized
182964+
"403":
182965+
content:
182966+
application/json:
182967+
schema:
182968+
$ref: "#/components/schemas/JSONAPIErrorResponse"
182969+
description: Forbidden
182970+
"404":
182971+
content:
182972+
application/json:
182973+
schema:
182974+
$ref: "#/components/schemas/JSONAPIErrorResponse"
182975+
description: Not Found
182976+
"429":
182977+
$ref: "#/components/responses/TooManyRequestsResponse"
182978+
summary: Create a graph snapshot
182979+
tags:
182980+
- Reporting and Sharing
182981+
x-unstable: |-
182982+
**Note**: This endpoint is in preview and is subject to change.
182983+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
182749182984
/api/v2/sourcemaps:
182750182985
delete:
182751182986
description: |-
@@ -197019,6 +197254,9 @@ tags:
197019197254
dashboard on a recurring cadence and delivers it to a set of recipients over email, Slack,
197020197255
or Microsoft Teams.
197021197256
name: Report Schedules
197257+
- description: |-
197258+
The Reporting and Sharing endpoints allow you to create snapshots of graph widgets and other shareable resources.
197259+
name: Reporting and Sharing
197022197260
- description: |-
197023197261
A restriction policy defines the access control rules for a resource, mapping a set of relations
197024197262
(such as editor and viewer) to a set of allowed principals (such as roles, teams, or users).

docs/datadog_api_client.v2.api.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -648,6 +648,13 @@ datadog\_api\_client.v2.api.report\_schedules\_api module
648648
:members:
649649
:show-inheritance:
650650

651+
datadog\_api\_client.v2.api.reporting\_and\_sharing\_api module
652+
---------------------------------------------------------------
653+
654+
.. automodule:: datadog_api_client.v2.api.reporting_and_sharing_api
655+
:members:
656+
:show-inheritance:
657+
651658
datadog\_api\_client.v2.api.restriction\_policies\_api module
652659
-------------------------------------------------------------
653660

docs/datadog_api_client.v2.model.rst

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9482,6 +9482,83 @@ datadog\_api\_client.v2.model.create\_service\_now\_ticket\_request\_data\_relat
94829482
:members:
94839483
:show-inheritance:
94849484

9485+
datadog\_api\_client.v2.model.create\_snapshot\_additional\_config module
9486+
-------------------------------------------------------------------------
9487+
9488+
.. automodule:: datadog_api_client.v2.model.create_snapshot_additional_config
9489+
:members:
9490+
:show-inheritance:
9491+
9492+
datadog\_api\_client.v2.model.create\_snapshot\_data\_attributes\_request module
9493+
--------------------------------------------------------------------------------
9494+
9495+
.. automodule:: datadog_api_client.v2.model.create_snapshot_data_attributes_request
9496+
:members:
9497+
:show-inheritance:
9498+
9499+
datadog\_api\_client.v2.model.create\_snapshot\_data\_attributes\_response module
9500+
---------------------------------------------------------------------------------
9501+
9502+
.. automodule:: datadog_api_client.v2.model.create_snapshot_data_attributes_response
9503+
:members:
9504+
:show-inheritance:
9505+
9506+
datadog\_api\_client.v2.model.create\_snapshot\_data\_request module
9507+
--------------------------------------------------------------------
9508+
9509+
.. automodule:: datadog_api_client.v2.model.create_snapshot_data_request
9510+
:members:
9511+
:show-inheritance:
9512+
9513+
datadog\_api\_client.v2.model.create\_snapshot\_data\_response module
9514+
---------------------------------------------------------------------
9515+
9516+
.. automodule:: datadog_api_client.v2.model.create_snapshot_data_response
9517+
:members:
9518+
:show-inheritance:
9519+
9520+
datadog\_api\_client.v2.model.create\_snapshot\_request module
9521+
--------------------------------------------------------------
9522+
9523+
.. automodule:: datadog_api_client.v2.model.create_snapshot_request
9524+
:members:
9525+
:show-inheritance:
9526+
9527+
datadog\_api\_client.v2.model.create\_snapshot\_response module
9528+
---------------------------------------------------------------
9529+
9530+
.. automodule:: datadog_api_client.v2.model.create_snapshot_response
9531+
:members:
9532+
:show-inheritance:
9533+
9534+
datadog\_api\_client.v2.model.create\_snapshot\_template\_variable module
9535+
-------------------------------------------------------------------------
9536+
9537+
.. automodule:: datadog_api_client.v2.model.create_snapshot_template_variable
9538+
:members:
9539+
:show-inheritance:
9540+
9541+
datadog\_api\_client.v2.model.create\_snapshot\_timeseries\_legend\_type module
9542+
-------------------------------------------------------------------------------
9543+
9544+
.. automodule:: datadog_api_client.v2.model.create_snapshot_timeseries_legend_type
9545+
:members:
9546+
:show-inheritance:
9547+
9548+
datadog\_api\_client.v2.model.create\_snapshot\_ttl module
9549+
----------------------------------------------------------
9550+
9551+
.. automodule:: datadog_api_client.v2.model.create_snapshot_ttl
9552+
:members:
9553+
:show-inheritance:
9554+
9555+
datadog\_api\_client.v2.model.create\_snapshot\_type module
9556+
-----------------------------------------------------------
9557+
9558+
.. automodule:: datadog_api_client.v2.model.create_snapshot_type
9559+
:members:
9560+
:show-inheritance:
9561+
94859562
datadog\_api\_client.v2.model.create\_status\_page\_request module
94869563
------------------------------------------------------------------
94879564

0 commit comments

Comments
 (0)