Skip to content

Commit c3e3050

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

File tree

452 files changed

+4572
-170
lines changed

Some content is hidden

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

452 files changed

+4572
-170
lines changed

.generator/schemas/v2/openapi.yaml

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

services/apm/src/v2/models/ServiceList.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client";
22

33
import { ServiceListData } from "./ServiceListData";
44

5+
/**
6+
* The response body for the service list endpoint.
7+
*/
58
export class ServiceList {
9+
/**
10+
* A single data item in the service list response.
11+
*/
612
"data"?: ServiceListData;
713
/**
814
* A container for additional, undeclared properties.

services/apm/src/v2/models/ServiceListData.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client";
33
import { ServiceListDataAttributes } from "./ServiceListDataAttributes";
44
import { ServiceListDataType } from "./ServiceListDataType";
55

6+
/**
7+
* A single data item in the service list response.
8+
*/
69
export class ServiceListData {
10+
/**
11+
* Attributes of a service list entry, containing metadata and a list of service names.
12+
*/
713
"attributes"?: ServiceListDataAttributes;
14+
/**
15+
* The unique identifier of the service.
16+
*/
817
"id"?: string;
918
/**
1019
* Services list resource type.

services/apm/src/v2/models/ServiceListDataAttributes.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client";
22

33
import { ServiceListDataAttributesMetadataItems } from "./ServiceListDataAttributesMetadataItems";
44

5+
/**
6+
* Attributes of a service list entry, containing metadata and a list of service names.
7+
*/
58
export class ServiceListDataAttributes {
9+
/**
10+
* A list of metadata items associated with the service.
11+
*/
612
"metadata"?: Array<ServiceListDataAttributesMetadataItems>;
13+
/**
14+
* A list of service names.
15+
*/
716
"services"?: Array<string>;
817
/**
918
* A container for additional, undeclared properties.

services/apm/src/v2/models/ServiceListDataAttributesMetadataItems.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
11
import { AttributeTypeMap } from "@datadog/datadog-api-client";
22

3+
/**
4+
* An object containing metadata flags for a service, indicating whether it is traced by APM or monitored through Universal Service Monitoring.
5+
*/
36
export class ServiceListDataAttributesMetadataItems {
7+
/**
8+
* Indicates whether the service is traced by APM.
9+
*/
410
"isTraced"?: boolean;
11+
/**
12+
* Indicates whether the service uses Universal Service Monitoring.
13+
*/
514
"isUsm"?: boolean;
615
/**
716
* A container for additional, undeclared properties.

services/case_management/src/v2/CaseManagementApi.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4030,7 +4030,7 @@ export interface CaseManagementApiCreateCaseServiceNowTicketRequest {
40304030

40314031
export interface CaseManagementApiCreateProjectRequest {
40324032
/**
4033-
* Project payload
4033+
* Project payload.
40344034
* @type ProjectCreateRequest
40354035
*/
40364036
body: ProjectCreateRequest;
@@ -4077,7 +4077,7 @@ export interface CaseManagementApiDeleteCaseCustomAttributeRequest {
40774077

40784078
export interface CaseManagementApiDeleteProjectRequest {
40794079
/**
4080-
* Project UUID
4080+
* Project UUID.
40814081
* @type string
40824082
*/
40834083
projectId: string;
@@ -4106,7 +4106,7 @@ export interface CaseManagementApiGetCaseRequest {
41064106

41074107
export interface CaseManagementApiGetProjectRequest {
41084108
/**
4109-
* Project UUID
4109+
* Project UUID.
41104110
* @type string
41114111
*/
41124112
projectId: string;
@@ -4293,12 +4293,12 @@ export interface CaseManagementApiUpdatePriorityRequest {
42934293

42944294
export interface CaseManagementApiUpdateProjectRequest {
42954295
/**
4296-
* Project UUID
4296+
* Project UUID.
42974297
* @type string
42984298
*/
42994299
projectId: string;
43004300
/**
4301-
* Project payload
4301+
* Project payload.
43024302
* @type ProjectUpdateRequest
43034303
*/
43044304
body: ProjectUpdateRequest;

services/case_management/src/v2/models/AnyValueItem.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
import { UnparsedObject } from "@datadog/datadog-api-client";
22

3+
/**
4+
* A single item in an array of arbitrary values, which can be a string, number, object, or boolean.
5+
*/
36
export type AnyValueItem =
47
| string
58
| number

services/case_management/src/v2/models/AutoCloseInactiveCases.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
import { AttributeTypeMap } from "@datadog/datadog-api-client";
22

33
/**
4-
* Auto-close inactive cases settings
4+
* Auto-close inactive cases settings.
55
*/
66
export class AutoCloseInactiveCases {
77
/**
8-
* Whether auto-close is enabled
8+
* Whether auto-close is enabled.
99
*/
1010
"enabled"?: boolean;
1111
/**
12-
* Maximum inactive time in seconds before auto-closing
12+
* Maximum inactive time in seconds before auto-closing.
1313
*/
1414
"maxInactiveTimeInSecs"?: number;
1515
/**

services/case_management/src/v2/models/AutoTransitionAssignedCases.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
import { AttributeTypeMap } from "@datadog/datadog-api-client";
22

33
/**
4-
* Auto-transition assigned cases settings
4+
* Auto-transition assigned cases settings.
55
*/
66
export class AutoTransitionAssignedCases {
77
/**
8-
* Whether to auto-transition cases when self-assigned
8+
* Whether to auto-transition cases when self-assigned.
99
*/
1010
"autoTransitionAssignedCasesOnSelfAssigned"?: boolean;
1111
/**

services/case_management/src/v2/models/CaseCreateRelationships.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ export class CaseCreateRelationships {
1212
*/
1313
"assignee"?: NullableUserRelationship;
1414
/**
15-
* Relationship to project
15+
* Relationship to project.
1616
*/
1717
"project": ProjectRelationship;
1818
/**

0 commit comments

Comments
 (0)