Add partial hierarchy selection to team sync endpoints (#3767)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -65885,6 +65885,8 @@ components:
       properties:
         frequency:
           $ref: "#/components/schemas/TeamSyncAttributesFrequency"
+        selection_state:
+          $ref: "#/components/schemas/TeamSyncAttributesSelectionState"
         source:
           $ref: "#/components/schemas/TeamSyncAttributesSource"
         sync_membership:
@@ -65907,6 +65909,14 @@ components:
         - ONCE
         - CONTINUOUSLY
         - PAUSED
+    TeamSyncAttributesSelectionState:
+      description: |-
+        Specifies which teams or organizations to sync. When
+        provided, synchronization is limited to the specified
+        items and their subtrees.
+      items:
+        $ref: "#/components/schemas/TeamSyncSelectionStateItem"
+      type: array
     TeamSyncAttributesSource:
       description: The external source platform for team synchronization. Only "github" is supported.
       enum:
@@ -65916,6 +65926,7 @@ components:
       x-enum-varnames:
         - GITHUB
     TeamSyncAttributesSyncMembership:
+      default: false
       description: Whether to sync members from the external team to the Datadog team. Defaults to `false` when not provided.
       example: true
       type: boolean
@@ -65975,6 +65986,72 @@ components:
             $ref: "#/components/schemas/TeamSyncData"
           type: array
       type: object
+    TeamSyncSelectionStateExternalId:
+      description: The external identifier for a team or organization in the source platform.
+      properties:
+        type:
+          $ref: "#/components/schemas/TeamSyncSelectionStateExternalIdType"
+        value:
+          $ref: "#/components/schemas/TeamSyncSelectionStateExternalIdValue"
+      required:
+        - type
+        - value
+      type: object
+    TeamSyncSelectionStateExternalIdType:
+      description: |-
+        The type of external identifier for the selection state item.
+        For GitHub synchronization, the allowed values are `team` and
+        `organization`.
+      enum:
+        - team
+        - organization
+      example: team
+      type: string
+      x-enum-varnames:
+        - TEAM
+        - ORGANIZATION
+    TeamSyncSelectionStateExternalIdValue:
+      description: |-
+        The external identifier value from the source
+        platform. For GitHub, this is the string
+        representation of a GitHub organization ID or team
+        ID.
+      example: "1"
+      type: string
+    TeamSyncSelectionStateItem:
+      description: Identifies a team or organization hierarchy to include in synchronization.
+      properties:
+        external_id:
+          $ref: "#/components/schemas/TeamSyncSelectionStateExternalId"
+        operation:
+          $ref: "#/components/schemas/TeamSyncSelectionStateOperation"
+        scope:
+          $ref: "#/components/schemas/TeamSyncSelectionStateScope"
+      required:
+        - external_id
+      type: object
+    TeamSyncSelectionStateOperation:
+      description: |-
+        The operation to perform on the selected hierarchy.
+        When set to `include`, synchronization covers the
+        referenced teams or organizations.
+      enum:
+        - include
+      example: include
+      type: string
+      x-enum-varnames:
+        - INCLUDE
+    TeamSyncSelectionStateScope:
+      description: |-
+        The scope of the selection. When set to `subtree`,
+        synchronization includes the referenced team or
+        organization and everything nested under it.
+      enum:
+        - subtree
+      example: subtree
+      type: string
+      x-enum-varnames:
+        - SUBTREE
     TeamTarget:
       description: "Represents a team target for an escalation policy step, including the team's ID and resource type."
       properties:
@@ -105434,12 +105511,6 @@ paths:
           description: OK
         "403":
           $ref: "#/components/responses/ForbiddenResponse"
-        "404":
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/APIErrorResponse"
-          description: Team sync configurations not found
         "429":
           $ref: "#/components/responses/TooManyRequestsResponse"
       security:
@@ -105456,13 +105527,17 @@ paths:
           - teams_read
     post:
       description: |-
-        This endpoint attempts to link your existing Datadog teams with GitHub teams by matching their names.
+        This endpoint configures synchronization between your existing Datadog teams and GitHub teams by matching their names.
         It evaluates all current Datadog teams and compares them against teams in the GitHub organization
         connected to your Datadog account, based on Datadog Team handle and GitHub Team slug
         (lowercased and kebab-cased).
 
         This operation is read-only on the GitHub side, no teams will be modified or created.
 
+        Optionally, provide `selection_state` to limit synchronization
+        to specific teams or organizations and their subtrees, instead
+        of syncing all teams.
+
         [A GitHub organization must be connected to your Datadog account](https://docs.datadoghq.com/integrations/github/),
         and the GitHub App integrated with Datadog must have the `Members Read` permission. Matching is performed by comparing the Datadog team handle to the GitHub team slug
         using a normalized exact match; case is ignored and spaces are removed. No modifications are made
@@ -105477,6 +105552,8 @@ paths:
       responses:
         "200":
           description: OK
+        "204":
+          description: No Content
         "403":
           $ref: "#/components/responses/ForbiddenResponse"
         "429":

api/datadogV2/api_teams.go

@@ -1724,7 +1724,7 @@ func (a *TeamsApi) GetTeamSync(ctx _context.Context, filterSource TeamSyncAttrib
 			ErrorBody:    localVarBody,
 			ErrorMessage: localVarHTTPResponse.Status,
 		}
-		if localVarHTTPResponse.StatusCode == 403 || localVarHTTPResponse.StatusCode == 404 || localVarHTTPResponse.StatusCode == 429 {
+		if localVarHTTPResponse.StatusCode == 403 || localVarHTTPResponse.StatusCode == 429 {
 			var v APIErrorResponse
 			err = a.Client.Decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
 			if err != nil {
@@ -2772,13 +2772,17 @@ func (a *TeamsApi) RemoveTeamHierarchyLink(ctx _context.Context, linkId string)
 }
 
 // SyncTeams Link Teams with GitHub Teams.
-// This endpoint attempts to link your existing Datadog teams with GitHub teams by matching their names.
+// This endpoint configures synchronization between your existing Datadog teams and GitHub teams by matching their names.
 // It evaluates all current Datadog teams and compares them against teams in the GitHub organization
 // connected to your Datadog account, based on Datadog Team handle and GitHub Team slug
 // (lowercased and kebab-cased).
 //
 // This operation is read-only on the GitHub side, no teams will be modified or created.
 //
+// Optionally, provide `selection_state` to limit synchronization
+// to specific teams or organizations and their subtrees, instead
+// of syncing all teams.
+//
 // [A GitHub organization must be connected to your Datadog account](https://docs.datadoghq.com/integrations/github/),
 // and the GitHub App integrated with Datadog must have the `Members Read` permission. Matching is performed by comparing the Datadog team handle to the GitHub team slug
 // using a normalized exact match; case is ignored and spaces are removed. No modifications are made

api/datadogV2/model_team_sync_attributes.go

@@ -14,6 +14,10 @@ import (
 type TeamSyncAttributes struct {
 	// How often the sync process should be run. Defaults to `once` when not provided.
 	Frequency *TeamSyncAttributesFrequency `json:"frequency,omitempty"`
+	// Specifies which teams or organizations to sync. When
+	// provided, synchronization is limited to the specified
+	// items and their subtrees.
+	SelectionState []TeamSyncSelectionStateItem `json:"selection_state,omitempty"`
 	// The external source platform for team synchronization. Only "github" is supported.
 	Source TeamSyncAttributesSource `json:"source"`
 	// Whether to sync members from the external team to the Datadog team. Defaults to `false` when not provided.
@@ -32,6 +36,8 @@ type TeamSyncAttributes struct {
 func NewTeamSyncAttributes(source TeamSyncAttributesSource, typeVar TeamSyncAttributesType) *TeamSyncAttributes {
 	this := TeamSyncAttributes{}
 	this.Source = source
+	var syncMembership bool = false
+	this.SyncMembership = &syncMembership
 	this.Type = typeVar
 	return &this
 }
@@ -41,6 +47,8 @@ func NewTeamSyncAttributes(source TeamSyncAttributesSource, typeVar TeamSyncAttr
 // but it doesn't guarantee that properties required by API are set.
 func NewTeamSyncAttributesWithDefaults() *TeamSyncAttributes {
 	this := TeamSyncAttributes{}
+	var syncMembership bool = false
+	this.SyncMembership = &syncMembership
 	return &this
 }
 
@@ -72,6 +80,34 @@ func (o *TeamSyncAttributes) SetFrequency(v TeamSyncAttributesFrequency) {
 	o.Frequency = &v
 }
 
+// GetSelectionState returns the SelectionState field value if set, zero value otherwise.
+func (o *TeamSyncAttributes) GetSelectionState() []TeamSyncSelectionStateItem {
+	if o == nil || o.SelectionState == nil {
+		var ret []TeamSyncSelectionStateItem
+		return ret
+	}
+	return o.SelectionState
+}
+
+// GetSelectionStateOk returns a tuple with the SelectionState field value if set, nil otherwise
+// and a boolean to check if the value has been set.
+func (o *TeamSyncAttributes) GetSelectionStateOk() (*[]TeamSyncSelectionStateItem, bool) {
+	if o == nil || o.SelectionState == nil {
+		return nil, false
+	}
+	return &o.SelectionState, true
+}
+
+// HasSelectionState returns a boolean if a field has been set.
+func (o *TeamSyncAttributes) HasSelectionState() bool {
+	return o != nil && o.SelectionState != nil
+}
+
+// SetSelectionState gets a reference to the given []TeamSyncSelectionStateItem and assigns it to the SelectionState field.
+func (o *TeamSyncAttributes) SetSelectionState(v []TeamSyncSelectionStateItem) {
+	o.SelectionState = v
+}
+
 // GetSource returns the Source field value.
 func (o *TeamSyncAttributes) GetSource() TeamSyncAttributesSource {
 	if o == nil {
@@ -155,6 +191,9 @@ func (o TeamSyncAttributes) MarshalJSON() ([]byte, error) {
 	if o.Frequency != nil {
 		toSerialize["frequency"] = o.Frequency
 	}
+	if o.SelectionState != nil {
+		toSerialize["selection_state"] = o.SelectionState
+	}
 	toSerialize["source"] = o.Source
 	if o.SyncMembership != nil {
 		toSerialize["sync_membership"] = o.SyncMembership
@@ -171,6 +210,7 @@ func (o TeamSyncAttributes) MarshalJSON() ([]byte, error) {
 func (o *TeamSyncAttributes) UnmarshalJSON(bytes []byte) (err error) {
 	all := struct {
 		Frequency      *TeamSyncAttributesFrequency `json:"frequency,omitempty"`
+		SelectionState []TeamSyncSelectionStateItem `json:"selection_state,omitempty"`
 		Source         *TeamSyncAttributesSource    `json:"source"`
 		SyncMembership *bool                        `json:"sync_membership,omitempty"`
 		Type           *TeamSyncAttributesType      `json:"type"`
@@ -186,7 +226,7 @@ func (o *TeamSyncAttributes) UnmarshalJSON(bytes []byte) (err error) {
 	}
 	additionalProperties := make(map[string]interface{})
 	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
-		datadog.DeleteKeys(additionalProperties, &[]string{"frequency", "source", "sync_membership", "type"})
+		datadog.DeleteKeys(additionalProperties, &[]string{"frequency", "selection_state", "source", "sync_membership", "type"})
 	} else {
 		return err
 	}
@@ -197,6 +237,7 @@ func (o *TeamSyncAttributes) UnmarshalJSON(bytes []byte) (err error) {
 	} else {
 		o.Frequency = all.Frequency
 	}
+	o.SelectionState = all.SelectionState
 	if !all.Source.IsValid() {
 		hasInvalidField = true
 	} else {