Skip to content

Improve oncall schedule endpoint documentation #3109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 5, 2025
Merged

Improve oncall schedule endpoint documentation #3109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41720,7 +41720,7 @@ components:
type: string
type: object
Shift:
description: The definition of `Shift` object.
description: An on-call shift with its associated data and relationships.
example:
data:
attributes:
Expand Down Expand Up @@ -41751,7 +41751,7 @@ components:
type: array
type: object
ShiftData:
description: The definition of `ShiftData` object.
description: Data for an on-call shift.
properties:
attributes:
$ref: '#/components/schemas/ShiftDataAttributes'
Expand All @@ -41766,7 +41766,7 @@ components:
- type
type: object
ShiftDataAttributes:
description: The definition of `ShiftDataAttributes` object.
description: Attributes for an on-call shift.
properties:
end:
description: The end time of the shift.
Expand All @@ -41778,7 +41778,7 @@ components:
type: string
type: object
ShiftDataRelationships:
description: The definition of `ShiftDataRelationships` object.
description: Relationships for an on-call shift.
properties:
user:
$ref: '#/components/schemas/ShiftDataRelationshipsUser'
Expand Down Expand Up @@ -41825,7 +41825,7 @@ components:
x-enum-varnames:
- SHIFTS
ShiftIncluded:
description: The definition of `ShiftIncluded` object.
description: Included data for shift operations.
oneOf:
- $ref: '#/components/schemas/ScheduleUser'
SimpleMonitorUserTemplate:
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/com/datadog/api/client/v2/model/Shift.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import java.util.Map;
import java.util.Objects;

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

/**
* The definition of <code>ShiftData</code> object.
* Data for an on-call shift.
*
* @return data
*/
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/com/datadog/api/client/v2/model/ShiftData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import java.util.Map;
import java.util.Objects;

/** The definition of <code>ShiftData</code> object. */
/** Data for an on-call shift. */
@JsonPropertyOrder({
ShiftData.JSON_PROPERTY_ATTRIBUTES,
ShiftData.JSON_PROPERTY_ID,
Expand Down Expand Up @@ -55,7 +55,7 @@ public ShiftData attributes(ShiftDataAttributes attributes) {
}

/**
* The definition of <code>ShiftDataAttributes</code> object.
* Attributes for an on-call shift.
*
* @return attributes
*/
Expand Down Expand Up @@ -98,7 +98,7 @@ public ShiftData relationships(ShiftDataRelationships relationships) {
}

/**
* The definition of <code>ShiftDataRelationships</code> object.
* Relationships for an on-call shift.
*
* @return relationships
*/
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/datadog/api/client/v2/model/ShiftDataAttributes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import java.util.Map;
import java.util.Objects;

/** The definition of <code>ShiftDataAttributes</code> object. */
/** Attributes for an on-call shift. */
@JsonPropertyOrder({ShiftDataAttributes.JSON_PROPERTY_END, ShiftDataAttributes.JSON_PROPERTY_START})
@jakarta.annotation.Generated(
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/datadog/api/client/v2/model/ShiftDataRelationships.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import java.util.Map;
import java.util.Objects;

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