Add OpenAPI spec for GET /api/v2/org_group_policy_suggestions

.generator/schemas/v2/openapi.yaml

@@ -73349,6 +73349,86 @@ components:
         - MINUS_ID
         - NAME
         - MINUS_NAME
+    OrgGroupPolicySuggestionAttributes:
+      description: Attributes of an org group policy suggestion.
+      properties:
+        consensus_ratio:
+          description: The ratio of member orgs whose configuration agrees on the recommended value.
+          example: 0.75
+          format: double
+          maximum: 1
+          minimum: 0
+          type: number
+        policy_name:
+          description: The name of the suggested policy.
+          example: "monitor_timezone"
+          type: string
+        recommended_value:
+          description: The recommended value for the policy, based on member org consensus.
+          example: "UTC"
+        status:
+          $ref: "#/components/schemas/OrgGroupPolicySuggestionStatus"
+      required:
+        - policy_name
+        - status
+        - consensus_ratio
+        - recommended_value
+      type: object
+    OrgGroupPolicySuggestionData:
+      description: An org group policy suggestion resource.
+      properties:
+        attributes:
+          $ref: "#/components/schemas/OrgGroupPolicySuggestionAttributes"
+        id:
+          description: The ID of the org group policy suggestion.
+          example: "1a2b3c4d-5e6f-7890-abcd-ef0123456789"
+          type: string
+        relationships:
+          $ref: "#/components/schemas/OrgGroupPolicySuggestionRelationships"
+        type:
+          $ref: "#/components/schemas/OrgGroupPolicySuggestionType"
+      required:
+        - id
+        - type
+        - attributes
+      type: object
+    OrgGroupPolicySuggestionListResponse:
+      description: Response containing a list of org group policy suggestions.
+      properties:
+        data:
+          description: An array of org group policy suggestions.
+          items:
+            $ref: "#/components/schemas/OrgGroupPolicySuggestionData"
+          type: array
+      required:
+        - data
+      type: object
+    OrgGroupPolicySuggestionRelationships:
+      description: Relationships of an org group policy suggestion.
+      properties:
+        org_group:
+          $ref: "#/components/schemas/OrgGroupRelationshipToOne"
+      type: object
+    OrgGroupPolicySuggestionStatus:
+      description: The status of the policy suggestion.
+      enum:
+        - pending
+        - accepted
+        - dismissed
+      example: pending
+      type: string
+      x-enum-varnames:
+        - PENDING
+        - ACCEPTED
+        - DISMISSED
+    OrgGroupPolicySuggestionType:
+      description: Org group policy suggestions resource type.
+      enum:
+        - org_group_policy_suggestions
+      example: org_group_policy_suggestions
+      type: string
+      x-enum-varnames:
+        - ORG_GROUP_POLICY_SUGGESTIONS
     OrgGroupPolicyType:
       description: Org group policies resource type.
       enum:
@@ -164682,6 +164762,64 @@ paths:
       x-unstable: |-
         **Note**: This endpoint is in preview and is subject to change.
         If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
+  /api/v2/org_group_policy_suggestions:
+    get:
+      description: List suggested organization group policies. Requires a filter on org group ID.
+      operationId: ListOrgGroupPolicySuggestions
+      parameters:
+        - $ref: "#/components/parameters/OrgGroupPolicyFilterOrgGroupId"
+      responses:
+        "200":
+          content:
+            application/json:
+              examples:
+                default:
+                  value:
+                    data:
+                      - attributes:
+                          consensus_ratio: 0.75
+                          policy_name: "monitor_timezone"
+                          recommended_value: "UTC"
+                          status: "pending"
+                        id: "1a2b3c4d-5e6f-7890-abcd-ef0123456789"
+                        relationships:
+                          org_group:
+                            data:
+                              id: "a1b2c3d4-e5f6-7890-abcd-ef0123456789"
+                              type: org_groups
+                        type: org_group_policy_suggestions
+              schema:
+                $ref: "#/components/schemas/OrgGroupPolicySuggestionListResponse"
+          description: OK
+        "400":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/JSONAPIErrorResponse"
+          description: Bad Request
+        "401":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/JSONAPIErrorResponse"
+          description: Unauthorized
+        "403":
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/JSONAPIErrorResponse"
+          description: Forbidden
+        "429":
+          $ref: "#/components/responses/TooManyRequestsResponse"
+      summary: List org group policy suggestions
+      tags: [Org Groups]
+      "x-permission":
+        operator: OR
+        permissions:
+          - org_group_read
+      x-unstable: |-
+        **Note**: This endpoint is in preview and is subject to change.
+        If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
   /api/v2/org_groups:
     get:
       description: List all organization groups that the requesting organization has access to.

examples/v2/org-groups/ListOrgGroupPolicySuggestions.java

@@ -0,0 +1,28 @@
+// List org group policy suggestions returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.OrgGroupsApi;
+import com.datadog.api.client.v2.model.OrgGroupPolicySuggestionListResponse;
+import java.util.UUID;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    defaultClient.setUnstableOperationEnabled("v2.listOrgGroupPolicySuggestions", true);
+    OrgGroupsApi apiInstance = new OrgGroupsApi(defaultClient);
+
+    try {
+      OrgGroupPolicySuggestionListResponse result =
+          apiInstance.listOrgGroupPolicySuggestions(
+              UUID.fromString("a1b2c3d4-e5f6-7890-abcd-ef0123456789"));
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling OrgGroupsApi#listOrgGroupPolicySuggestions");
+      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

@@ -1214,6 +1214,7 @@ public class ApiClient {
           put("v2.listOrgGroupPolicies", false);
           put("v2.listOrgGroupPolicyConfigs", false);
           put("v2.listOrgGroupPolicyOverrides", false);
+          put("v2.listOrgGroupPolicySuggestions", false);
           put("v2.listOrgGroups", false);
           put("v2.updateOrgGroup", false);
           put("v2.updateOrgGroupMembership", false);

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

@@ -21,6 +21,7 @@
 import com.datadog.api.client.v2.model.OrgGroupPolicyOverrideUpdateRequest;
 import com.datadog.api.client.v2.model.OrgGroupPolicyResponse;
 import com.datadog.api.client.v2.model.OrgGroupPolicySortOption;
+import com.datadog.api.client.v2.model.OrgGroupPolicySuggestionListResponse;
 import com.datadog.api.client.v2.model.OrgGroupPolicyUpdateRequest;
 import com.datadog.api.client.v2.model.OrgGroupResponse;
 import com.datadog.api.client.v2.model.OrgGroupSortOption;
@@ -2747,6 +2748,172 @@ public ApiResponse<OrgGroupPolicyOverrideListResponse> listOrgGroupPolicyOverrid
         new GenericType<OrgGroupPolicyOverrideListResponse>() {});
   }
 
+  /**
+   * List org group policy suggestions.
+   *
+   * <p>See {@link #listOrgGroupPolicySuggestionsWithHttpInfo}.
+   *
+   * @param filterOrgGroupId Filter policies by org group ID. (required)
+   * @return OrgGroupPolicySuggestionListResponse
+   * @throws ApiException if fails to make API call
+   */
+  public OrgGroupPolicySuggestionListResponse listOrgGroupPolicySuggestions(UUID filterOrgGroupId)
+      throws ApiException {
+    return listOrgGroupPolicySuggestionsWithHttpInfo(filterOrgGroupId).getData();
+  }
+
+  /**
+   * List org group policy suggestions.
+   *
+   * <p>See {@link #listOrgGroupPolicySuggestionsWithHttpInfoAsync}.
+   *
+   * @param filterOrgGroupId Filter policies by org group ID. (required)
+   * @return CompletableFuture&lt;OrgGroupPolicySuggestionListResponse&gt;
+   */
+  public CompletableFuture<OrgGroupPolicySuggestionListResponse> listOrgGroupPolicySuggestionsAsync(
+      UUID filterOrgGroupId) {
+    return listOrgGroupPolicySuggestionsWithHttpInfoAsync(filterOrgGroupId)
+        .thenApply(
+            response -> {
+              return response.getData();
+            });
+  }
+
+  /**
+   * List suggested organization group policies. Requires a filter on org group ID.
+   *
+   * @param filterOrgGroupId Filter policies by org group ID. (required)
+   * @return ApiResponse&lt;OrgGroupPolicySuggestionListResponse&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> 401 </td><td> Unauthorized </td><td>  -  </td></tr>
+   *       <tr><td> 403 </td><td> Forbidden </td><td>  -  </td></tr>
+   *       <tr><td> 429 </td><td> Too many requests </td><td>  -  </td></tr>
+   *     </table>
+   */
+  public ApiResponse<OrgGroupPolicySuggestionListResponse>
+      listOrgGroupPolicySuggestionsWithHttpInfo(UUID filterOrgGroupId) throws ApiException {
+    // Check if unstable operation is enabled
+    String operationId = "listOrgGroupPolicySuggestions";
+    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;
+
+    // verify the required parameter 'filterOrgGroupId' is set
+    if (filterOrgGroupId == null) {
+      throw new ApiException(
+          400,
+          "Missing the required parameter 'filterOrgGroupId' when calling"
+              + " listOrgGroupPolicySuggestions");
+    }
+    // create path and map variables
+    String localVarPath = "/api/v2/org_group_policy_suggestions";
+
+    List<Pair> localVarQueryParams = new ArrayList<Pair>();
+    Map<String, String> localVarHeaderParams = new HashMap<String, String>();
+
+    localVarQueryParams.addAll(
+        apiClient.parameterToPairs("", "filter[org_group_id]", filterOrgGroupId));
+
+    Invocation.Builder builder =
+        apiClient.createBuilder(
+            "v2.OrgGroupsApi.listOrgGroupPolicySuggestions",
+            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<OrgGroupPolicySuggestionListResponse>() {});
+  }
+
+  /**
+   * List org group policy suggestions.
+   *
+   * <p>See {@link #listOrgGroupPolicySuggestionsWithHttpInfo}.
+   *
+   * @param filterOrgGroupId Filter policies by org group ID. (required)
+   * @return CompletableFuture&lt;ApiResponse&lt;OrgGroupPolicySuggestionListResponse&gt;&gt;
+   */
+  public CompletableFuture<ApiResponse<OrgGroupPolicySuggestionListResponse>>
+      listOrgGroupPolicySuggestionsWithHttpInfoAsync(UUID filterOrgGroupId) {
+    // Check if unstable operation is enabled
+    String operationId = "listOrgGroupPolicySuggestions";
+    if (apiClient.isUnstableOperationEnabled("v2." + operationId)) {
+      apiClient.getLogger().warning(String.format("Using unstable operation '%s'", operationId));
+    } else {
+      CompletableFuture<ApiResponse<OrgGroupPolicySuggestionListResponse>> result =
+          new CompletableFuture<>();
+      result.completeExceptionally(
+          new ApiException(0, String.format("Unstable operation '%s' is disabled", operationId)));
+      return result;
+    }
+    Object localVarPostBody = null;
+
+    // verify the required parameter 'filterOrgGroupId' is set
+    if (filterOrgGroupId == null) {
+      CompletableFuture<ApiResponse<OrgGroupPolicySuggestionListResponse>> result =
+          new CompletableFuture<>();
+      result.completeExceptionally(
+          new ApiException(
+              400,
+              "Missing the required parameter 'filterOrgGroupId' when calling"
+                  + " listOrgGroupPolicySuggestions"));
+      return result;
+    }
+    // create path and map variables
+    String localVarPath = "/api/v2/org_group_policy_suggestions";
+
+    List<Pair> localVarQueryParams = new ArrayList<Pair>();
+    Map<String, String> localVarHeaderParams = new HashMap<String, String>();
+
+    localVarQueryParams.addAll(
+        apiClient.parameterToPairs("", "filter[org_group_id]", filterOrgGroupId));
+
+    Invocation.Builder builder;
+    try {
+      builder =
+          apiClient.createBuilder(
+              "v2.OrgGroupsApi.listOrgGroupPolicySuggestions",
+              localVarPath,
+              localVarQueryParams,
+              localVarHeaderParams,
+              new HashMap<String, String>(),
+              new String[] {"application/json"},
+              new String[] {"apiKeyAuth", "appKeyAuth"});
+    } catch (ApiException ex) {
+      CompletableFuture<ApiResponse<OrgGroupPolicySuggestionListResponse>> result =
+          new CompletableFuture<>();
+      result.completeExceptionally(ex);
+      return result;
+    }
+    return apiClient.invokeAPIAsync(
+        "GET",
+        builder,
+        localVarHeaderParams,
+        new String[] {},
+        localVarPostBody,
+        new HashMap<String, Object>(),
+        false,
+        new GenericType<OrgGroupPolicySuggestionListResponse>() {});
+  }
+
   /** Manage optional parameters to listOrgGroups. */
   public static class ListOrgGroupsOptionalParameters {
     private Long pageNumber;