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.rb

@@ -0,0 +1,8 @@
+# List org group policy suggestions returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.list_org_group_policy_suggestions".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::OrgGroupsAPI.new
+p api_instance.list_org_group_policy_suggestions("a1b2c3d4-e5f6-7890-abcd-ef0123456789")

features/scenarios_model_mapping.rb

@@ -4699,6 +4699,9 @@
             "org_group_policy_override_id" => "UUID",
             "body" => "OrgGroupPolicyOverrideUpdateRequest",
     },
+    "v2.ListOrgGroupPolicySuggestions" => {
+            "filter_org_group_id" => "UUID",
+    },
     "v2.ListOrgGroups" => {
             "page_number" => "Integer",
             "page_size" => "Integer",

features/v2/org_groups.feature

@@ -325,6 +325,22 @@ Feature: Org Groups
     When the request is sent
     Then the response status is 200 OK
 
+  @generated @skip @team:DataDog/org-management
+  Scenario: List org group policy suggestions returns "Bad Request" response
+    Given operation "ListOrgGroupPolicySuggestions" enabled
+    And new "ListOrgGroupPolicySuggestions" request
+    And request contains "filter[org_group_id]" parameter from "REPLACE.ME"
+    When the request is sent
+    Then the response status is 400 Bad Request
+
+  @generated @skip @team:DataDog/org-management
+  Scenario: List org group policy suggestions returns "OK" response
+    Given operation "ListOrgGroupPolicySuggestions" enabled
+    And new "ListOrgGroupPolicySuggestions" request
+    And request contains "filter[org_group_id]" parameter from "REPLACE.ME"
+    When the request is sent
+    Then the response status is 200 OK
+
   @generated @skip @team:DataDog/org-management
   Scenario: List org groups returns "Bad Request" response
     Given operation "ListOrgGroups" enabled

features/v2/undo.json

@@ -5959,6 +5959,12 @@
       "type": "idempotent"
     }
   },
+  "ListOrgGroupPolicySuggestions": {
+    "tag": "Org Groups",
+    "undo": {
+      "type": "safe"
+    }
+  },
   "ListOrgGroups": {
     "tag": "Org Groups",
     "undo": {

lib/datadog_api_client/configuration.rb

@@ -642,6 +642,7 @@ def initialize
             "v2.list_org_group_policies": false,
             "v2.list_org_group_policy_configs": false,
             "v2.list_org_group_policy_overrides": false,
+            "v2.list_org_group_policy_suggestions": false,
             "v2.list_org_groups": false,
             "v2.update_org_group": false,
             "v2.update_org_group_membership": false,

lib/datadog_api_client/inflector.rb

@@ -5527,6 +5527,12 @@ def overrides
           "v2.org_group_policy_relationship_to_one_data" => "OrgGroupPolicyRelationshipToOneData",
           "v2.org_group_policy_response" => "OrgGroupPolicyResponse",
           "v2.org_group_policy_sort_option" => "OrgGroupPolicySortOption",
+          "v2.org_group_policy_suggestion_attributes" => "OrgGroupPolicySuggestionAttributes",
+          "v2.org_group_policy_suggestion_data" => "OrgGroupPolicySuggestionData",
+          "v2.org_group_policy_suggestion_list_response" => "OrgGroupPolicySuggestionListResponse",
+          "v2.org_group_policy_suggestion_relationships" => "OrgGroupPolicySuggestionRelationships",
+          "v2.org_group_policy_suggestion_status" => "OrgGroupPolicySuggestionStatus",
+          "v2.org_group_policy_suggestion_type" => "OrgGroupPolicySuggestionType",
           "v2.org_group_policy_type" => "OrgGroupPolicyType",
           "v2.org_group_policy_update_attributes" => "OrgGroupPolicyUpdateAttributes",
           "v2.org_group_policy_update_data" => "OrgGroupPolicyUpdateData",

lib/datadog_api_client/v2/api/org_groups_api.rb

@@ -1153,6 +1153,78 @@ def list_org_group_policy_overrides_with_http_info(filter_org_group_id, opts = {
       return data, status_code, headers
     end
 
+    # List org group policy suggestions.
+    #
+    # @see #list_org_group_policy_suggestions_with_http_info
+    def list_org_group_policy_suggestions(filter_org_group_id, opts = {})
+      data, _status_code, _headers = list_org_group_policy_suggestions_with_http_info(filter_org_group_id, opts)
+      data
+    end
+
+    # List org group policy suggestions.
+    #
+    # List suggested organization group policies. Requires a filter on org group ID.
+    #
+    # @param filter_org_group_id [UUID] Filter policies by org group ID.
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(OrgGroupPolicySuggestionListResponse, Integer, Hash)>] OrgGroupPolicySuggestionListResponse data, response status code and response headers
+    def list_org_group_policy_suggestions_with_http_info(filter_org_group_id, opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.list_org_group_policy_suggestions".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_org_group_policy_suggestions")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_org_group_policy_suggestions"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrgGroupsAPI.list_org_group_policy_suggestions ...'
+      end
+      # verify the required parameter 'filter_org_group_id' is set
+      if @api_client.config.client_side_validation && filter_org_group_id.nil?
+        fail ArgumentError, "Missing the required parameter 'filter_org_group_id' when calling OrgGroupsAPI.list_org_group_policy_suggestions"
+      end
+      # resource path
+      local_var_path = '/api/v2/org_group_policy_suggestions'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'filter[org_group_id]'] = filter_org_group_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OrgGroupPolicySuggestionListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]
+
+      new_options = opts.merge(
+        :operation => :list_org_group_policy_suggestions,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type,
+        :api_version => "V2"
+      )
+
+      data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrgGroupsAPI#list_org_group_policy_suggestions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List org groups.
     #
     # @see #list_org_groups_with_http_info