Skip to content

Commit a96e322

Browse files
dd-octo-sts[bot]ci.datadog-api-spec
andauthored
Regenerate client from commit 1ee8c19 of spec repo (#4127)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 2b6f9d1 commit a96e322

6 files changed

Lines changed: 357 additions & 21 deletions

File tree

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 161 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -65561,6 +65561,12 @@ components:
6556165561
example: "2024-01-01T00:00:00Z"
6556265562
format: date-time
6556365563
type: string
65564+
debug_id:
65565+
description: |-
65566+
The debug identifier (UUID format) that uniquely identifies this
65567+
JavaScript source map. Returned for source maps indexed by debug ID.
65568+
example: 00000000-0000-4000-8000-000000000001
65569+
type: string
6556465570
domain:
6556565571
description: The domain associated with the source map.
6556665572
example: example.com
@@ -120829,6 +120835,14 @@ components:
120829120835
- ELF
120830120836
- NDK
120831120837
- IL2CPP
120838+
SourcemapSearchBy:
120839+
description: The search mode for listing JavaScript source maps.
120840+
enum:
120841+
- debug_id
120842+
example: debug_id
120843+
type: string
120844+
x-enum-varnames:
120845+
- DEBUG_ID
120832120846
SourcemapsData:
120833120847
description: List of source map data objects.
120834120848
items:
@@ -120849,8 +120863,17 @@ components:
120849120863
description: Whether there are more results available beyond the current page.
120850120864
example: false
120851120865
type: boolean
120866+
next_cursor:
120867+
description: |-
120868+
Cursor for the next page of a JavaScript cursor-based listing. Pass
120869+
this value as `page[after]` with the same search mode and filters.
120870+
Only returned when another page is available.
120871+
type: string
120852120872
total_filtered_count:
120853-
description: Total number of source maps matching the filter criteria.
120873+
description: |-
120874+
Total number of matching source maps for legacy page-number pagination.
120875+
Cursor-based listings do not compute a total; this field may be zero
120876+
even when records are returned. Use `has_more_results` to continue.
120854120877
example: 100
120855120878
format: int64
120856120879
type: integer
@@ -231547,33 +231570,140 @@ paths:
231547231570
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
231548231571
/api/v2/sourcemaps/list:
231549231572
get:
231550-
description: Retrieves a paginated list of source maps matching the specified filter criteria.
231573+
description: |-
231574+
Retrieves a paginated list of source maps. Send filters as query parameters,
231575+
not in a JSON request body. `mapkind` defaults to `js`.
231576+
231577+
For JavaScript source maps, choose one of the three request shapes below.
231578+
231579+
**Examples:** the following commands use the US1 API host. Replace the host with
231580+
the API host for your site, and the service, version, debug ID, and cursor with
231581+
values from your organization. Use `--get` so curl sends the filters in the query
231582+
string; `-X GET` with `--data-urlencode` sends them in the request body instead.
231583+
231584+
**1. List by service and version**
231585+
231586+
Provide both `filter[service]` and `filter[version]` to search source maps
231587+
indexed by service and version. Omit `search_by`.
231588+
231589+
**Pagination:** prefer cursor pagination. Omit `page[after]` and `page[number]`
231590+
on the first request. To get the next page, pass `meta.page.next_cursor` as
231591+
`page[after]`, keeping the same filters. Continue until
231592+
`meta.page.has_more_results` is `false`. Do not decode or modify the cursor.
231593+
Legacy page-number pagination is also supported, starting at `page[number]=1`.
231594+
231595+
```bash
231596+
curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps/list" \
231597+
-H "Accept: application/json" \
231598+
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
231599+
--data-urlencode "mapkind=js" \
231600+
--data-urlencode "filter[service]=my-web-service" \
231601+
--data-urlencode "filter[version]=1.0.0" \
231602+
--data-urlencode "page[size]=10"
231603+
```
231604+
231605+
**2. Find a specific JavaScript debug ID**
231606+
231607+
Provide `filter[debug_id]` with a UUID. Service and version filters are not
231608+
required. Omit `search_by`.
231609+
231610+
**Pagination:** the lookup returns at most one result, so no pagination is
231611+
needed. `page[after]` is not supported.
231612+
231613+
```bash
231614+
curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps/list" \
231615+
-H "Accept: application/json" \
231616+
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
231617+
--data-urlencode "mapkind=js" \
231618+
--data-urlencode "filter[debug_id]=00000000-0000-4000-8000-000000000001"
231619+
```
231620+
231621+
**3. Browse source maps indexed by debug ID**
231622+
231623+
Set `search_by=debug_id` without specifying a debug ID. Do not send service,
231624+
version, or filename filters in this mode.
231625+
231626+
**Pagination:** this mode requires cursor pagination; `page[number]` is not
231627+
supported. Omit `page[after]` on the first request. To get the next page, pass
231628+
`meta.page.next_cursor` as `page[after]`, keeping the same search mode and
231629+
filters. Continue until `meta.page.has_more_results` is `false`. Do not decode
231630+
or modify the cursor.
231631+
231632+
First page:
231633+
231634+
```bash
231635+
curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps/list" \
231636+
-H "Accept: application/json" \
231637+
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
231638+
--data-urlencode "mapkind=js" \
231639+
--data-urlencode "search_by=debug_id" \
231640+
--data-urlencode "page[size]=10"
231641+
```
231642+
231643+
Next page:
231644+
231645+
```bash
231646+
curl -sS --get "https://api.datadoghq.com/api/v2/sourcemaps/list" \
231647+
-H "Accept: application/json" \
231648+
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
231649+
--data-urlencode "mapkind=js" \
231650+
--data-urlencode "search_by=debug_id" \
231651+
--data-urlencode "page[size]=10" \
231652+
--data-urlencode "page[after]=<meta.page.next_cursor>"
231653+
```
231654+
231655+
For other map kinds, use `page[number]`, starting at 1.
231551231656
operationId: ListSourcemaps
231552231657
parameters:
231658+
- description: |-
231659+
Set to `debug_id` to browse JavaScript source maps indexed by debug ID.
231660+
Only supported for `mapkind=js`. Omit for service/version searches or a
231661+
specific `filter[debug_id]` lookup. In debug-ID browse mode, service,
231662+
version, and filename filters are not supported.
231663+
example: debug_id
231664+
in: query
231665+
name: search_by
231666+
schema:
231667+
$ref: "#/components/schemas/SourcemapSearchBy"
231668+
x-docs-curl-required: true
231553231669
- description: The type of source map. Defaults to `js`.
231554231670
in: query
231555231671
name: mapkind
231556231672
schema:
231557231673
$ref: "#/components/schemas/SourcemapMapKind"
231558-
- description: The number of results to return per page. Must be at least 1.
231674+
- description: |-
231675+
Cursor for the next page of a JavaScript listing. Use the value from
231676+
`meta.page.next_cursor` and keep the same search mode and filters.
231677+
Omit on the first request. Not supported for other map kinds or for
231678+
a specific `filter[debug_id]` lookup without `search_by=debug_id`.
231679+
in: query
231680+
name: page[after]
231681+
schema:
231682+
type: string
231683+
- description: The number of results per page. Defaults to 100. Must be at least 1; values above 1000 are capped at 1000.
231559231684
in: query
231560231685
name: page[size]
231561231686
schema:
231562-
default: 20
231563-
example: 20
231687+
default: 100
231688+
example: 10
231564231689
format: int64
231690+
minimum: 1
231565231691
type: integer
231566-
- description: The page number to retrieve, starting from 1.
231692+
- description: |-
231693+
Legacy page number, starting from 1. Prefer `page[after]` for JavaScript
231694+
listings. Not supported with `search_by=debug_id`. Other map kinds
231695+
default to page 1 when pagination parameters are omitted.
231567231696
in: query
231568231697
name: page[number]
231569231698
schema:
231570-
default: 1
231571231699
example: 1
231572231700
format: int64
231701+
minimum: 1
231573231702
type: integer
231574231703
- description: |-
231575231704
Filter by service names (multiple values allowed). Required for
231576-
`js`, `jvm`, `react`, and `flutter` map kinds.
231705+
`jvm`, `react`, and `flutter` map kinds. Also required for `js` unless
231706+
searching by `filter[debug_id]` or browsing with `search_by=debug_id`.
231577231707
explode: true
231578231708
in: query
231579231709
name: filter[service]
@@ -231586,7 +231716,8 @@ paths:
231586231716
style: form
231587231717
- description: |-
231588231718
Filter by version values (multiple values allowed). Required for
231589-
`js`, `jvm`, `react`, and `flutter` map kinds.
231719+
`jvm`, `react`, and `flutter` map kinds. Also required for `js` unless
231720+
searching by `filter[debug_id]` or browsing with `search_by=debug_id`.
231590231721
explode: true
231591231722
in: query
231592231723
name: filter[version]
@@ -231703,10 +231834,14 @@ paths:
231703231834
name: filter[filename]
231704231835
schema:
231705231836
type: string
231706-
- description: Filter by debug ID (single value). Supported for `react`.
231837+
- description: |-
231838+
Filter by a single debug ID in UUID format. Supported for `js` and `react`.
231839+
For `js`, the lookup returns at most one result and does not require
231840+
service/version filters. For `react`, service/version filters remain required.
231707231841
in: query
231708231842
name: filter[debug_id]
231709231843
schema:
231844+
format: uuid
231710231845
type: string
231711231846
- description: Filter by GNU build ID (single value). Supported for `elf`.
231712231847
in: query
@@ -231728,6 +231863,22 @@ paths:
231728231863
content:
231729231864
application/json:
231730231865
examples:
231866+
debug_id_listing:
231867+
summary: Browse JavaScript source maps by debug ID
231868+
value:
231869+
data:
231870+
- attributes:
231871+
created_at: "2024-01-01T00:00:00Z"
231872+
debug_id: 00000000-0000-4000-8000-000000000001
231873+
mapkind: js
231874+
size: 1024
231875+
id: "7"
231876+
type: sourcemaps
231877+
meta:
231878+
page:
231879+
has_more_results: true
231880+
next_cursor: opaque-debug-id-cursor
231881+
total_filtered_count: 0
231731231882
default:
231732231883
value:
231733231884
data:

0 commit comments

Comments
 (0)