Skip to content

Commit 4ad4ee2

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Improve oncall schedule endpoint documentation (#2745)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 04d5967 commit 4ad4ee2

File tree

6 files changed

+13
-13
lines changed

6 files changed

+13
-13
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41720,7 +41720,7 @@ components:
4172041720
type: string
4172141721
type: object
4172241722
Shift:
41723-
description: The definition of `Shift` object.
41723+
description: An on-call shift with its associated data and relationships.
4172441724
example:
4172541725
data:
4172641726
attributes:
@@ -41751,7 +41751,7 @@ components:
4175141751
type: array
4175241752
type: object
4175341753
ShiftData:
41754-
description: The definition of `ShiftData` object.
41754+
description: Data for an on-call shift.
4175541755
properties:
4175641756
attributes:
4175741757
$ref: '#/components/schemas/ShiftDataAttributes'
@@ -41766,7 +41766,7 @@ components:
4176641766
- type
4176741767
type: object
4176841768
ShiftDataAttributes:
41769-
description: The definition of `ShiftDataAttributes` object.
41769+
description: Attributes for an on-call shift.
4177041770
properties:
4177141771
end:
4177241772
description: The end time of the shift.
@@ -41778,7 +41778,7 @@ components:
4177841778
type: string
4177941779
type: object
4178041780
ShiftDataRelationships:
41781-
description: The definition of `ShiftDataRelationships` object.
41781+
description: Relationships for an on-call shift.
4178241782
properties:
4178341783
user:
4178441784
$ref: '#/components/schemas/ShiftDataRelationshipsUser'
@@ -41825,7 +41825,7 @@ components:
4182541825
x-enum-varnames:
4182641826
- SHIFTS
4182741827
ShiftIncluded:
41828-
description: The definition of `ShiftIncluded` object.
41828+
description: Included data for shift operations.
4182941829
oneOf:
4183041830
- $ref: '#/components/schemas/ScheduleUser'
4183141831
SimpleMonitorUserTemplate:

packages/datadog-api-client-v2/models/Shift.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import { ShiftIncluded } from "./ShiftIncluded";
99
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
1010

1111
/**
12-
* The definition of `Shift` object.
12+
* An on-call shift with its associated data and relationships.
1313
*/
1414
export class Shift {
1515
/**
16-
* The definition of `ShiftData` object.
16+
* Data for an on-call shift.
1717
*/
1818
"data"?: ShiftData;
1919
/**

packages/datadog-api-client-v2/models/ShiftData.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,19 @@ import { ShiftDataType } from "./ShiftDataType";
1010
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
1111

1212
/**
13-
* The definition of `ShiftData` object.
13+
* Data for an on-call shift.
1414
*/
1515
export class ShiftData {
1616
/**
17-
* The definition of `ShiftDataAttributes` object.
17+
* Attributes for an on-call shift.
1818
*/
1919
"attributes"?: ShiftDataAttributes;
2020
/**
2121
* The `ShiftData` `id`.
2222
*/
2323
"id"?: string;
2424
/**
25-
* The definition of `ShiftDataRelationships` object.
25+
* Relationships for an on-call shift.
2626
*/
2727
"relationships"?: ShiftDataRelationships;
2828
/**

packages/datadog-api-client-v2/models/ShiftDataAttributes.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
88

99
/**
10-
* The definition of `ShiftDataAttributes` object.
10+
* Attributes for an on-call shift.
1111
*/
1212
export class ShiftDataAttributes {
1313
/**

packages/datadog-api-client-v2/models/ShiftDataRelationships.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { ShiftDataRelationshipsUser } from "./ShiftDataRelationshipsUser";
88
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
99

1010
/**
11-
* The definition of `ShiftDataRelationships` object.
11+
* Relationships for an on-call shift.
1212
*/
1313
export class ShiftDataRelationships {
1414
/**

packages/datadog-api-client-v2/models/ShiftIncluded.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { ScheduleUser } from "./ScheduleUser";
88
import { UnparsedObject } from "../../datadog-api-client-common/util";
99

1010
/**
11-
* The definition of `ShiftIncluded` object.
11+
* Included data for shift operations.
1212
*/
1313

1414
export type ShiftIncluded = ScheduleUser | UnparsedObject;

0 commit comments

Comments
 (0)