Add OpenAPI documentation for dashboards and notebooks search endpoints

examples/v2/dashboards/SearchDashboards.java

@@ -0,0 +1,25 @@
+// Search dashboards returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.DashboardsApi;
+import com.datadog.api.client.v2.model.DashboardSearchResponse;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    defaultClient.setUnstableOperationEnabled("v2.searchDashboards", true);
+    DashboardsApi apiInstance = new DashboardsApi(defaultClient);
+
+    try {
+      DashboardSearchResponse result = apiInstance.searchDashboards();
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling DashboardsApi#searchDashboards");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/notebooks/SearchNotebooks.java

@@ -0,0 +1,25 @@
+// Search notebooks returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.NotebooksApi;
+import com.datadog.api.client.v2.model.NotebookSearchResponse;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    defaultClient.setUnstableOperationEnabled("v2.searchNotebooks", true);
+    NotebooksApi apiInstance = new NotebooksApi(defaultClient);
+
+    try {
+      NotebookSearchResponse result = apiInstance.searchNotebooks();
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling NotebooksApi#searchNotebooks");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

src/main/java/com/datadog/api/client/ApiClient.java

@@ -797,6 +797,7 @@ public class ApiClient {
           put("v2.muteFindings", false);
           put("v2.runThreatHuntingJob", false);
           put("v2.searchSecurityMonitoringHistsignals", false);
+          put("v2.searchDashboards", false);
           put("v2.createDataset", false);
           put("v2.deleteDataset", false);
           put("v2.getAllDatasets", false);
@@ -894,6 +895,7 @@ public class ApiClient {
           put("v2.updateMonitorUserTemplate", false);
           put("v2.validateExistingMonitorUserTemplate", false);
           put("v2.validateMonitorUserTemplate", false);
+          put("v2.searchNotebooks", false);
           put("v2.listRoleTemplates", false);
           put("v2.createConnection", false);
           put("v2.deleteConnection", false);

src/main/java/com/datadog/api/client/v2/api/DashboardsApi.java

@@ -0,0 +1,296 @@
+package com.datadog.api.client.v2.api;
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.ApiResponse;
+import com.datadog.api.client.Pair;
+import com.datadog.api.client.v2.model.DashboardSearchResponse;
+import jakarta.ws.rs.client.Invocation;
+import jakarta.ws.rs.core.GenericType;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.CompletableFuture;
+
+@jakarta.annotation.Generated(
+    value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
+public class DashboardsApi {
+  private ApiClient apiClient;
+
+  public DashboardsApi() {
+    this(ApiClient.getDefaultApiClient());
+  }
+
+  public DashboardsApi(ApiClient apiClient) {
+    this.apiClient = apiClient;
+  }
+
+  /**
+   * Get the API client.
+   *
+   * @return API client
+   */
+  public ApiClient getApiClient() {
+    return apiClient;
+  }
+
+  /**
+   * Set the API client.
+   *
+   * @param apiClient an instance of API client
+   */
+  public void setApiClient(ApiClient apiClient) {
+    this.apiClient = apiClient;
+  }
+
+  /** Manage optional parameters to searchDashboards. */
+  public static class SearchDashboardsOptionalParameters {
+    private String query;
+    private String sort;
+    private String include;
+    private Integer page;
+    private Integer limit;
+
+    /**
+     * Set query.
+     *
+     * @param query Search query string. (optional)
+     * @return SearchDashboardsOptionalParameters
+     */
+    public SearchDashboardsOptionalParameters query(String query) {
+      this.query = query;
+      return this;
+    }
+
+    /**
+     * Set sort.
+     *
+     * @param sort Sort field for results. (optional)
+     * @return SearchDashboardsOptionalParameters
+     */
+    public SearchDashboardsOptionalParameters sort(String sort) {
+      this.sort = sort;
+      return this;
+    }
+
+    /**
+     * Set include.
+     *
+     * @param include Additional data to include in the response. (optional)
+     * @return SearchDashboardsOptionalParameters
+     */
+    public SearchDashboardsOptionalParameters include(String include) {
+      this.include = include;
+      return this;
+    }
+
+    /**
+     * Set page.
+     *
+     * @param page Page number for pagination. (optional)
+     * @return SearchDashboardsOptionalParameters
+     */
+    public SearchDashboardsOptionalParameters page(Integer page) {
+      this.page = page;
+      return this;
+    }
+
+    /**
+     * Set limit.
+     *
+     * @param limit Maximum number of results to return. (optional)
+     * @return SearchDashboardsOptionalParameters
+     */
+    public SearchDashboardsOptionalParameters limit(Integer limit) {
+      this.limit = limit;
+      return this;
+    }
+  }
+
+  /**
+   * Search dashboards.
+   *
+   * <p>See {@link #searchDashboardsWithHttpInfo}.
+   *
+   * @return DashboardSearchResponse
+   * @throws ApiException if fails to make API call
+   */
+  public DashboardSearchResponse searchDashboards() throws ApiException {
+    return searchDashboardsWithHttpInfo(new SearchDashboardsOptionalParameters()).getData();
+  }
+
+  /**
+   * Search dashboards.
+   *
+   * <p>See {@link #searchDashboardsWithHttpInfoAsync}.
+   *
+   * @return CompletableFuture&lt;DashboardSearchResponse&gt;
+   */
+  public CompletableFuture<DashboardSearchResponse> searchDashboardsAsync() {
+    return searchDashboardsWithHttpInfoAsync(new SearchDashboardsOptionalParameters())
+        .thenApply(
+            response -> {
+              return response.getData();
+            });
+  }
+
+  /**
+   * Search dashboards.
+   *
+   * <p>See {@link #searchDashboardsWithHttpInfo}.
+   *
+   * @param parameters Optional parameters for the request.
+   * @return DashboardSearchResponse
+   * @throws ApiException if fails to make API call
+   */
+  public DashboardSearchResponse searchDashboards(SearchDashboardsOptionalParameters parameters)
+      throws ApiException {
+    return searchDashboardsWithHttpInfo(parameters).getData();
+  }
+
+  /**
+   * Search dashboards.
+   *
+   * <p>See {@link #searchDashboardsWithHttpInfoAsync}.
+   *
+   * @param parameters Optional parameters for the request.
+   * @return CompletableFuture&lt;DashboardSearchResponse&gt;
+   */
+  public CompletableFuture<DashboardSearchResponse> searchDashboardsAsync(
+      SearchDashboardsOptionalParameters parameters) {
+    return searchDashboardsWithHttpInfoAsync(parameters)
+        .thenApply(
+            response -> {
+              return response.getData();
+            });
+  }
+
+  /**
+   * Search for dashboards using a query string.
+   *
+   * @param parameters Optional parameters for the request.
+   * @return ApiResponse&lt;DashboardSearchResponse&gt;
+   * @throws ApiException if fails to make API call
+   * @http.response.details
+   *     <table border="1">
+   *    <caption>Response details</caption>
+   *       <tr><td> Status Code </td><td> Description </td><td> Response Headers </td></tr>
+   *       <tr><td> 200 </td><td> OK </td><td>  -  </td></tr>
+   *       <tr><td> 400 </td><td> Bad Request </td><td>  -  </td></tr>
+   *       <tr><td> 429 </td><td> Too many requests </td><td>  -  </td></tr>
+   *       <tr><td> 503 </td><td> Service Unavailable </td><td>  -  </td></tr>
+   *     </table>
+   */
+  public ApiResponse<DashboardSearchResponse> searchDashboardsWithHttpInfo(
+      SearchDashboardsOptionalParameters parameters) throws ApiException {
+    // Check if unstable operation is enabled
+    String operationId = "searchDashboards";
+    if (apiClient.isUnstableOperationEnabled("v2." + operationId)) {
+      apiClient.getLogger().warning(String.format("Using unstable operation '%s'", operationId));
+    } else {
+      throw new ApiException(0, String.format("Unstable operation '%s' is disabled", operationId));
+    }
+    Object localVarPostBody = null;
+    String query = parameters.query;
+    String sort = parameters.sort;
+    String include = parameters.include;
+    Integer page = parameters.page;
+    Integer limit = parameters.limit;
+    // create path and map variables
+    String localVarPath = "/api/v2/dashboards/search";
+
+    List<Pair> localVarQueryParams = new ArrayList<Pair>();
+    Map<String, String> localVarHeaderParams = new HashMap<String, String>();
+
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "query", query));
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort", sort));
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "include", include));
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "page", page));
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit));
+
+    Invocation.Builder builder =
+        apiClient.createBuilder(
+            "v2.DashboardsApi.searchDashboards",
+            localVarPath,
+            localVarQueryParams,
+            localVarHeaderParams,
+            new HashMap<String, String>(),
+            new String[] {"application/json"},
+            new String[] {"apiKeyAuth", "appKeyAuth"});
+    return apiClient.invokeAPI(
+        "GET",
+        builder,
+        localVarHeaderParams,
+        new String[] {},
+        localVarPostBody,
+        new HashMap<String, Object>(),
+        false,
+        new GenericType<DashboardSearchResponse>() {});
+  }
+
+  /**
+   * Search dashboards.
+   *
+   * <p>See {@link #searchDashboardsWithHttpInfo}.
+   *
+   * @param parameters Optional parameters for the request.
+   * @return CompletableFuture&lt;ApiResponse&lt;DashboardSearchResponse&gt;&gt;
+   */
+  public CompletableFuture<ApiResponse<DashboardSearchResponse>> searchDashboardsWithHttpInfoAsync(
+      SearchDashboardsOptionalParameters parameters) {
+    // Check if unstable operation is enabled
+    String operationId = "searchDashboards";
+    if (apiClient.isUnstableOperationEnabled("v2." + operationId)) {
+      apiClient.getLogger().warning(String.format("Using unstable operation '%s'", operationId));
+    } else {
+      CompletableFuture<ApiResponse<DashboardSearchResponse>> result = new CompletableFuture<>();
+      result.completeExceptionally(
+          new ApiException(0, String.format("Unstable operation '%s' is disabled", operationId)));
+      return result;
+    }
+    Object localVarPostBody = null;
+    String query = parameters.query;
+    String sort = parameters.sort;
+    String include = parameters.include;
+    Integer page = parameters.page;
+    Integer limit = parameters.limit;
+    // create path and map variables
+    String localVarPath = "/api/v2/dashboards/search";
+
+    List<Pair> localVarQueryParams = new ArrayList<Pair>();
+    Map<String, String> localVarHeaderParams = new HashMap<String, String>();
+
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "query", query));
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "sort", sort));
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "include", include));
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "page", page));
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit));
+
+    Invocation.Builder builder;
+    try {
+      builder =
+          apiClient.createBuilder(
+              "v2.DashboardsApi.searchDashboards",
+              localVarPath,
+              localVarQueryParams,
+              localVarHeaderParams,
+              new HashMap<String, String>(),
+              new String[] {"application/json"},
+              new String[] {"apiKeyAuth", "appKeyAuth"});
+    } catch (ApiException ex) {
+      CompletableFuture<ApiResponse<DashboardSearchResponse>> result = new CompletableFuture<>();
+      result.completeExceptionally(ex);
+      return result;
+    }
+    return apiClient.invokeAPIAsync(
+        "GET",
+        builder,
+        localVarHeaderParams,
+        new String[] {},
+        localVarPostBody,
+        new HashMap<String, Object>(),
+        false,
+        new GenericType<DashboardSearchResponse>() {});
+  }
+}