Clarify Storage Management for cloud inventory syncconfigs OpenAPI (#4029)

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

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

.generator/schemas/v2/openapi.yaml

@@ -12687,15 +12687,15 @@ components:
         - GCP
         - AZURE
     CloudInventoryCloudProviderRequestType:
-      description: JSON:API type for upsert sync configuration requests.
+      description: Always `cloud_provider`.
       enum:
         - cloud_provider
       example: cloud_provider
       type: string
       x-enum-varnames:
         - CLOUD_PROVIDER
     CloudInventorySyncConfigAWSRequestAttributes:
-      description: AWS settings for the customer bucket that stores inventory reports.
+      description: AWS settings for the S3 bucket Storage Management reads inventory reports from.
       properties:
         aws_account_id:
           description: AWS account ID that owns the inventory bucket.
@@ -12710,7 +12710,7 @@ components:
           example: us-east-1
           type: string
         destination_prefix:
-          description: Optional object key prefix for inventory files. Use `/` or omit for the entire bucket.
+          description: Object key prefix where inventory reports are written. Omit or set to `/` when reports are written at the bucket root.
           example: logs/
           type: string
       required:
@@ -12719,7 +12719,7 @@ components:
         - destination_bucket_region
       type: object
     CloudInventorySyncConfigAttributes:
-      description: Attributes for a cloud inventory sync configuration. Values beyond `id` may be omitted immediately after upsert.
+      description: Attributes for a Storage Management configuration. Fields other than `id` may be empty in the response immediately after a create or update; subsequent reads return the full configuration.
       properties:
         aws_account_id:
           description: AWS account ID for the inventory bucket.
@@ -12774,7 +12774,7 @@ components:
           example: reader@my-gcp-project.iam.gserviceaccount.com
           type: string
         prefix:
-          description: Object key prefix or `/` when the entire bucket is synced.
+          description: Object key prefix where inventory reports are written. Returns `/` when reports are written at the bucket root.
           example: logs/
           readOnly: true
           type: string
@@ -12855,28 +12855,28 @@ components:
         - service_account_email
       type: object
     CloudInventorySyncConfigResourceType:
-      description: JSON:API type for sync configuration resources.
+      description: Always `sync_configs`.
       enum:
         - sync_configs
       example: sync_configs
       type: string
       x-enum-varnames:
         - SYNC_CONFIGS
     CloudInventorySyncConfigResponse:
-      description: Response containing the upserted sync configuration. Additional read-only fields appear on list and get.
+      description: Storage Management configuration returned after a create or update. Additional read-only fields appear on list and get responses.
       properties:
         data:
           $ref: "#/components/schemas/CloudInventorySyncConfigResponseData"
       required:
         - data
       type: object
     CloudInventorySyncConfigResponseData:
-      description: JSON:API data object for a sync configuration.
+      description: Storage Management configuration data.
       properties:
         attributes:
           $ref: "#/components/schemas/CloudInventorySyncConfigAttributes"
         id:
-          description: Unique identifier for the recurring sync configuration.
+          description: Unique identifier for this Storage Management configuration.
           example: abc123
           type: string
         type:
@@ -81461,7 +81461,7 @@ components:
       type: object
     UpsertCloudInventorySyncConfigRequestAttributes:
       description: |-
-        Provider-specific configuration. Include the object that matches `data.id` (`aws`, `gcp`, or `azure`).
+        Settings for the cloud provider specified in `data.id`. Include only the matching provider object (`aws`, `gcp`, or `azure`).
       properties:
         aws:
           $ref: "#/components/schemas/CloudInventorySyncConfigAWSRequestAttributes"
@@ -81471,7 +81471,7 @@ components:
           $ref: "#/components/schemas/CloudInventorySyncConfigGCPRequestAttributes"
       type: object
     UpsertCloudInventorySyncConfigRequestData:
-      description: JSON:API data envelope for an upsert sync configuration request.
+      description: Storage Management configuration data for the create or update request.
       properties:
         attributes:
           $ref: "#/components/schemas/UpsertCloudInventorySyncConfigRequestAttributes"
@@ -94241,8 +94241,7 @@ paths:
   /api/v2/cloudinventoryservice/syncconfigs:
     put:
       description: |-
-        Create or update a cloud inventory sync configuration. Specify the cloud provider in `data.id`
-        and provider-specific settings under `data.attributes`. This endpoint uses an upsert model.
+        Enable Storage Management for an S3 bucket, GCS bucket, or Azure container by registering the destination that holds its inventory reports. Set `data.id` to the cloud provider (`aws`, `gcp`, or `azure`) and provide the matching settings under data.attributes. Calling this endpoint with the same provider replaces the existing configuration.
       operationId: UpsertSyncConfig
       requestBody:
         content:
@@ -94290,17 +94289,14 @@ paths:
           $ref: "#/components/responses/ForbiddenResponse"
         "429":
           $ref: "#/components/responses/TooManyRequestsResponse"
-      summary: Create or update a sync configuration
+      summary: Enable Storage Management for a bucket
       tags:
-        - Cloud Inventory Sync Configs
+        - Storage Management
       x-codegen-request-body-name: body
       "x-permission":
         operator: OR
         permissions:
           - aws_configurations_manage
-      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/code-coverage/branch/summary:
     post:
       description: |-
@@ -145968,9 +145964,6 @@ tags:
   - description: |-
       The Cloud Cost Management API allows you to set up, edit, and delete Cloud Cost Management accounts for AWS, Azure, and Google Cloud. You can query your cost data by using the [Metrics endpoint](https://docs.datadoghq.com/api/latest/metrics/#query-timeseries-data-across-multiple-products) and the `cloud_cost` data source. For more information, see the [Cloud Cost Management documentation](https://docs.datadoghq.com/cloud_cost_management/).
     name: Cloud Cost Management
-  - description: |-
-      Configure cloud inventory file synchronization from your cloud storage to Datadog.
-    name: Cloud Inventory Sync Configs
   - description: |-
       The Cloud Network Monitoring API allows you to fetch aggregated connections and DNS traffic with their attributes. See the [Cloud Network Monitoring page](https://docs.datadoghq.com/network_monitoring/cloud_network_monitoring/) and [DNS Monitoring page](https://docs.datadoghq.com/network_monitoring/dns/) for more information.
     name: Cloud Network Monitoring
@@ -146354,6 +146347,9 @@ tags:
     name: Static Analysis
   - description: Manage your status pages and communicate service disruptions to stakeholders via Datadog's API. See the [Status Pages documentation](https://docs.datadoghq.com/incident_response/status_pages/) for more information.
     name: Status Pages
+  - description: |-
+      Enable Storage Management for S3 buckets, GCS buckets, and Azure containers. Each configuration registers the destination that holds inventory reports for the storage being monitored.
+    name: Storage Management
   - description: |-
       Synthetic tests use simulated requests and actions so you can monitor the availability and performance of systems and applications. Datadog supports the following types of synthetic tests:
       - [API tests](https://docs.datadoghq.com/synthetics/api_tests/)

api/datadog/configuration.go

@@ -755,7 +755,6 @@ func NewConfiguration() *Configuration {
 			"v2.MuteSecurityFindings":                           false,
 			"v2.RunHistoricalJob":                               false,
 			"v2.SearchSecurityMonitoringHistsignals":            false,
-			"v2.UpsertSyncConfig":                               false,
 			"v2.GetCodeCoverageBranchSummary":                   false,
 			"v2.GetCodeCoverageCommitSummary":                   false,
 			"v2.CreateDashboardSecureEmbed":                     false,

…ogV2/api_cloud_inventory_sync_configs.go api/datadogV2/api_storage_management.goapi/datadogV2/api_cloud_inventory_sync_configs.go renamed to api/datadogV2/api_storage_management.go api/datadogV2/api_cloud_inventory_sync_configs.go renamed to api/datadogV2/api_storage_management.go

@@ -6,37 +6,25 @@ package datadogV2
 
 import (
 	_context "context"
-	_fmt "fmt"
-	_log "log"
 	_nethttp "net/http"
 	_neturl "net/url"
 
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// CloudInventorySyncConfigsApi service type
-type CloudInventorySyncConfigsApi datadog.Service
+// StorageManagementApi service type
+type StorageManagementApi datadog.Service
 
-// UpsertSyncConfig Create or update a sync configuration.
-// Create or update a cloud inventory sync configuration. Specify the cloud provider in `data.id`
-// and provider-specific settings under `data.attributes`. This endpoint uses an upsert model.
-func (a *CloudInventorySyncConfigsApi) UpsertSyncConfig(ctx _context.Context, body UpsertCloudInventorySyncConfigRequest) (CloudInventorySyncConfigResponse, *_nethttp.Response, error) {
+// UpsertSyncConfig Enable Storage Management for a bucket.
+// Enable Storage Management for an S3 bucket, GCS bucket, or Azure container by registering the destination that holds its inventory reports. Set `data.id` to the cloud provider (`aws`, `gcp`, or `azure`) and provide the matching settings under data.attributes. Calling this endpoint with the same provider replaces the existing configuration.
+func (a *StorageManagementApi) UpsertSyncConfig(ctx _context.Context, body UpsertCloudInventorySyncConfigRequest) (CloudInventorySyncConfigResponse, *_nethttp.Response, error) {
 	var (
 		localVarHTTPMethod  = _nethttp.MethodPut
 		localVarPostBody    interface{}
 		localVarReturnValue CloudInventorySyncConfigResponse
 	)
 
-	operationId := "v2.UpsertSyncConfig"
-	isOperationEnabled := a.Client.Cfg.IsUnstableOperationEnabled(operationId)
-	if !isOperationEnabled {
-		return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: _fmt.Sprintf("Unstable operation '%s' is disabled", operationId)}
-	}
-	if isOperationEnabled && a.Client.Cfg.Debug {
-		_log.Printf("WARNING: Using unstable operation '%s'", operationId)
-	}
-
-	localBasePath, err := a.Client.Cfg.ServerURLWithContext(ctx, "v2.CloudInventorySyncConfigsApi.UpsertSyncConfig")
+	localBasePath, err := a.Client.Cfg.ServerURLWithContext(ctx, "v2.StorageManagementApi.UpsertSyncConfig")
 	if err != nil {
 		return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: err.Error()}
 	}
@@ -116,9 +104,9 @@ func (a *CloudInventorySyncConfigsApi) UpsertSyncConfig(ctx _context.Context, bo
 	return localVarReturnValue, localVarHTTPResponse, nil
 }
 
-// NewCloudInventorySyncConfigsApi Returns NewCloudInventorySyncConfigsApi.
-func NewCloudInventorySyncConfigsApi(client *datadog.APIClient) *CloudInventorySyncConfigsApi {
-	return &CloudInventorySyncConfigsApi{
+// NewStorageManagementApi Returns NewStorageManagementApi.
+func NewStorageManagementApi(client *datadog.APIClient) *StorageManagementApi {
+	return &StorageManagementApi{
 		Client: client,
 	}
 }

api/datadogV2/doc.go

@@ -214,7 +214,6 @@
 //   - [CloudCostManagementApi.ValidateBudget]
 //   - [CloudCostManagementApi.ValidateCsvBudget]
 //   - [CloudCostManagementApi.ValidateQuery]
-//   - [CloudInventorySyncConfigsApi.UpsertSyncConfig]
 //   - [CloudNetworkMonitoringApi.GetAggregatedConnections]
 //   - [CloudNetworkMonitoringApi.GetAggregatedDns]
 //   - [CloudflareIntegrationApi.CreateCloudflareAccount]
@@ -924,6 +923,7 @@
 //   - [StatusPagesApi.UpdateDegradation]
 //   - [StatusPagesApi.UpdateMaintenance]
 //   - [StatusPagesApi.UpdateStatusPage]
+//   - [StorageManagementApi.UpsertSyncConfig]
 //   - [SyntheticsApi.AbortTestFileMultipartUpload]
 //   - [SyntheticsApi.AddTestToSyntheticsDowntime]
 //   - [SyntheticsApi.CompleteTestFileMultipartUpload]

api/datadogV2/model_cloud_inventory_cloud_provider_request_type.go

@@ -10,7 +10,7 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// CloudInventoryCloudProviderRequestType JSON:API type for upsert sync configuration requests.
+// CloudInventoryCloudProviderRequestType Always `cloud_provider`.
 type CloudInventoryCloudProviderRequestType string
 
 // List of CloudInventoryCloudProviderRequestType.

api/datadogV2/model_cloud_inventory_sync_config_attributes.go

@@ -10,7 +10,7 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// CloudInventorySyncConfigAttributes Attributes for a cloud inventory sync configuration. Values beyond `id` may be omitted immediately after upsert.
+// CloudInventorySyncConfigAttributes Attributes for a Storage Management configuration. Fields other than `id` may be empty in the response immediately after a create or update; subsequent reads return the full configuration.
 type CloudInventorySyncConfigAttributes struct {
 	// AWS account ID for the inventory bucket.
 	AwsAccountId string `json:"aws_account_id"`
@@ -38,7 +38,7 @@ type CloudInventorySyncConfigAttributes struct {
 	GcpProjectId string `json:"gcp_project_id"`
 	// Service account email for bucket access.
 	GcpServiceAccountEmail string `json:"gcp_service_account_email"`
-	// Object key prefix or `/` when the entire bucket is synced.
+	// Object key prefix where inventory reports are written. Returns `/` when reports are written at the bucket root.
 	Prefix string `json:"prefix"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`

api/datadogV2/model_cloud_inventory_sync_config_aws_request_attributes.go

@@ -10,15 +10,15 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// CloudInventorySyncConfigAWSRequestAttributes AWS settings for the customer bucket that stores inventory reports.
+// CloudInventorySyncConfigAWSRequestAttributes AWS settings for the S3 bucket Storage Management reads inventory reports from.
 type CloudInventorySyncConfigAWSRequestAttributes struct {
 	// AWS account ID that owns the inventory bucket.
 	AwsAccountId string `json:"aws_account_id"`
 	// Name of the S3 bucket containing inventory files.
 	DestinationBucketName string `json:"destination_bucket_name"`
 	// AWS Region of the inventory bucket.
 	DestinationBucketRegion string `json:"destination_bucket_region"`
-	// Optional object key prefix for inventory files. Use `/` or omit for the entire bucket.
+	// Object key prefix where inventory reports are written. Omit or set to `/` when reports are written at the bucket root.
 	DestinationPrefix *string `json:"destination_prefix,omitempty"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`

api/datadogV2/model_cloud_inventory_sync_config_resource_type.go

@@ -10,7 +10,7 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// CloudInventorySyncConfigResourceType JSON:API type for sync configuration resources.
+// CloudInventorySyncConfigResourceType Always `sync_configs`.
 type CloudInventorySyncConfigResourceType string
 
 // List of CloudInventorySyncConfigResourceType.

api/datadogV2/model_cloud_inventory_sync_config_response.go

@@ -10,9 +10,9 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// CloudInventorySyncConfigResponse Response containing the upserted sync configuration. Additional read-only fields appear on list and get.
+// CloudInventorySyncConfigResponse Storage Management configuration returned after a create or update. Additional read-only fields appear on list and get responses.
 type CloudInventorySyncConfigResponse struct {
-	// JSON:API data object for a sync configuration.
+	// Storage Management configuration data.
 	Data CloudInventorySyncConfigResponseData `json:"data"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`

api/datadogV2/model_cloud_inventory_sync_config_response_data.go

@@ -10,13 +10,13 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// CloudInventorySyncConfigResponseData JSON:API data object for a sync configuration.
+// CloudInventorySyncConfigResponseData Storage Management configuration data.
 type CloudInventorySyncConfigResponseData struct {
-	// Attributes for a cloud inventory sync configuration. Values beyond `id` may be omitted immediately after upsert.
+	// Attributes for a Storage Management configuration. Fields other than `id` may be empty in the response immediately after a create or update; subsequent reads return the full configuration.
 	Attributes CloudInventorySyncConfigAttributes `json:"attributes"`
-	// Unique identifier for the recurring sync configuration.
+	// Unique identifier for this Storage Management configuration.
 	Id string `json:"id"`
-	// JSON:API type for sync configuration resources.
+	// Always `sync_configs`.
 	Type CloudInventorySyncConfigResourceType `json:"type"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`