diff --git a/.apigentools-info b/.apigentools-info index 3c508759777..552954a24bd 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2024-10-10 16:48:54.881752", - "spec_repo_commit": "56b8bb9b" + "regenerated": "2024-10-10 18:55:02.877582", + "spec_repo_commit": "1bd8568a" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2024-10-10 16:48:54.900980", - "spec_repo_commit": "56b8bb9b" + "regenerated": "2024-10-10 18:55:02.896093", + "spec_repo_commit": "1bd8568a" } } } \ No newline at end of file diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index ca35a1fcefa..c592c7ff286 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -203,7 +203,7 @@ components: schema: type: string EntityID: - description: UUID or Entity Ref + description: UUID or Entity Ref. in: path name: entity_id required: true @@ -232,41 +232,41 @@ components: schema: type: string FilterByExcludeSnapshot: - description: Filter entities by excluding snapshotted entities + description: Filter entities by excluding snapshotted entities. in: query - name: fitler[exclude_snapshot] + name: filter[exclude_snapshot] required: false schema: type: string FilterByID: - description: Filter entities by UUID + description: Filter entities by UUID. explode: true in: query - name: fitler[id] + name: filter[id] required: false schema: type: string FilterByKind: - description: Filter entities by kind + description: Filter entities by kind. explode: true in: query - name: fitler[kind] + name: filter[kind] required: false schema: type: string FilterByName: - description: Filter entities by name + description: Filter entities by name. explode: true in: query - name: fitler[name] + name: filter[name] required: false schema: type: string FilterByOwner: - description: Filter entities by owner + description: Filter entities by owner. explode: true in: query - name: fitler[owner] + name: filter[owner] required: false schema: type: string @@ -274,15 +274,15 @@ components: description: Filter entities by reference explode: true in: query - name: fitler[ref] + name: filter[ref] required: false schema: type: string FilterByRelationType: - description: Filter entities by relation type + description: Filter entities by relation type. explode: true in: query - name: fitler[relation][type] + name: filter[relation][type] required: false schema: $ref: '#/components/schemas/RelationType' @@ -422,7 +422,7 @@ components: schema: type: string Include: - description: include relationship data + description: Include relationship data. explode: true in: query name: include @@ -7680,7 +7680,7 @@ components: description: Entity attributes. properties: apiVersion: - description: The api version. + description: The API version. type: string description: description: The description. @@ -7712,7 +7712,7 @@ components: attributes: $ref: '#/components/schemas/EntityAttributes' id: - description: Entity id. + description: Entity ID. type: string meta: $ref: '#/components/schemas/EntityMeta' @@ -7739,7 +7739,7 @@ components: type: string type: object EntityRaw: - description: Entity definition in raw JSON/YAML representation. + description: Entity definition in raw JSON or YAML representation. example: "apiVersion: v3\nkind: service\nmetadata:\n name: myservice\n" type: string EntityRelationships: @@ -7767,7 +7767,7 @@ components: attributes: $ref: '#/components/schemas/EntityResponseIncludedRelatedIncidentAttributes' id: - description: Incident id. + description: Incident ID. type: string type: description: Incident description. @@ -7791,7 +7791,7 @@ components: attributes: $ref: '#/components/schemas/EntityResponseIncludedRawSchemaAttributes' id: - description: Raw schema id. + description: Raw schema ID. type: string type: description: Raw schema type. @@ -7882,7 +7882,7 @@ components: type: string type: object EntityResponseIncludedRelatedOncallEscalationItem: - description: Oncall escalation + description: Oncall escalation. properties: email: description: Oncall email. @@ -7896,7 +7896,7 @@ components: type: string type: object EntityResponseIncludedRelatedOncallEscalations: - description: Oncall escalations + description: Oncall escalations. items: $ref: '#/components/schemas/EntityResponseIncludedRelatedOncallEscalationItem' type: array @@ -7906,7 +7906,7 @@ components: attributes: $ref: '#/components/schemas/EntityResponseIncludedSchemaAttributes' id: - description: Entity id. + description: Entity ID. type: string type: description: Schema type. @@ -7969,7 +7969,7 @@ components: - $ref: '#/components/schemas/EntityV3System' EntityV3APIVersion: description: The schema version of entity type. The field is known as schema-version - in the previous version + in the previous version. enum: - v3 example: v3 @@ -7978,21 +7978,21 @@ components: - V3 EntityV3DatadogCodeLocationItem: additionalProperties: false - description: code location item. + description: Code location item. properties: paths: - description: The paths (glob) to the source code of the service + description: The paths (glob) to the source code of the service. items: type: string type: array repositoryURL: - description: The repository path of the source code of the entity + description: The repository path of the source code of the entity. pattern: url type: string type: object EntityV3DatadogCodeLocations: additionalProperties: false - description: Schema for mapping source code locations to an entity + description: Schema for mapping source code locations to an entity. items: $ref: '#/components/schemas/EntityV3DatadogCodeLocationItem' type: array @@ -8001,28 +8001,28 @@ components: description: Events association item. properties: name: - description: The name of the query + description: The name of the query. type: string query: - description: The query to run + description: The query to run. type: string type: object EntityV3DatadogEvents: additionalProperties: false - description: Events associations + description: Events associations. items: $ref: '#/components/schemas/EntityV3DatadogEventItem' type: array EntityV3DatadogIntegrationOpsgenie: additionalProperties: false - description: An Opsgenie integration schema + description: An Opsgenie integration schema. properties: region: description: The region for the Opsgenie integration. minLength: 1 type: string serviceURL: - description: The service url for the Opsgenie integration. + description: The service URL for the Opsgenie integration. example: https://www.opsgenie.com/service/shopping-cart minLength: 1 type: string @@ -8031,10 +8031,10 @@ components: type: object EntityV3DatadogIntegrationPagerduty: additionalProperties: false - description: An PagerDuty integration schema + description: A PagerDuty integration schema. properties: serviceURL: - description: The service url for the PagerDuty integration. + description: The service URL for the PagerDuty integration. example: https://www.pagerduty.com/service-directory/Pshopping-cart minLength: 1 type: string @@ -8043,46 +8043,46 @@ components: type: object EntityV3DatadogLogItem: additionalProperties: false - description: log association item. + description: Log association item. properties: name: - description: The name of the query + description: The name of the query. type: string query: - description: The query to run + description: The query to run. type: string type: object EntityV3DatadogLogs: additionalProperties: false - description: Logs association + description: Logs association. items: $ref: '#/components/schemas/EntityV3DatadogLogItem' type: array EntityV3DatadogPerformance: additionalProperties: false - description: Performance stats association + description: Performance stats association. properties: tags: description: A list of APM entity tags that associates the APM Stats data - with the entity + with the entity. items: type: string type: array type: object EntityV3DatadogPipelines: additionalProperties: false - description: CI Pipelines association + description: CI Pipelines association. properties: fingerprints: description: A list of CI Fingerprints that associate CI Pipelines with - the entity + the entity. items: type: string type: array type: object EntityV3Datastore: additionalProperties: false - description: Schema for datastore entities + description: Schema for datastore entities. properties: apiVersion: $ref: '#/components/schemas/EntityV3APIVersion' @@ -8108,7 +8108,7 @@ components: type: object EntityV3DatastoreDatadog: additionalProperties: false - description: Datadog product integrations for the datastore entity + description: Datadog product integrations for the datastore entity. properties: events: $ref: '#/components/schemas/EntityV3DatadogEvents' @@ -8134,16 +8134,16 @@ components: minLength: 1 type: string tier: - description: The importance of the datastore + description: The importance of the datastore. minLength: 1 type: string type: - description: The type of datastore + description: The type of datastore. type: string type: object EntityV3Integrations: additionalProperties: false - description: A base schema for defining third party integrations + description: A base schema for defining third-party integrations. properties: opsgenie: $ref: '#/components/schemas/EntityV3DatadogIntegrationOpsgenie' @@ -8156,23 +8156,23 @@ components: properties: additionalOwners: additionalProperties: false - description: The additional owners of the entity, usually a team + description: The additional owners of the entity, usually a team. items: $ref: '#/components/schemas/EntityV3MetadataAdditionalOwnersItems' type: array contacts: additionalProperties: false - description: A list of contacts for the entity + description: A list of contacts for the entity. items: $ref: '#/components/schemas/EntityV3MetadataContactsItems' type: array description: description: Short description of the entity. The UI can leverage the description - for display + for display. type: string displayName: description: User friendly name of the entity. The UI can leverage the display - name for display + name for display. type: string id: description: A read-only globally unique identifier for the entity generated @@ -8186,7 +8186,7 @@ components: type: string links: additionalProperties: false - description: A list of links for the entity + description: A list of links for the entity. items: $ref: '#/components/schemas/EntityV3MetadataLinksItems' type: array @@ -8196,20 +8196,20 @@ components: Datadog. User supplied values are ignored. type: object name: - description: 'Unique name given to an entity under the kind/namespace ' + description: Unique name given to an entity under the kind/namespace. example: myService minLength: 1 type: string namespace: description: Namespace is a part of unique identifier. It has a default - value of 'default' + value of 'default'. example: default minLength: 1 type: string owner: $ref: '#/components/schemas/EntityV3MetadataOwner' tags: - description: A set of custom tags + description: A set of custom tags. example: - this:tag - that:tag @@ -8223,11 +8223,11 @@ components: description: The definition of Entity V3 Metadata Additional Owners Items object. properties: name: - description: Team name + description: Team name. example: '' type: string type: - description: Team type + description: Team type. type: string required: - name @@ -8236,11 +8236,11 @@ components: description: The definition of Entity V3 Metadata Contacts Items object. properties: contact: - description: Contact value + description: Contact value. example: https://slack/ type: string name: - description: Contact name + description: Contact name. minLength: 2 type: string type: @@ -8256,7 +8256,7 @@ components: description: The definition of Entity V3 Metadata Links Items object. properties: name: - description: Link name + description: Link name. example: mylink type: string provider: @@ -8268,7 +8268,7 @@ components: example: link type: string url: - description: Link url + description: Link URL. example: https://mylink type: string required: @@ -8278,14 +8278,14 @@ components: type: object EntityV3MetadataOwner: additionalProperties: false - description: The owner of the entity, usually a team + description: The owner of the entity, usually a team. properties: name: - description: Team name + description: Team name. type: string EntityV3Queue: additionalProperties: false - description: Schema for queue entities + description: Schema for queue entities. properties: apiVersion: $ref: '#/components/schemas/EntityV3APIVersion' @@ -8293,8 +8293,8 @@ components: $ref: '#/components/schemas/EntityV3QueueDatadog' extensions: additionalProperties: {} - description: Custom extensions. This is the free-formed field to send client - side metadata. No Datadog features are affected by this field. + description: Custom extensions. This is the free-formed field to send client-side + metadata. No Datadog features are affected by this field. type: object integrations: $ref: '#/components/schemas/EntityV3Integrations' @@ -8311,7 +8311,7 @@ components: type: object EntityV3QueueDatadog: additionalProperties: false - description: Datadog product integrations for the datastore entity + description: Datadog product integrations for the datastore entity. properties: events: $ref: '#/components/schemas/EntityV3DatadogEvents' @@ -8337,16 +8337,16 @@ components: minLength: 1 type: string tier: - description: The importance of the queue + description: The importance of the queue. minLength: 1 type: string type: - description: The type of queue + description: The type of queue. type: string type: object EntityV3Service: additionalProperties: false - description: Schema for service entities + description: Schema for service entities. properties: apiVersion: $ref: '#/components/schemas/EntityV3APIVersion' @@ -8354,8 +8354,8 @@ components: $ref: '#/components/schemas/EntityV3ServiceDatadog' extensions: additionalProperties: {} - description: Custom extensions. This is the free-formed field to send client - side metadata. No Datadog features are affected by this field. + description: Custom extensions. This is the free-formed field to send client-side + metadata. No Datadog features are affected by this field. type: object integrations: $ref: '#/components/schemas/EntityV3Integrations' @@ -8372,7 +8372,7 @@ components: type: object EntityV3ServiceDatadog: additionalProperties: false - description: Datadog product integrations for the service entity + description: Datadog product integrations for the service entity. properties: codeLocations: $ref: '#/components/schemas/EntityV3DatadogCodeLocations' @@ -8398,7 +8398,7 @@ components: description: The definition of Entity V3 Service Spec object. properties: dependsOn: - description: A list of components the service depends on + description: A list of components the service depends on. items: type: string type: array @@ -8412,16 +8412,16 @@ components: minLength: 1 type: string tier: - description: The importance of the component + description: The importance of the component. minLength: 1 type: string type: - description: The type of service + description: The type of service. type: string type: object EntityV3System: additionalProperties: false - description: Schema for system entities + description: Schema for system entities. properties: apiVersion: $ref: '#/components/schemas/EntityV3APIVersion' @@ -8429,8 +8429,8 @@ components: $ref: '#/components/schemas/EntityV3SystemDatadog' extensions: additionalProperties: {} - description: Custom extensions. This is the free-formed field to send client - side metadata. No Datadog features are affected by this field. + description: Custom extensions. This is the free-formed field to send client-side + metadata. No Datadog features are affected by this field. type: object integrations: $ref: '#/components/schemas/EntityV3Integrations' @@ -8447,7 +8447,7 @@ components: type: object EntityV3SystemDatadog: additionalProperties: false - description: Datadog product integrations for the service entity + description: Datadog product integrations for the service entity. properties: events: $ref: '#/components/schemas/EntityV3DatadogEvents' @@ -12040,7 +12040,7 @@ components: - data type: object IncludeType: - description: supported include types. + description: Supported include types. enum: - schema - raw_schema @@ -12376,13 +12376,13 @@ components: description: List entity response links. properties: next: - description: next link. + description: Next link. type: string previous: - description: previous link. + description: Previous link. type: string self: - description: current link. + description: Current link. type: string type: object ListFindingsData: @@ -17792,7 +17792,7 @@ components: type: string type: object RelationType: - description: supported relation types + description: Supported relation types. enum: - RelationTypeOwns - RelationTypeOwnedBy @@ -17825,7 +17825,7 @@ components: description: Relationship entry. properties: id: - description: Associated data id. + description: Associated data ID. type: string type: description: Relationship type. @@ -24872,7 +24872,7 @@ components: $ref: '#/components/schemas/RuleType' type: object UpsertCatalogEntityRequest: - description: Create / Update entity request. + description: Create or update entity request. oneOf: - $ref: '#/components/schemas/EntityV3' - $ref: '#/components/schemas/EntityRaw' @@ -27540,7 +27540,7 @@ paths: application/json: schema: $ref: '#/components/schemas/UpsertCatalogEntityRequest' - description: Entity YAML/JSON. + description: Entity YAML or JSON. required: true responses: '202': @@ -41603,7 +41603,7 @@ tags: This feature is currently in BETA. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).' name: Service Scorecards -- description: API to create, update, retrieve and delete Software Catalog entities. +- description: API to create, update, retrieve, and delete Software Catalog entities. externalDocs: url: https://docs.datadoghq.com/service_catalog/service_definitions#metadata-schema-v30-beta name: Software Catalog diff --git a/api/datadogV2/api_software_catalog.go b/api/datadogV2/api_software_catalog.go index 4019cbbc3f4..2016ed8b9ec 100644 --- a/api/datadogV2/api_software_catalog.go +++ b/api/datadogV2/api_software_catalog.go @@ -81,13 +81,13 @@ func (a *SoftwareCatalogApi) DeleteCatalogEntity(ctx _context.Context, entityId type ListCatalogEntityOptionalParameters struct { PageOffset *int64 PageLimit *int64 - FitlerId *string - FitlerRef *string - FitlerName *string - FitlerKind *string - FitlerOwner *string - FitlerRelationType *RelationType - FitlerExcludeSnapshot *string + FilterId *string + FilterRef *string + FilterName *string + FilterKind *string + FilterOwner *string + FilterRelationType *RelationType + FilterExcludeSnapshot *string Include *IncludeType } @@ -109,45 +109,45 @@ func (r *ListCatalogEntityOptionalParameters) WithPageLimit(pageLimit int64) *Li return r } -// WithFitlerId sets the corresponding parameter name and returns the struct. -func (r *ListCatalogEntityOptionalParameters) WithFitlerId(fitlerId string) *ListCatalogEntityOptionalParameters { - r.FitlerId = &fitlerId +// WithFilterId sets the corresponding parameter name and returns the struct. +func (r *ListCatalogEntityOptionalParameters) WithFilterId(filterId string) *ListCatalogEntityOptionalParameters { + r.FilterId = &filterId return r } -// WithFitlerRef sets the corresponding parameter name and returns the struct. -func (r *ListCatalogEntityOptionalParameters) WithFitlerRef(fitlerRef string) *ListCatalogEntityOptionalParameters { - r.FitlerRef = &fitlerRef +// WithFilterRef sets the corresponding parameter name and returns the struct. +func (r *ListCatalogEntityOptionalParameters) WithFilterRef(filterRef string) *ListCatalogEntityOptionalParameters { + r.FilterRef = &filterRef return r } -// WithFitlerName sets the corresponding parameter name and returns the struct. -func (r *ListCatalogEntityOptionalParameters) WithFitlerName(fitlerName string) *ListCatalogEntityOptionalParameters { - r.FitlerName = &fitlerName +// WithFilterName sets the corresponding parameter name and returns the struct. +func (r *ListCatalogEntityOptionalParameters) WithFilterName(filterName string) *ListCatalogEntityOptionalParameters { + r.FilterName = &filterName return r } -// WithFitlerKind sets the corresponding parameter name and returns the struct. -func (r *ListCatalogEntityOptionalParameters) WithFitlerKind(fitlerKind string) *ListCatalogEntityOptionalParameters { - r.FitlerKind = &fitlerKind +// WithFilterKind sets the corresponding parameter name and returns the struct. +func (r *ListCatalogEntityOptionalParameters) WithFilterKind(filterKind string) *ListCatalogEntityOptionalParameters { + r.FilterKind = &filterKind return r } -// WithFitlerOwner sets the corresponding parameter name and returns the struct. -func (r *ListCatalogEntityOptionalParameters) WithFitlerOwner(fitlerOwner string) *ListCatalogEntityOptionalParameters { - r.FitlerOwner = &fitlerOwner +// WithFilterOwner sets the corresponding parameter name and returns the struct. +func (r *ListCatalogEntityOptionalParameters) WithFilterOwner(filterOwner string) *ListCatalogEntityOptionalParameters { + r.FilterOwner = &filterOwner return r } -// WithFitlerRelationType sets the corresponding parameter name and returns the struct. -func (r *ListCatalogEntityOptionalParameters) WithFitlerRelationType(fitlerRelationType RelationType) *ListCatalogEntityOptionalParameters { - r.FitlerRelationType = &fitlerRelationType +// WithFilterRelationType sets the corresponding parameter name and returns the struct. +func (r *ListCatalogEntityOptionalParameters) WithFilterRelationType(filterRelationType RelationType) *ListCatalogEntityOptionalParameters { + r.FilterRelationType = &filterRelationType return r } -// WithFitlerExcludeSnapshot sets the corresponding parameter name and returns the struct. -func (r *ListCatalogEntityOptionalParameters) WithFitlerExcludeSnapshot(fitlerExcludeSnapshot string) *ListCatalogEntityOptionalParameters { - r.FitlerExcludeSnapshot = &fitlerExcludeSnapshot +// WithFilterExcludeSnapshot sets the corresponding parameter name and returns the struct. +func (r *ListCatalogEntityOptionalParameters) WithFilterExcludeSnapshot(filterExcludeSnapshot string) *ListCatalogEntityOptionalParameters { + r.FilterExcludeSnapshot = &filterExcludeSnapshot return r } @@ -190,26 +190,26 @@ func (a *SoftwareCatalogApi) ListCatalogEntity(ctx _context.Context, o ...ListCa if optionalParams.PageLimit != nil { localVarQueryParams.Add("page[limit]", datadog.ParameterToString(*optionalParams.PageLimit, "")) } - if optionalParams.FitlerId != nil { - localVarQueryParams.Add("fitler[id]", datadog.ParameterToString(*optionalParams.FitlerId, "")) + if optionalParams.FilterId != nil { + localVarQueryParams.Add("filter[id]", datadog.ParameterToString(*optionalParams.FilterId, "")) } - if optionalParams.FitlerRef != nil { - localVarQueryParams.Add("fitler[ref]", datadog.ParameterToString(*optionalParams.FitlerRef, "")) + if optionalParams.FilterRef != nil { + localVarQueryParams.Add("filter[ref]", datadog.ParameterToString(*optionalParams.FilterRef, "")) } - if optionalParams.FitlerName != nil { - localVarQueryParams.Add("fitler[name]", datadog.ParameterToString(*optionalParams.FitlerName, "")) + if optionalParams.FilterName != nil { + localVarQueryParams.Add("filter[name]", datadog.ParameterToString(*optionalParams.FilterName, "")) } - if optionalParams.FitlerKind != nil { - localVarQueryParams.Add("fitler[kind]", datadog.ParameterToString(*optionalParams.FitlerKind, "")) + if optionalParams.FilterKind != nil { + localVarQueryParams.Add("filter[kind]", datadog.ParameterToString(*optionalParams.FilterKind, "")) } - if optionalParams.FitlerOwner != nil { - localVarQueryParams.Add("fitler[owner]", datadog.ParameterToString(*optionalParams.FitlerOwner, "")) + if optionalParams.FilterOwner != nil { + localVarQueryParams.Add("filter[owner]", datadog.ParameterToString(*optionalParams.FilterOwner, "")) } - if optionalParams.FitlerRelationType != nil { - localVarQueryParams.Add("fitler[relation][type]", datadog.ParameterToString(*optionalParams.FitlerRelationType, "")) + if optionalParams.FilterRelationType != nil { + localVarQueryParams.Add("filter[relation][type]", datadog.ParameterToString(*optionalParams.FilterRelationType, "")) } - if optionalParams.FitlerExcludeSnapshot != nil { - localVarQueryParams.Add("fitler[exclude_snapshot]", datadog.ParameterToString(*optionalParams.FitlerExcludeSnapshot, "")) + if optionalParams.FilterExcludeSnapshot != nil { + localVarQueryParams.Add("filter[exclude_snapshot]", datadog.ParameterToString(*optionalParams.FilterExcludeSnapshot, "")) } if optionalParams.Include != nil { localVarQueryParams.Add("include", datadog.ParameterToString(*optionalParams.Include, "")) diff --git a/api/datadogV2/model_entity_attributes.go b/api/datadogV2/model_entity_attributes.go index 21efd7101ab..f9a449220ba 100644 --- a/api/datadogV2/model_entity_attributes.go +++ b/api/datadogV2/model_entity_attributes.go @@ -10,7 +10,7 @@ import ( // EntityAttributes Entity attributes. type EntityAttributes struct { - // The api version. + // The API version. ApiVersion *string `json:"apiVersion,omitempty"` // The description. Description *string `json:"description,omitempty"` diff --git a/api/datadogV2/model_entity_data.go b/api/datadogV2/model_entity_data.go index 0642daf3537..2f2f2171ab7 100644 --- a/api/datadogV2/model_entity_data.go +++ b/api/datadogV2/model_entity_data.go @@ -12,7 +12,7 @@ import ( type EntityData struct { // Entity attributes. Attributes *EntityAttributes `json:"attributes,omitempty"` - // Entity id. + // Entity ID. Id *string `json:"id,omitempty"` // Entity metadata. Meta *EntityMeta `json:"meta,omitempty"` diff --git a/api/datadogV2/model_entity_response_included_incident.go b/api/datadogV2/model_entity_response_included_incident.go index d5b1b5a8499..fdb7bccc592 100644 --- a/api/datadogV2/model_entity_response_included_incident.go +++ b/api/datadogV2/model_entity_response_included_incident.go @@ -12,7 +12,7 @@ import ( type EntityResponseIncludedIncident struct { // Incident attributes. Attributes *EntityResponseIncludedRelatedIncidentAttributes `json:"attributes,omitempty"` - // Incident id. + // Incident ID. Id *string `json:"id,omitempty"` // Incident description. Type *string `json:"type,omitempty"` diff --git a/api/datadogV2/model_entity_response_included_raw_schema.go b/api/datadogV2/model_entity_response_included_raw_schema.go index f03987c95c2..0e15dc01cdf 100644 --- a/api/datadogV2/model_entity_response_included_raw_schema.go +++ b/api/datadogV2/model_entity_response_included_raw_schema.go @@ -12,7 +12,7 @@ import ( type EntityResponseIncludedRawSchema struct { // Included raw schema attributes. Attributes *EntityResponseIncludedRawSchemaAttributes `json:"attributes,omitempty"` - // Raw schema id. + // Raw schema ID. Id *string `json:"id,omitempty"` // Raw schema type. Type *string `json:"type,omitempty"` diff --git a/api/datadogV2/model_entity_response_included_related_oncall_attributes.go b/api/datadogV2/model_entity_response_included_related_oncall_attributes.go index 878da895f49..9a22c8cf4ed 100644 --- a/api/datadogV2/model_entity_response_included_related_oncall_attributes.go +++ b/api/datadogV2/model_entity_response_included_related_oncall_attributes.go @@ -10,7 +10,7 @@ import ( // EntityResponseIncludedRelatedOncallAttributes Included related oncall attributes. type EntityResponseIncludedRelatedOncallAttributes struct { - // Oncall escalations + // Oncall escalations. Escalations []EntityResponseIncludedRelatedOncallEscalationItem `json:"escalations,omitempty"` // Oncall provider. Provider *string `json:"provider,omitempty"` diff --git a/api/datadogV2/model_entity_response_included_related_oncall_escalation_item.go b/api/datadogV2/model_entity_response_included_related_oncall_escalation_item.go index d9e01a9e213..42301ce9bf2 100644 --- a/api/datadogV2/model_entity_response_included_related_oncall_escalation_item.go +++ b/api/datadogV2/model_entity_response_included_related_oncall_escalation_item.go @@ -8,7 +8,7 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// EntityResponseIncludedRelatedOncallEscalationItem Oncall escalation +// EntityResponseIncludedRelatedOncallEscalationItem Oncall escalation. type EntityResponseIncludedRelatedOncallEscalationItem struct { // Oncall email. Email *string `json:"email,omitempty"` diff --git a/api/datadogV2/model_entity_response_included_schema.go b/api/datadogV2/model_entity_response_included_schema.go index 1b3cacd5c07..1e141a24263 100644 --- a/api/datadogV2/model_entity_response_included_schema.go +++ b/api/datadogV2/model_entity_response_included_schema.go @@ -12,7 +12,7 @@ import ( type EntityResponseIncludedSchema struct { // Included schema. Attributes *EntityResponseIncludedSchemaAttributes `json:"attributes,omitempty"` - // Entity id. + // Entity ID. Id *string `json:"id,omitempty"` // Schema type. Type *string `json:"type,omitempty"` diff --git a/api/datadogV2/model_entity_v3_api_version.go b/api/datadogV2/model_entity_v3_api_version.go index 94823070cf5..f4381159384 100644 --- a/api/datadogV2/model_entity_v3_api_version.go +++ b/api/datadogV2/model_entity_v3_api_version.go @@ -10,7 +10,7 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// EntityV3APIVersion The schema version of entity type. The field is known as schema-version in the previous version +// EntityV3APIVersion The schema version of entity type. The field is known as schema-version in the previous version. type EntityV3APIVersion string // List of EntityV3APIVersion. diff --git a/api/datadogV2/model_entity_v3_datadog_code_location_item.go b/api/datadogV2/model_entity_v3_datadog_code_location_item.go index b1173a73426..414ad6b02f7 100644 --- a/api/datadogV2/model_entity_v3_datadog_code_location_item.go +++ b/api/datadogV2/model_entity_v3_datadog_code_location_item.go @@ -8,11 +8,11 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// EntityV3DatadogCodeLocationItem code location item. +// EntityV3DatadogCodeLocationItem Code location item. type EntityV3DatadogCodeLocationItem struct { - // The paths (glob) to the source code of the service + // The paths (glob) to the source code of the service. Paths []string `json:"paths,omitempty"` - // The repository path of the source code of the entity + // The repository path of the source code of the entity. RepositoryUrl *string `json:"repositoryURL,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_entity_v3_datadog_event_item.go b/api/datadogV2/model_entity_v3_datadog_event_item.go index 1001478f262..5cb5665dc3b 100644 --- a/api/datadogV2/model_entity_v3_datadog_event_item.go +++ b/api/datadogV2/model_entity_v3_datadog_event_item.go @@ -10,9 +10,9 @@ import ( // EntityV3DatadogEventItem Events association item. type EntityV3DatadogEventItem struct { - // The name of the query + // The name of the query. Name *string `json:"name,omitempty"` - // The query to run + // The query to run. Query *string `json:"query,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_entity_v3_datadog_integration_opsgenie.go b/api/datadogV2/model_entity_v3_datadog_integration_opsgenie.go index d9981918809..5ab1708372c 100644 --- a/api/datadogV2/model_entity_v3_datadog_integration_opsgenie.go +++ b/api/datadogV2/model_entity_v3_datadog_integration_opsgenie.go @@ -10,11 +10,11 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// EntityV3DatadogIntegrationOpsgenie An Opsgenie integration schema +// EntityV3DatadogIntegrationOpsgenie An Opsgenie integration schema. type EntityV3DatadogIntegrationOpsgenie struct { // The region for the Opsgenie integration. Region *string `json:"region,omitempty"` - // The service url for the Opsgenie integration. + // The service URL for the Opsgenie integration. ServiceUrl string `json:"serviceURL"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_entity_v3_datadog_integration_pagerduty.go b/api/datadogV2/model_entity_v3_datadog_integration_pagerduty.go index ecf91af390f..82d5f8db823 100644 --- a/api/datadogV2/model_entity_v3_datadog_integration_pagerduty.go +++ b/api/datadogV2/model_entity_v3_datadog_integration_pagerduty.go @@ -10,9 +10,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// EntityV3DatadogIntegrationPagerduty An PagerDuty integration schema +// EntityV3DatadogIntegrationPagerduty A PagerDuty integration schema. type EntityV3DatadogIntegrationPagerduty struct { - // The service url for the PagerDuty integration. + // The service URL for the PagerDuty integration. ServiceUrl string `json:"serviceURL"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_entity_v3_datadog_log_item.go b/api/datadogV2/model_entity_v3_datadog_log_item.go index 9d770ce51fb..df93f082794 100644 --- a/api/datadogV2/model_entity_v3_datadog_log_item.go +++ b/api/datadogV2/model_entity_v3_datadog_log_item.go @@ -8,11 +8,11 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// EntityV3DatadogLogItem log association item. +// EntityV3DatadogLogItem Log association item. type EntityV3DatadogLogItem struct { - // The name of the query + // The name of the query. Name *string `json:"name,omitempty"` - // The query to run + // The query to run. Query *string `json:"query,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_entity_v3_datadog_performance.go b/api/datadogV2/model_entity_v3_datadog_performance.go index 8386c8c73a3..35b5fe4d4ea 100644 --- a/api/datadogV2/model_entity_v3_datadog_performance.go +++ b/api/datadogV2/model_entity_v3_datadog_performance.go @@ -8,9 +8,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// EntityV3DatadogPerformance Performance stats association +// EntityV3DatadogPerformance Performance stats association. type EntityV3DatadogPerformance struct { - // A list of APM entity tags that associates the APM Stats data with the entity + // A list of APM entity tags that associates the APM Stats data with the entity. Tags []string `json:"tags,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_entity_v3_datadog_pipelines.go b/api/datadogV2/model_entity_v3_datadog_pipelines.go index df3d5c6bef9..317878bbcc0 100644 --- a/api/datadogV2/model_entity_v3_datadog_pipelines.go +++ b/api/datadogV2/model_entity_v3_datadog_pipelines.go @@ -8,9 +8,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// EntityV3DatadogPipelines CI Pipelines association +// EntityV3DatadogPipelines CI Pipelines association. type EntityV3DatadogPipelines struct { - // A list of CI Fingerprints that associate CI Pipelines with the entity + // A list of CI Fingerprints that associate CI Pipelines with the entity. Fingerprints []string `json:"fingerprints,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_entity_v3_datastore.go b/api/datadogV2/model_entity_v3_datastore.go index ddde9ad0235..c25eca08d16 100644 --- a/api/datadogV2/model_entity_v3_datastore.go +++ b/api/datadogV2/model_entity_v3_datastore.go @@ -10,15 +10,15 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// EntityV3Datastore Schema for datastore entities +// EntityV3Datastore Schema for datastore entities. type EntityV3Datastore struct { - // The schema version of entity type. The field is known as schema-version in the previous version + // The schema version of entity type. The field is known as schema-version in the previous version. ApiVersion EntityV3APIVersion `json:"apiVersion"` - // Datadog product integrations for the datastore entity + // Datadog product integrations for the datastore entity. Datadog *EntityV3DatastoreDatadog `json:"datadog,omitempty"` // Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field. Extensions map[string]interface{} `json:"extensions,omitempty"` - // A base schema for defining third party integrations + // A base schema for defining third-party integrations. Integrations *EntityV3Integrations `json:"integrations,omitempty"` // The definition of Entity V3 Datastore Kind object. Kind EntityV3DatastoreKind `json:"kind"` diff --git a/api/datadogV2/model_entity_v3_datastore_datadog.go b/api/datadogV2/model_entity_v3_datastore_datadog.go index ddfb9ec6144..64badbd8b1f 100644 --- a/api/datadogV2/model_entity_v3_datastore_datadog.go +++ b/api/datadogV2/model_entity_v3_datastore_datadog.go @@ -8,13 +8,13 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// EntityV3DatastoreDatadog Datadog product integrations for the datastore entity +// EntityV3DatastoreDatadog Datadog product integrations for the datastore entity. type EntityV3DatastoreDatadog struct { - // Events associations + // Events associations. Events []EntityV3DatadogEventItem `json:"events,omitempty"` - // Logs association + // Logs association. Logs []EntityV3DatadogLogItem `json:"logs,omitempty"` - // Performance stats association + // Performance stats association. PerformanceData *EntityV3DatadogPerformance `json:"performanceData,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_entity_v3_datastore_spec.go b/api/datadogV2/model_entity_v3_datastore_spec.go index ef31077de5f..66284bb3ab4 100644 --- a/api/datadogV2/model_entity_v3_datastore_spec.go +++ b/api/datadogV2/model_entity_v3_datastore_spec.go @@ -12,9 +12,9 @@ import ( type EntityV3DatastoreSpec struct { // The lifecycle state of the datastore. Lifecycle *string `json:"lifecycle,omitempty"` - // The importance of the datastore + // The importance of the datastore. Tier *string `json:"tier,omitempty"` - // The type of datastore + // The type of datastore. Type *string `json:"type,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_entity_v3_integrations.go b/api/datadogV2/model_entity_v3_integrations.go index 20b29322251..6d0041b18f3 100644 --- a/api/datadogV2/model_entity_v3_integrations.go +++ b/api/datadogV2/model_entity_v3_integrations.go @@ -8,11 +8,11 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// EntityV3Integrations A base schema for defining third party integrations +// EntityV3Integrations A base schema for defining third-party integrations. type EntityV3Integrations struct { - // An Opsgenie integration schema + // An Opsgenie integration schema. Opsgenie *EntityV3DatadogIntegrationOpsgenie `json:"opsgenie,omitempty"` - // An PagerDuty integration schema + // A PagerDuty integration schema. Pagerduty *EntityV3DatadogIntegrationPagerduty `json:"pagerduty,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_entity_v3_metadata.go b/api/datadogV2/model_entity_v3_metadata.go index e5a340c105b..eafb0a69841 100644 --- a/api/datadogV2/model_entity_v3_metadata.go +++ b/api/datadogV2/model_entity_v3_metadata.go @@ -12,29 +12,29 @@ import ( // EntityV3Metadata The definition of Entity V3 Metadata object. type EntityV3Metadata struct { - // The additional owners of the entity, usually a team + // The additional owners of the entity, usually a team. AdditionalOwners []EntityV3MetadataAdditionalOwnersItems `json:"additionalOwners,omitempty"` - // A list of contacts for the entity + // A list of contacts for the entity. Contacts []EntityV3MetadataContactsItems `json:"contacts,omitempty"` - // Short description of the entity. The UI can leverage the description for display + // Short description of the entity. The UI can leverage the description for display. Description *string `json:"description,omitempty"` - // User friendly name of the entity. The UI can leverage the display name for display + // User friendly name of the entity. The UI can leverage the display name for display. DisplayName *string `json:"displayName,omitempty"` // A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored. Id *string `json:"id,omitempty"` // The entity reference from which to inherit metadata InheritFrom *string `json:"inheritFrom,omitempty"` - // A list of links for the entity + // A list of links for the entity. Links []EntityV3MetadataLinksItems `json:"links,omitempty"` // A read-only set of Datadog managed attributes generated by Datadog. User supplied values are ignored. Managed map[string]interface{} `json:"managed,omitempty"` - // Unique name given to an entity under the kind/namespace + // Unique name given to an entity under the kind/namespace. Name string `json:"name"` - // Namespace is a part of unique identifier. It has a default value of 'default' + // Namespace is a part of unique identifier. It has a default value of 'default'. Namespace *string `json:"namespace,omitempty"` - // The owner of the entity, usually a team + // The owner of the entity, usually a team. Owner *EntityV3MetadataOwner `json:"owner,omitempty"` - // A set of custom tags + // A set of custom tags. Tags []string `json:"tags,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_entity_v3_metadata_additional_owners_items.go b/api/datadogV2/model_entity_v3_metadata_additional_owners_items.go index 00887642dab..4ccc8a223f0 100644 --- a/api/datadogV2/model_entity_v3_metadata_additional_owners_items.go +++ b/api/datadogV2/model_entity_v3_metadata_additional_owners_items.go @@ -12,9 +12,9 @@ import ( // EntityV3MetadataAdditionalOwnersItems The definition of Entity V3 Metadata Additional Owners Items object. type EntityV3MetadataAdditionalOwnersItems struct { - // Team name + // Team name. Name string `json:"name"` - // Team type + // Team type. Type *string `json:"type,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_entity_v3_metadata_contacts_items.go b/api/datadogV2/model_entity_v3_metadata_contacts_items.go index f1f61087a8b..d3c80437c1b 100644 --- a/api/datadogV2/model_entity_v3_metadata_contacts_items.go +++ b/api/datadogV2/model_entity_v3_metadata_contacts_items.go @@ -12,9 +12,9 @@ import ( // EntityV3MetadataContactsItems The definition of Entity V3 Metadata Contacts Items object. type EntityV3MetadataContactsItems struct { - // Contact value + // Contact value. Contact string `json:"contact"` - // Contact name + // Contact name. Name *string `json:"name,omitempty"` // Contact type. Type string `json:"type"` diff --git a/api/datadogV2/model_entity_v3_metadata_links_items.go b/api/datadogV2/model_entity_v3_metadata_links_items.go index 939f059167d..200f76f7a62 100644 --- a/api/datadogV2/model_entity_v3_metadata_links_items.go +++ b/api/datadogV2/model_entity_v3_metadata_links_items.go @@ -12,13 +12,13 @@ import ( // EntityV3MetadataLinksItems The definition of Entity V3 Metadata Links Items object. type EntityV3MetadataLinksItems struct { - // Link name + // Link name. Name string `json:"name"` // Link provider. Provider *string `json:"provider,omitempty"` // Link type. Type string `json:"type"` - // Link url + // Link URL. Url string `json:"url"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_entity_v3_metadata_owner.go b/api/datadogV2/model_entity_v3_metadata_owner.go index 8f55218fff9..4ae6a821f33 100644 --- a/api/datadogV2/model_entity_v3_metadata_owner.go +++ b/api/datadogV2/model_entity_v3_metadata_owner.go @@ -8,9 +8,9 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// EntityV3MetadataOwner The owner of the entity, usually a team +// EntityV3MetadataOwner The owner of the entity, usually a team. type EntityV3MetadataOwner struct { - // Team name + // Team name. Name *string `json:"name,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_entity_v3_queue.go b/api/datadogV2/model_entity_v3_queue.go index f8748e20bcc..40a33dc5987 100644 --- a/api/datadogV2/model_entity_v3_queue.go +++ b/api/datadogV2/model_entity_v3_queue.go @@ -10,15 +10,15 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// EntityV3Queue Schema for queue entities +// EntityV3Queue Schema for queue entities. type EntityV3Queue struct { - // The schema version of entity type. The field is known as schema-version in the previous version + // The schema version of entity type. The field is known as schema-version in the previous version. ApiVersion EntityV3APIVersion `json:"apiVersion"` - // Datadog product integrations for the datastore entity + // Datadog product integrations for the datastore entity. Datadog *EntityV3QueueDatadog `json:"datadog,omitempty"` - // Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field. + // Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field. Extensions map[string]interface{} `json:"extensions,omitempty"` - // A base schema for defining third party integrations + // A base schema for defining third-party integrations. Integrations *EntityV3Integrations `json:"integrations,omitempty"` // The definition of Entity V3 Queue Kind object. Kind EntityV3QueueKind `json:"kind"` diff --git a/api/datadogV2/model_entity_v3_queue_datadog.go b/api/datadogV2/model_entity_v3_queue_datadog.go index 0d7f5ed8fb9..a3d728c5365 100644 --- a/api/datadogV2/model_entity_v3_queue_datadog.go +++ b/api/datadogV2/model_entity_v3_queue_datadog.go @@ -8,13 +8,13 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// EntityV3QueueDatadog Datadog product integrations for the datastore entity +// EntityV3QueueDatadog Datadog product integrations for the datastore entity. type EntityV3QueueDatadog struct { - // Events associations + // Events associations. Events []EntityV3DatadogEventItem `json:"events,omitempty"` - // Logs association + // Logs association. Logs []EntityV3DatadogLogItem `json:"logs,omitempty"` - // Performance stats association + // Performance stats association. PerformanceData *EntityV3DatadogPerformance `json:"performanceData,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_entity_v3_queue_spec.go b/api/datadogV2/model_entity_v3_queue_spec.go index 7b197784346..313baebec06 100644 --- a/api/datadogV2/model_entity_v3_queue_spec.go +++ b/api/datadogV2/model_entity_v3_queue_spec.go @@ -12,9 +12,9 @@ import ( type EntityV3QueueSpec struct { // The lifecycle state of the queue. Lifecycle *string `json:"lifecycle,omitempty"` - // The importance of the queue + // The importance of the queue. Tier *string `json:"tier,omitempty"` - // The type of queue + // The type of queue. Type *string `json:"type,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_entity_v3_service.go b/api/datadogV2/model_entity_v3_service.go index b0aec5947ec..73d85f19b1d 100644 --- a/api/datadogV2/model_entity_v3_service.go +++ b/api/datadogV2/model_entity_v3_service.go @@ -10,15 +10,15 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// EntityV3Service Schema for service entities +// EntityV3Service Schema for service entities. type EntityV3Service struct { - // The schema version of entity type. The field is known as schema-version in the previous version + // The schema version of entity type. The field is known as schema-version in the previous version. ApiVersion EntityV3APIVersion `json:"apiVersion"` - // Datadog product integrations for the service entity + // Datadog product integrations for the service entity. Datadog *EntityV3ServiceDatadog `json:"datadog,omitempty"` - // Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field. + // Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field. Extensions map[string]interface{} `json:"extensions,omitempty"` - // A base schema for defining third party integrations + // A base schema for defining third-party integrations. Integrations *EntityV3Integrations `json:"integrations,omitempty"` // The definition of Entity V3 Service Kind object. Kind EntityV3ServiceKind `json:"kind"` diff --git a/api/datadogV2/model_entity_v3_service_datadog.go b/api/datadogV2/model_entity_v3_service_datadog.go index e3a2c8c04c3..1b5d6023498 100644 --- a/api/datadogV2/model_entity_v3_service_datadog.go +++ b/api/datadogV2/model_entity_v3_service_datadog.go @@ -8,17 +8,17 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// EntityV3ServiceDatadog Datadog product integrations for the service entity +// EntityV3ServiceDatadog Datadog product integrations for the service entity. type EntityV3ServiceDatadog struct { - // Schema for mapping source code locations to an entity + // Schema for mapping source code locations to an entity. CodeLocations []EntityV3DatadogCodeLocationItem `json:"codeLocations,omitempty"` - // Events associations + // Events associations. Events []EntityV3DatadogEventItem `json:"events,omitempty"` - // Logs association + // Logs association. Logs []EntityV3DatadogLogItem `json:"logs,omitempty"` - // Performance stats association + // Performance stats association. PerformanceData *EntityV3DatadogPerformance `json:"performanceData,omitempty"` - // CI Pipelines association + // CI Pipelines association. Pipelines *EntityV3DatadogPipelines `json:"pipelines,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_entity_v3_service_spec.go b/api/datadogV2/model_entity_v3_service_spec.go index 7ea0e7cfbdc..9bb33caa299 100644 --- a/api/datadogV2/model_entity_v3_service_spec.go +++ b/api/datadogV2/model_entity_v3_service_spec.go @@ -10,15 +10,15 @@ import ( // EntityV3ServiceSpec The definition of Entity V3 Service Spec object. type EntityV3ServiceSpec struct { - // A list of components the service depends on + // A list of components the service depends on. DependsOn []string `json:"dependsOn,omitempty"` // The service's programming language. Languages []string `json:"languages,omitempty"` // The lifecycle state of the component. Lifecycle *string `json:"lifecycle,omitempty"` - // The importance of the component + // The importance of the component. Tier *string `json:"tier,omitempty"` - // The type of service + // The type of service. Type *string `json:"type,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_entity_v3_system.go b/api/datadogV2/model_entity_v3_system.go index ba18e20bc90..2ff2aba3eff 100644 --- a/api/datadogV2/model_entity_v3_system.go +++ b/api/datadogV2/model_entity_v3_system.go @@ -10,15 +10,15 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// EntityV3System Schema for system entities +// EntityV3System Schema for system entities. type EntityV3System struct { - // The schema version of entity type. The field is known as schema-version in the previous version + // The schema version of entity type. The field is known as schema-version in the previous version. ApiVersion EntityV3APIVersion `json:"apiVersion"` - // Datadog product integrations for the service entity + // Datadog product integrations for the service entity. Datadog *EntityV3SystemDatadog `json:"datadog,omitempty"` - // Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field. + // Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field. Extensions map[string]interface{} `json:"extensions,omitempty"` - // A base schema for defining third party integrations + // A base schema for defining third-party integrations. Integrations *EntityV3Integrations `json:"integrations,omitempty"` // The definition of Entity V3 System Kind object. Kind EntityV3SystemKind `json:"kind"` diff --git a/api/datadogV2/model_entity_v3_system_datadog.go b/api/datadogV2/model_entity_v3_system_datadog.go index 340ba4c14f2..50964e13db3 100644 --- a/api/datadogV2/model_entity_v3_system_datadog.go +++ b/api/datadogV2/model_entity_v3_system_datadog.go @@ -8,15 +8,15 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// EntityV3SystemDatadog Datadog product integrations for the service entity +// EntityV3SystemDatadog Datadog product integrations for the service entity. type EntityV3SystemDatadog struct { - // Events associations + // Events associations. Events []EntityV3DatadogEventItem `json:"events,omitempty"` - // Logs association + // Logs association. Logs []EntityV3DatadogLogItem `json:"logs,omitempty"` - // Performance stats association + // Performance stats association. PerformanceData *EntityV3DatadogPerformance `json:"performanceData,omitempty"` - // CI Pipelines association + // CI Pipelines association. Pipelines *EntityV3DatadogPipelines `json:"pipelines,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_include_type.go b/api/datadogV2/model_include_type.go index 19a327e1882..8ce593af7b0 100644 --- a/api/datadogV2/model_include_type.go +++ b/api/datadogV2/model_include_type.go @@ -10,7 +10,7 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// IncludeType supported include types. +// IncludeType Supported include types. type IncludeType string // List of IncludeType. diff --git a/api/datadogV2/model_list_entity_catalog_response_links.go b/api/datadogV2/model_list_entity_catalog_response_links.go index f08b8983d64..82988f2face 100644 --- a/api/datadogV2/model_list_entity_catalog_response_links.go +++ b/api/datadogV2/model_list_entity_catalog_response_links.go @@ -10,11 +10,11 @@ import ( // ListEntityCatalogResponseLinks List entity response links. type ListEntityCatalogResponseLinks struct { - // next link. + // Next link. Next *string `json:"next,omitempty"` - // previous link. + // Previous link. Previous *string `json:"previous,omitempty"` - // current link. + // Current link. Self *string `json:"self,omitempty"` // UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct UnparsedObject map[string]interface{} `json:"-"` diff --git a/api/datadogV2/model_relation_type.go b/api/datadogV2/model_relation_type.go index fabd17b03b5..3d80e058f42 100644 --- a/api/datadogV2/model_relation_type.go +++ b/api/datadogV2/model_relation_type.go @@ -10,7 +10,7 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// RelationType supported relation types +// RelationType Supported relation types. type RelationType string // List of RelationType. diff --git a/api/datadogV2/model_relationship_item.go b/api/datadogV2/model_relationship_item.go index 2880de83610..9aabdb75fea 100644 --- a/api/datadogV2/model_relationship_item.go +++ b/api/datadogV2/model_relationship_item.go @@ -10,7 +10,7 @@ import ( // RelationshipItem Relationship entry. type RelationshipItem struct { - // Associated data id. + // Associated data ID. Id *string `json:"id,omitempty"` // Relationship type. Type *string `json:"type,omitempty"` diff --git a/api/datadogV2/model_upsert_catalog_entity_request.go b/api/datadogV2/model_upsert_catalog_entity_request.go index 222394bfa72..893626edd83 100644 --- a/api/datadogV2/model_upsert_catalog_entity_request.go +++ b/api/datadogV2/model_upsert_catalog_entity_request.go @@ -8,7 +8,7 @@ import ( "github.com/DataDog/datadog-api-client-go/v2/api/datadog" ) -// UpsertCatalogEntityRequest - Create / Update entity request. +// UpsertCatalogEntityRequest - Create or update entity request. type UpsertCatalogEntityRequest struct { EntityV3 *EntityV3 EntityRaw *string diff --git a/tests/scenarios/features/v2/software_catalog.feature b/tests/scenarios/features/v2/software_catalog.feature index e90278e3734..1dd3e479bb9 100644 --- a/tests/scenarios/features/v2/software_catalog.feature +++ b/tests/scenarios/features/v2/software_catalog.feature @@ -1,6 +1,6 @@ @endpoint(software-catalog) @endpoint(software-catalog-v2) Feature: Software Catalog - API to create, update, retrieve and delete Software Catalog entities. + API to create, update, retrieve, and delete Software Catalog entities. Background: Given a valid "apiKeyAuth" key in the system