Skip to content

Commit adbc73e

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
chore(spec): add missing descriptions to OpenAPI schemas and properties [all] (#3853)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 4205019 commit adbc73e

446 files changed

Lines changed: 2390 additions & 1234 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.generator/schemas/v2/openapi.yaml

Lines changed: 1220 additions & 64 deletions
Large diffs are not rendered by default.

api/datadogV2/model_any_value_item.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import (
88
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
99
)
1010

11-
// AnyValueItem -
11+
// AnyValueItem - A single item in an array of arbitrary values, which can be a string, number, object, or boolean.
1212
type AnyValueItem struct {
1313
AnyValueString *string
1414
AnyValueNumber *float64

api/datadogV2/model_argument.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
1111
)
1212

13-
// Argument
13+
// Argument A named argument for a custom static analysis rule.
1414
type Argument struct {
1515
// Base64-encoded argument description
1616
Description string `json:"description"`

api/datadogV2/model_assign_seats_user_request.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ import (
88
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
99
)
1010

11-
// AssignSeatsUserRequest
11+
// AssignSeatsUserRequest The request body for assigning seats to users for a product code.
1212
type AssignSeatsUserRequest struct {
13-
//
13+
// The request data object containing attributes for assigning seats to users.
1414
Data *AssignSeatsUserRequestData `json:"data,omitempty"`
1515
// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
1616
UnparsedObject map[string]interface{} `json:"-"`

api/datadogV2/model_assign_seats_user_request_data.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ import (
1010
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
1111
)
1212

13-
// AssignSeatsUserRequestData
13+
// AssignSeatsUserRequestData The request data object containing attributes for assigning seats to users.
1414
type AssignSeatsUserRequestData struct {
15-
//
15+
// Attributes specifying the product and users to whom seats will be assigned.
1616
Attributes AssignSeatsUserRequestDataAttributes `json:"attributes"`
1717
// The ID of the assign seats user request.
1818
Id *string `json:"id,omitempty"`

api/datadogV2/model_assign_seats_user_request_data_attributes.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
1111
)
1212

13-
// AssignSeatsUserRequestDataAttributes
13+
// AssignSeatsUserRequestDataAttributes Attributes specifying the product and users to whom seats will be assigned.
1414
type AssignSeatsUserRequestDataAttributes struct {
1515
// The product code for which to assign seats.
1616
ProductCode string `json:"product_code"`

api/datadogV2/model_assign_seats_user_response.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ import (
88
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
99
)
1010

11-
// AssignSeatsUserResponse
11+
// AssignSeatsUserResponse The response body returned after successfully assigning seats to users.
1212
type AssignSeatsUserResponse struct {
13-
//
13+
// The response data object containing attributes of the seat assignment result.
1414
Data *AssignSeatsUserResponseData `json:"data,omitempty"`
1515
// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
1616
UnparsedObject map[string]interface{} `json:"-"`

api/datadogV2/model_assign_seats_user_response_data.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ import (
88
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
99
)
1010

11-
// AssignSeatsUserResponseData
11+
// AssignSeatsUserResponseData The response data object containing attributes of the seat assignment result.
1212
type AssignSeatsUserResponseData struct {
13-
//
13+
// Attributes of the assign seats response, including the list of users assigned and the product code.
1414
Attributes *AssignSeatsUserResponseDataAttributes `json:"attributes,omitempty"`
1515
// The ID of the assign seats user response.
1616
Id *string `json:"id,omitempty"`

api/datadogV2/model_assign_seats_user_response_data_attributes.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import (
88
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
99
)
1010

11-
// AssignSeatsUserResponseDataAttributes
11+
// AssignSeatsUserResponseDataAttributes Attributes of the assign seats response, including the list of users assigned and the product code.
1212
type AssignSeatsUserResponseDataAttributes struct {
1313
// The list of user IDs to which the seats were assigned.
1414
AssignedIds []string `json:"assigned_ids,omitempty"`

api/datadogV2/model_attachment.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import (
1212
type Attachment struct {
1313
// Attachment data from a response.
1414
Data *AttachmentData `json:"data,omitempty"`
15-
//
15+
// A list of related objects included in the response.
1616
Included []AttachmentIncluded `json:"included,omitempty"`
1717
// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
1818
UnparsedObject map[string]interface{} `json:"-"`

0 commit comments

Comments
 (0)