Add documentation for GET, POST, PATCH, and DELETE api/v2/incidents/incident_id/attachments endpoints (#3508)

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

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

.generator/schemas/v2/openapi.yaml

@@ -661,12 +661,14 @@ func NewConfiguration() *Configuration {
 			"v2.UpdateDeploymentGate":                    false,
 			"v2.UpdateDeploymentRule":                    false,
 			"v2.CreateIncident":                          false,
+			"v2.CreateIncidentAttachment":                false,
 			"v2.CreateIncidentIntegration":               false,
 			"v2.CreateIncidentNotificationRule":          false,
 			"v2.CreateIncidentNotificationTemplate":      false,
 			"v2.CreateIncidentTodo":                      false,
 			"v2.CreateIncidentType":                      false,
 			"v2.DeleteIncident":                          false,
+			"v2.DeleteIncidentAttachment":                false,
 			"v2.DeleteIncidentIntegration":               false,
 			"v2.DeleteIncidentNotificationRule":          false,
 			"v2.DeleteIncidentNotificationTemplate":      false,
@@ -687,7 +689,7 @@ func NewConfiguration() *Configuration {
 			"v2.ListIncidentTypes":                       false,
 			"v2.SearchIncidents":                         false,
 			"v2.UpdateIncident":                          false,
-			"v2.UpdateIncidentAttachments":               false,
+			"v2.UpdateIncidentAttachment":                false,
 			"v2.UpdateIncidentIntegration":               false,
 			"v2.UpdateIncidentNotificationRule":          false,
 			"v2.UpdateIncidentNotificationTemplate":      false,

api/datadog/configuration.go

@@ -291,13 +291,15 @@
 //   - [IncidentTeamsApi.ListIncidentTeams]
 //   - [IncidentTeamsApi.UpdateIncidentTeam]
 //   - [IncidentsApi.CreateIncident]
+//   - [IncidentsApi.CreateIncidentAttachment]
 //   - [IncidentsApi.CreateIncidentImpact]
 //   - [IncidentsApi.CreateIncidentIntegration]
 //   - [IncidentsApi.CreateIncidentNotificationRule]
 //   - [IncidentsApi.CreateIncidentNotificationTemplate]
 //   - [IncidentsApi.CreateIncidentTodo]
 //   - [IncidentsApi.CreateIncidentType]
 //   - [IncidentsApi.DeleteIncident]
+//   - [IncidentsApi.DeleteIncidentAttachment]
 //   - [IncidentsApi.DeleteIncidentImpact]
 //   - [IncidentsApi.DeleteIncidentIntegration]
 //   - [IncidentsApi.DeleteIncidentNotificationRule]
@@ -320,7 +322,7 @@
 //   - [IncidentsApi.ListIncidents]
 //   - [IncidentsApi.SearchIncidents]
 //   - [IncidentsApi.UpdateIncident]
-//   - [IncidentsApi.UpdateIncidentAttachments]
+//   - [IncidentsApi.UpdateIncidentAttachment]
 //   - [IncidentsApi.UpdateIncidentIntegration]
 //   - [IncidentsApi.UpdateIncidentNotificationRule]
 //   - [IncidentsApi.UpdateIncidentNotificationTemplate]

api/datadogV2/api_incidents.go

@@ -5,99 +5,102 @@
 package datadogV2
 
 import (
-	"fmt"
-
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// IncidentAttachmentUpdateResponse The response object containing the created or updated incident attachments.
-type IncidentAttachmentUpdateResponse struct {
-	// An array of incident attachments. Only the attachments that were created or updated by the request are
-	// returned.
-	Data []IncidentAttachmentData `json:"data"`
-	// Included related resources that the user requested.
-	Included []IncidentAttachmentsResponseIncludedItem `json:"included,omitempty"`
+// Attachment
+type Attachment struct {
+	//
+	Data *AttachmentData `json:"data,omitempty"`
+	//
+	Included []AttachmentIncluded `json:"included,omitempty"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`
 	AdditionalProperties map[string]interface{} `json:"-"`
 }
 
-// NewIncidentAttachmentUpdateResponse instantiates a new IncidentAttachmentUpdateResponse object.
+// NewAttachment instantiates a new Attachment object.
 // This constructor will assign default values to properties that have it defined,
 // and makes sure properties required by API are set, but the set of arguments
 // will change when the set of required properties is changed.
-func NewIncidentAttachmentUpdateResponse(data []IncidentAttachmentData) *IncidentAttachmentUpdateResponse {
-	this := IncidentAttachmentUpdateResponse{}
-	this.Data = data
+func NewAttachment() *Attachment {
+	this := Attachment{}
 	return &this
 }
 
-// NewIncidentAttachmentUpdateResponseWithDefaults instantiates a new IncidentAttachmentUpdateResponse object.
+// NewAttachmentWithDefaults instantiates a new Attachment object.
 // This constructor will only assign default values to properties that have it defined,
 // but it doesn't guarantee that properties required by API are set.
-func NewIncidentAttachmentUpdateResponseWithDefaults() *IncidentAttachmentUpdateResponse {
-	this := IncidentAttachmentUpdateResponse{}
+func NewAttachmentWithDefaults() *Attachment {
+	this := Attachment{}
 	return &this
 }
 
-// GetData returns the Data field value.
-func (o *IncidentAttachmentUpdateResponse) GetData() []IncidentAttachmentData {
-	if o == nil {
-		var ret []IncidentAttachmentData
+// GetData returns the Data field value if set, zero value otherwise.
+func (o *Attachment) GetData() AttachmentData {
+	if o == nil || o.Data == nil {
+		var ret AttachmentData
 		return ret
 	}
-	return o.Data
+	return *o.Data
 }
 
-// GetDataOk returns a tuple with the Data field value
+// GetDataOk returns a tuple with the Data field value if set, nil otherwise
 // and a boolean to check if the value has been set.
-func (o *IncidentAttachmentUpdateResponse) GetDataOk() (*[]IncidentAttachmentData, bool) {
-	if o == nil {
+func (o *Attachment) GetDataOk() (*AttachmentData, bool) {
+	if o == nil || o.Data == nil {
 		return nil, false
 	}
-	return &o.Data, true
+	return o.Data, true
+}
+
+// HasData returns a boolean if a field has been set.
+func (o *Attachment) HasData() bool {
+	return o != nil && o.Data != nil
 }
 
-// SetData sets field value.
-func (o *IncidentAttachmentUpdateResponse) SetData(v []IncidentAttachmentData) {
-	o.Data = v
+// SetData gets a reference to the given AttachmentData and assigns it to the Data field.
+func (o *Attachment) SetData(v AttachmentData) {
+	o.Data = &v
 }
 
 // GetIncluded returns the Included field value if set, zero value otherwise.
-func (o *IncidentAttachmentUpdateResponse) GetIncluded() []IncidentAttachmentsResponseIncludedItem {
+func (o *Attachment) GetIncluded() []AttachmentIncluded {
 	if o == nil || o.Included == nil {
-		var ret []IncidentAttachmentsResponseIncludedItem
+		var ret []AttachmentIncluded
 		return ret
 	}
 	return o.Included
 }
 
 // GetIncludedOk returns a tuple with the Included field value if set, nil otherwise
 // and a boolean to check if the value has been set.
-func (o *IncidentAttachmentUpdateResponse) GetIncludedOk() (*[]IncidentAttachmentsResponseIncludedItem, bool) {
+func (o *Attachment) GetIncludedOk() (*[]AttachmentIncluded, bool) {
 	if o == nil || o.Included == nil {
 		return nil, false
 	}
 	return &o.Included, true
 }
 
 // HasIncluded returns a boolean if a field has been set.
-func (o *IncidentAttachmentUpdateResponse) HasIncluded() bool {
+func (o *Attachment) HasIncluded() bool {
 	return o != nil && o.Included != nil
 }
 
-// SetIncluded gets a reference to the given []IncidentAttachmentsResponseIncludedItem and assigns it to the Included field.
-func (o *IncidentAttachmentUpdateResponse) SetIncluded(v []IncidentAttachmentsResponseIncludedItem) {
+// SetIncluded gets a reference to the given []AttachmentIncluded and assigns it to the Included field.
+func (o *Attachment) SetIncluded(v []AttachmentIncluded) {
 	o.Included = v
 }
 
 // MarshalJSON serializes the struct using spec logic.
-func (o IncidentAttachmentUpdateResponse) MarshalJSON() ([]byte, error) {
+func (o Attachment) MarshalJSON() ([]byte, error) {
 	toSerialize := map[string]interface{}{}
 	if o.UnparsedObject != nil {
 		return datadog.Marshal(o.UnparsedObject)
 	}
-	toSerialize["data"] = o.Data
+	if o.Data != nil {
+		toSerialize["data"] = o.Data
+	}
 	if o.Included != nil {
 		toSerialize["included"] = o.Included
 	}
@@ -109,29 +112,35 @@ func (o IncidentAttachmentUpdateResponse) MarshalJSON() ([]byte, error) {
 }
 
 // UnmarshalJSON deserializes the given payload.
-func (o *IncidentAttachmentUpdateResponse) UnmarshalJSON(bytes []byte) (err error) {
+func (o *Attachment) UnmarshalJSON(bytes []byte) (err error) {
 	all := struct {
-		Data     *[]IncidentAttachmentData                 `json:"data"`
-		Included []IncidentAttachmentsResponseIncludedItem `json:"included,omitempty"`
+		Data     *AttachmentData      `json:"data,omitempty"`
+		Included []AttachmentIncluded `json:"included,omitempty"`
 	}{}
 	if err = datadog.Unmarshal(bytes, &all); err != nil {
 		return datadog.Unmarshal(bytes, &o.UnparsedObject)
 	}
-	if all.Data == nil {
-		return fmt.Errorf("required field data missing")
-	}
 	additionalProperties := make(map[string]interface{})
 	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
 		datadog.DeleteKeys(additionalProperties, &[]string{"data", "included"})
 	} else {
 		return err
 	}
-	o.Data = *all.Data
+
+	hasInvalidField := false
+	if all.Data != nil && all.Data.UnparsedObject != nil && o.UnparsedObject == nil {
+		hasInvalidField = true
+	}
+	o.Data = all.Data
 	o.Included = all.Included
 
 	if len(additionalProperties) > 0 {
 		o.AdditionalProperties = additionalProperties
 	}
 
+	if hasInvalidField {
+		return datadog.Unmarshal(bytes, &o.UnparsedObject)
+	}
+
 	return nil
 }

api/datadogV2/doc.go

@@ -10,88 +10,88 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// IncidentAttachmentsResponse The response object containing an incident's attachments.
-type IncidentAttachmentsResponse struct {
-	// An array of incident attachments.
-	Data []IncidentAttachmentData `json:"data"`
-	// Included related resources that the user requested.
-	Included []IncidentAttachmentsResponseIncludedItem `json:"included,omitempty"`
+// AttachmentArray
+type AttachmentArray struct {
+	//
+	Data []AttachmentData `json:"data"`
+	//
+	Included []AttachmentIncluded `json:"included,omitempty"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`
 	AdditionalProperties map[string]interface{} `json:"-"`
 }
 
-// NewIncidentAttachmentsResponse instantiates a new IncidentAttachmentsResponse object.
+// NewAttachmentArray instantiates a new AttachmentArray object.
 // This constructor will assign default values to properties that have it defined,
 // and makes sure properties required by API are set, but the set of arguments
 // will change when the set of required properties is changed.
-func NewIncidentAttachmentsResponse(data []IncidentAttachmentData) *IncidentAttachmentsResponse {
-	this := IncidentAttachmentsResponse{}
+func NewAttachmentArray(data []AttachmentData) *AttachmentArray {
+	this := AttachmentArray{}
 	this.Data = data
 	return &this
 }
 
-// NewIncidentAttachmentsResponseWithDefaults instantiates a new IncidentAttachmentsResponse object.
+// NewAttachmentArrayWithDefaults instantiates a new AttachmentArray object.
 // This constructor will only assign default values to properties that have it defined,
 // but it doesn't guarantee that properties required by API are set.
-func NewIncidentAttachmentsResponseWithDefaults() *IncidentAttachmentsResponse {
-	this := IncidentAttachmentsResponse{}
+func NewAttachmentArrayWithDefaults() *AttachmentArray {
+	this := AttachmentArray{}
 	return &this
 }
 
 // GetData returns the Data field value.
-func (o *IncidentAttachmentsResponse) GetData() []IncidentAttachmentData {
+func (o *AttachmentArray) GetData() []AttachmentData {
 	if o == nil {
-		var ret []IncidentAttachmentData
+		var ret []AttachmentData
 		return ret
 	}
 	return o.Data
 }
 
 // GetDataOk returns a tuple with the Data field value
 // and a boolean to check if the value has been set.
-func (o *IncidentAttachmentsResponse) GetDataOk() (*[]IncidentAttachmentData, bool) {
+func (o *AttachmentArray) GetDataOk() (*[]AttachmentData, bool) {
 	if o == nil {
 		return nil, false
 	}
 	return &o.Data, true
 }
 
 // SetData sets field value.
-func (o *IncidentAttachmentsResponse) SetData(v []IncidentAttachmentData) {
+func (o *AttachmentArray) SetData(v []AttachmentData) {
 	o.Data = v
 }
 
 // GetIncluded returns the Included field value if set, zero value otherwise.
-func (o *IncidentAttachmentsResponse) GetIncluded() []IncidentAttachmentsResponseIncludedItem {
+func (o *AttachmentArray) GetIncluded() []AttachmentIncluded {
 	if o == nil || o.Included == nil {
-		var ret []IncidentAttachmentsResponseIncludedItem
+		var ret []AttachmentIncluded
 		return ret
 	}
 	return o.Included
 }
 
 // GetIncludedOk returns a tuple with the Included field value if set, nil otherwise
 // and a boolean to check if the value has been set.
-func (o *IncidentAttachmentsResponse) GetIncludedOk() (*[]IncidentAttachmentsResponseIncludedItem, bool) {
+func (o *AttachmentArray) GetIncludedOk() (*[]AttachmentIncluded, bool) {
 	if o == nil || o.Included == nil {
 		return nil, false
 	}
 	return &o.Included, true
 }
 
 // HasIncluded returns a boolean if a field has been set.
-func (o *IncidentAttachmentsResponse) HasIncluded() bool {
+func (o *AttachmentArray) HasIncluded() bool {
 	return o != nil && o.Included != nil
 }
 
-// SetIncluded gets a reference to the given []IncidentAttachmentsResponseIncludedItem and assigns it to the Included field.
-func (o *IncidentAttachmentsResponse) SetIncluded(v []IncidentAttachmentsResponseIncludedItem) {
+// SetIncluded gets a reference to the given []AttachmentIncluded and assigns it to the Included field.
+func (o *AttachmentArray) SetIncluded(v []AttachmentIncluded) {
 	o.Included = v
 }
 
 // MarshalJSON serializes the struct using spec logic.
-func (o IncidentAttachmentsResponse) MarshalJSON() ([]byte, error) {
+func (o AttachmentArray) MarshalJSON() ([]byte, error) {
 	toSerialize := map[string]interface{}{}
 	if o.UnparsedObject != nil {
 		return datadog.Marshal(o.UnparsedObject)
@@ -108,10 +108,10 @@ func (o IncidentAttachmentsResponse) MarshalJSON() ([]byte, error) {
 }
 
 // UnmarshalJSON deserializes the given payload.
-func (o *IncidentAttachmentsResponse) UnmarshalJSON(bytes []byte) (err error) {
+func (o *AttachmentArray) UnmarshalJSON(bytes []byte) (err error) {
 	all := struct {
-		Data     *[]IncidentAttachmentData                 `json:"data"`
-		Included []IncidentAttachmentsResponseIncludedItem `json:"included,omitempty"`
+		Data     *[]AttachmentData    `json:"data"`
+		Included []AttachmentIncluded `json:"included,omitempty"`
 	}{}
 	if err = datadog.Unmarshal(bytes, &all); err != nil {
 		return datadog.Unmarshal(bytes, &o.UnparsedObject)