Skip to content

Commit 5e54520

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Improve oncall schedule endpoint documentation (#3109)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent ebb6269 commit 5e54520

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
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:

src/main/java/com/datadog/api/client/v2/model/Shift.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
import java.util.Map;
1919
import java.util.Objects;
2020

21-
/** The definition of <code>Shift</code> object. */
21+
/** An on-call shift with its associated data and relationships. */
2222
@JsonPropertyOrder({Shift.JSON_PROPERTY_DATA, Shift.JSON_PROPERTY_INCLUDED})
2323
@jakarta.annotation.Generated(
2424
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
@@ -37,7 +37,7 @@ public Shift data(ShiftData data) {
3737
}
3838

3939
/**
40-
* The definition of <code>ShiftData</code> object.
40+
* Data for an on-call shift.
4141
*
4242
* @return data
4343
*/

src/main/java/com/datadog/api/client/v2/model/ShiftData.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
import java.util.Map;
1818
import java.util.Objects;
1919

20-
/** The definition of <code>ShiftData</code> object. */
20+
/** Data for an on-call shift. */
2121
@JsonPropertyOrder({
2222
ShiftData.JSON_PROPERTY_ATTRIBUTES,
2323
ShiftData.JSON_PROPERTY_ID,
@@ -55,7 +55,7 @@ public ShiftData attributes(ShiftDataAttributes attributes) {
5555
}
5656

5757
/**
58-
* The definition of <code>ShiftDataAttributes</code> object.
58+
* Attributes for an on-call shift.
5959
*
6060
* @return attributes
6161
*/
@@ -98,7 +98,7 @@ public ShiftData relationships(ShiftDataRelationships relationships) {
9898
}
9999

100100
/**
101-
* The definition of <code>ShiftDataRelationships</code> object.
101+
* Relationships for an on-call shift.
102102
*
103103
* @return relationships
104104
*/

src/main/java/com/datadog/api/client/v2/model/ShiftDataAttributes.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
import java.util.Map;
1818
import java.util.Objects;
1919

20-
/** The definition of <code>ShiftDataAttributes</code> object. */
20+
/** Attributes for an on-call shift. */
2121
@JsonPropertyOrder({ShiftDataAttributes.JSON_PROPERTY_END, ShiftDataAttributes.JSON_PROPERTY_START})
2222
@jakarta.annotation.Generated(
2323
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")

src/main/java/com/datadog/api/client/v2/model/ShiftDataRelationships.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
import java.util.Map;
1717
import java.util.Objects;
1818

19-
/** The definition of <code>ShiftDataRelationships</code> object. */
19+
/** Relationships for an on-call shift. */
2020
@JsonPropertyOrder({ShiftDataRelationships.JSON_PROPERTY_USER})
2121
@jakarta.annotation.Generated(
2222
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")

0 commit comments

Comments
 (0)