Document sourcemaps symbol_type and debug_id lookup

.generator/schemas/v2/openapi.yaml

@@ -122537,17 +122537,19 @@ components:
     ServiceRepositoryInfoRequestAttributes:
       description: Attributes for the service repository info request.
       properties:
+        debug_id:
+          description: The debug ID of a JavaScript source map, in UUID format. Alternative to `service` and `version`.
+          example: 00000000-0000-4000-8000-000000000001
+          format: uuid
+          type: string
         service:
-          description: The name of the service.
+          description: The name of the service. Required with `version` when `debug_id` is not set.
           example: my-web-service
           type: string
         version:
-          description: The version of the service.
+          description: The version of the service. Required with `service` when `debug_id` is not set.
           example: 1.0.0
           type: string
-      required:
-        - service
-        - version
       type: object
     ServiceRepositoryInfoRequestData:
       description: Data object for the service repository info request.
@@ -122590,7 +122592,7 @@ components:
         attributes:
           $ref: "#/components/schemas/ServiceRepositoryInfoResponseAttributes"
         id:
-          description: The identifier composed of the service name and version.
+          description: The identifier composed of the service name and version, or the debug ID when the lookup was made by debug ID.
           example: my-web-service:1.0.0
           type: string
         type:
@@ -125270,6 +125272,16 @@ components:
       type: string
       x-enum-varnames:
         - DEBUG_ID
+    SourcemapSymbolType:
+      description: The WASM symbol representation.
+      enum:
+        - dwarf
+        - sourcemap
+      example: dwarf
+      type: string
+      x-enum-varnames:
+        - DWARF
+        - SOURCEMAP
     SourcemapsData:
       description: List of source map data objects.
       items:
@@ -239382,6 +239394,14 @@ paths:
           required: true
           schema:
             $ref: "#/components/schemas/SourcemapMapKind"
+        - description: |-
+            WASM symbol representation. Only supported for `mapkind=wasm`.
+            Defaults to `dwarf`, which requires `filter[build_id]`. `sourcemap`
+            requires `filter[service]` and `filter[version]`.
+          in: query
+          name: symbol_type
+          schema:
+            $ref: "#/components/schemas/SourcemapSymbolType"
         - description: |-
             When set to `true`, returns the source maps that would be deleted
             without performing the actual deletion. When set to `false`,
@@ -239394,7 +239414,8 @@ paths:
             type: boolean
         - description: |-
             Filter by service names (multiple values allowed). Required for
-            `js`, `jvm`, `react`, and `flutter` map kinds.
+            `js`, `jvm`, `react`, and `flutter` map kinds, and for `wasm` with
+            `symbol_type=sourcemap`.
           explode: true
           in: query
           name: filter[service]
@@ -239407,7 +239428,8 @@ paths:
           style: form
         - description: |-
             Filter by version values (multiple values allowed, maximum 10).
-            Required for `js`, `jvm`, `react`, and `flutter` map kinds.
+            Required for `js`, `jvm`, `react`, and `flutter` map kinds, and for
+            `wasm` with `symbol_type=sourcemap`.
           explode: true
           in: query
           name: filter[version]
@@ -239436,7 +239458,10 @@ paths:
               type: string
             type: array
           style: form
-        - description: Filter by build ID values (multiple values allowed). Supported for `jvm`, `ndk`, `il2cpp`, `wasm`, and `portable_pdb`.
+        - description: |-
+            Filter by build ID values (multiple values allowed). Supported for `jvm`,
+            `ndk`, `il2cpp`, `wasm`, and `portable_pdb`. Required for `wasm` with
+            `symbol_type=dwarf`.
           explode: true
           in: query
           name: filter[build_id]
@@ -239821,6 +239846,14 @@ paths:
           name: mapkind
           schema:
             $ref: "#/components/schemas/SourcemapMapKind"
+        - description: |-
+            WASM symbol representation. Only supported for `mapkind=wasm`.
+            Defaults to `dwarf`, which requires `filter[build_id]`. `sourcemap`
+            requires `filter[service]` and `filter[version]`.
+          in: query
+          name: symbol_type
+          schema:
+            $ref: "#/components/schemas/SourcemapSymbolType"
         - description: |-
             Cursor for the next page of a JavaScript listing. Use the value from
             `meta.page.next_cursor` and keep the same search mode and filters.
@@ -239852,7 +239885,8 @@ paths:
             type: integer
         - description: |-
             Filter by service names (multiple values allowed). Required for
-            `jvm`, `react`, and `flutter` map kinds. Also required for `js` unless
+            `jvm`, `react`, and `flutter` map kinds, and for `wasm` with
+            `symbol_type=sourcemap`. Also required for `js` unless
             searching by `filter[debug_id]` or browsing with `search_by=debug_id`.
           explode: true
           in: query
@@ -239866,7 +239900,8 @@ paths:
           style: form
         - description: |-
             Filter by version values (multiple values allowed). Required for
-            `jvm`, `react`, and `flutter` map kinds. Also required for `js` unless
+            `jvm`, `react`, and `flutter` map kinds, and for `wasm` with
+            `symbol_type=sourcemap`. Also required for `js` unless
             searching by `filter[debug_id]` or browsing with `search_by=debug_id`.
           explode: true
           in: query
@@ -239896,7 +239931,10 @@ paths:
               type: string
             type: array
           style: form
-        - description: Filter by build ID values (multiple values allowed). Supported for `jvm`, `ndk`, `il2cpp`, `wasm`, and `portable_pdb`.
+        - description: |-
+            Filter by build ID values (multiple values allowed). Supported for `jvm`,
+            `ndk`, `il2cpp`, `wasm`, and `portable_pdb`. Required for `wasm` with
+            `symbol_type=dwarf`.
           explode: true
           in: query
           name: filter[build_id]
@@ -240094,6 +240132,14 @@ paths:
           required: true
           schema:
             $ref: "#/components/schemas/SourcemapMapKind"
+        - description: |-
+            WASM symbol representation. Only supported for `mapkind=wasm`.
+            Defaults to `dwarf`, which requires `filter[build_id]`. `sourcemap`
+            requires `filter[service]` and `filter[version]`.
+          in: query
+          name: symbol_type
+          schema:
+            $ref: "#/components/schemas/SourcemapSymbolType"
         - description: |-
             When set to `true`, returns the source maps that would be restored
             without performing the actual restoration. When set to `false`,
@@ -240106,7 +240152,8 @@ paths:
             type: boolean
         - description: |-
             Filter by service names (multiple values allowed). Required for
-            `js`, `jvm`, `react`, and `flutter` map kinds.
+            `js`, `jvm`, `react`, and `flutter` map kinds, and for `wasm` with
+            `symbol_type=sourcemap`.
           explode: true
           in: query
           name: filter[service]
@@ -240119,7 +240166,8 @@ paths:
           style: form
         - description: |-
             Filter by version values (multiple values allowed, maximum 10).
-            Required for `js`, `jvm`, `react`, and `flutter` map kinds.
+            Required for `js`, `jvm`, `react`, and `flutter` map kinds, and for
+            `wasm` with `symbol_type=sourcemap`.
           explode: true
           in: query
           name: filter[version]
@@ -240148,7 +240196,10 @@ paths:
               type: string
             type: array
           style: form
-        - description: Filter by build ID values (multiple values allowed). Supported for `jvm`, `ndk`, `il2cpp`, `wasm`, and `portable_pdb`.
+        - description: |-
+            Filter by build ID values (multiple values allowed). Supported for `jvm`,
+            `ndk`, `il2cpp`, `wasm`, and `portable_pdb`. Required for `wasm` with
+            `symbol_type=dwarf`.
           explode: true
           in: query
           name: filter[build_id]
@@ -240308,7 +240359,9 @@ paths:
         If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
   /api/v2/sourcemaps/service_repository_info:
     post:
-      description: Returns the repository URL and commit SHA associated with a given service and version.
+      description: |-
+        Returns the repository URL and commit SHA associated with a debug ID or a given service and version.
+        Provide either `debug_id`, or both `service` and `version`. When `debug_id` is set, it takes precedence.
       operationId: GetServiceRepositoryInfo
       requestBody:
         content:
@@ -240341,6 +240394,12 @@ paths:
               schema:
                 $ref: "#/components/schemas/ServiceRepositoryInfoResponse"
           description: OK
+        "400":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/JSONAPIErrorResponse"
+          description: Bad Request
         "401":
           content:
             application/json:

examples/v2/rum/DeleteSourcemaps.java

@@ -0,0 +1,37 @@
+// Delete source maps returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.RumApi;
+import com.datadog.api.client.v2.api.RumApi.DeleteSourcemapsOptionalParameters;
+import com.datadog.api.client.v2.model.SourcemapMapKind;
+import com.datadog.api.client.v2.model.SourcemapSymbolType;
+import com.datadog.api.client.v2.model.SourcemapsResponse;
+import java.util.Collections;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
+    defaultClient.setUnstableOperationEnabled("v2.deleteSourcemaps", true);
+    RumApi apiInstance = new RumApi(defaultClient);
+
+    try {
+      SourcemapsResponse result =
+          apiInstance.deleteSourcemaps(
+              SourcemapMapKind.WASM,
+              true,
+              new DeleteSourcemapsOptionalParameters()
+                  .symbolType(SourcemapSymbolType.SOURCEMAP)
+                  .filterService(Collections.singletonList("nonexistent-svc"))
+                  .filterVersion(Collections.singletonList("0.0.0-none")));
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling RumApi#deleteSourcemaps");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/rum/GetServiceRepositoryInfo.java

@@ -0,0 +1,40 @@
+// Get service repository information returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.RumApi;
+import com.datadog.api.client.v2.model.ServiceRepositoryInfoDataType;
+import com.datadog.api.client.v2.model.ServiceRepositoryInfoRequest;
+import com.datadog.api.client.v2.model.ServiceRepositoryInfoRequestAttributes;
+import com.datadog.api.client.v2.model.ServiceRepositoryInfoRequestData;
+import com.datadog.api.client.v2.model.ServiceRepositoryInfoResponse;
+import java.util.UUID;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
+    defaultClient.setUnstableOperationEnabled("v2.getServiceRepositoryInfo", true);
+    RumApi apiInstance = new RumApi(defaultClient);
+
+    ServiceRepositoryInfoRequest body =
+        new ServiceRepositoryInfoRequest()
+            .data(
+                new ServiceRepositoryInfoRequestData()
+                    .attributes(
+                        new ServiceRepositoryInfoRequestAttributes()
+                            .debugId(UUID.fromString("00000000-0000-4000-8000-000000000001")))
+                    .type(ServiceRepositoryInfoDataType.SERVICE_REPOSITORY_INFO));
+
+    try {
+      ServiceRepositoryInfoResponse result = apiInstance.getServiceRepositoryInfo(body);
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling RumApi#getServiceRepositoryInfo");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/rum/GetSourcemaps.java

@@ -0,0 +1,26 @@
+// Get a JavaScript source map returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.RumApi;
+import com.datadog.api.client.v2.model.SourcemapFileResponse;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
+    defaultClient.setUnstableOperationEnabled("v2.getSourcemaps", true);
+    RumApi apiInstance = new RumApi(defaultClient);
+
+    try {
+      SourcemapFileResponse result = apiInstance.getSourcemaps();
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling RumApi#getSourcemaps");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/rum/ListSourcemaps.java

@@ -0,0 +1,36 @@
+// List source maps returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.RumApi;
+import com.datadog.api.client.v2.api.RumApi.ListSourcemapsOptionalParameters;
+import com.datadog.api.client.v2.model.ListSourcemapsResponse;
+import com.datadog.api.client.v2.model.SourcemapMapKind;
+import com.datadog.api.client.v2.model.SourcemapSymbolType;
+import java.util.Collections;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
+    defaultClient.setUnstableOperationEnabled("v2.listSourcemaps", true);
+    RumApi apiInstance = new RumApi(defaultClient);
+
+    try {
+      ListSourcemapsResponse result =
+          apiInstance.listSourcemaps(
+              new ListSourcemapsOptionalParameters()
+                  .mapkind(SourcemapMapKind.WASM)
+                  .symbolType(SourcemapSymbolType.SOURCEMAP)
+                  .filterService(Collections.singletonList("my-wasm-app"))
+                  .filterVersion(Collections.singletonList("1.0.0")));
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling RumApi#listSourcemaps");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/rum/RestoreSourcemaps.java

@@ -0,0 +1,37 @@
+// Restore source maps returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.RumApi;
+import com.datadog.api.client.v2.api.RumApi.RestoreSourcemapsOptionalParameters;
+import com.datadog.api.client.v2.model.SourcemapMapKind;
+import com.datadog.api.client.v2.model.SourcemapSymbolType;
+import com.datadog.api.client.v2.model.SourcemapsResponse;
+import java.util.Collections;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
+    defaultClient.setUnstableOperationEnabled("v2.restoreSourcemaps", true);
+    RumApi apiInstance = new RumApi(defaultClient);
+
+    try {
+      SourcemapsResponse result =
+          apiInstance.restoreSourcemaps(
+              SourcemapMapKind.WASM,
+              true,
+              new RestoreSourcemapsOptionalParameters()
+                  .symbolType(SourcemapSymbolType.SOURCEMAP)
+                  .filterService(Collections.singletonList("nonexistent-svc"))
+                  .filterVersion(Collections.singletonList("0.0.0-none")));
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling RumApi#restoreSourcemaps");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}