Skip to content

Commit f328df3

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Improve oncall schedule endpoint documentation (#3324)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 5e6a7e4 commit f328df3

6 files changed

Lines changed: 13 additions & 13 deletions

File tree

.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:

api/datadogV2/model_shift.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ import (
88
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
99
)
1010

11-
// Shift The definition of `Shift` object.
11+
// Shift An on-call shift with its associated data and relationships.
1212
type Shift struct {
13-
// The definition of `ShiftData` object.
13+
// Data for an on-call shift.
1414
Data *ShiftData `json:"data,omitempty"`
1515
// The `Shift` `included`.
1616
Included []ShiftIncluded `json:"included,omitempty"`

api/datadogV2/model_shift_data.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ import (
1010
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
1111
)
1212

13-
// ShiftData The definition of `ShiftData` object.
13+
// ShiftData Data for an on-call shift.
1414
type ShiftData struct {
15-
// The definition of `ShiftDataAttributes` object.
15+
// Attributes for an on-call shift.
1616
Attributes *ShiftDataAttributes `json:"attributes,omitempty"`
1717
// The `ShiftData` `id`.
1818
Id *string `json:"id,omitempty"`
19-
// The definition of `ShiftDataRelationships` object.
19+
// Relationships for an on-call shift.
2020
Relationships *ShiftDataRelationships `json:"relationships,omitempty"`
2121
// Indicates that the resource is of type 'shifts'.
2222
Type ShiftDataType `json:"type"`

api/datadogV2/model_shift_data_attributes.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
1111
)
1212

13-
// ShiftDataAttributes The definition of `ShiftDataAttributes` object.
13+
// ShiftDataAttributes Attributes for an on-call shift.
1414
type ShiftDataAttributes struct {
1515
// The end time of the shift.
1616
End *time.Time `json:"end,omitempty"`

api/datadogV2/model_shift_data_relationships.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import (
88
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
99
)
1010

11-
// ShiftDataRelationships The definition of `ShiftDataRelationships` object.
11+
// ShiftDataRelationships Relationships for an on-call shift.
1212
type ShiftDataRelationships struct {
1313
// Defines the relationship between a shift and the user who is working that shift.
1414
User *ShiftDataRelationshipsUser `json:"user,omitempty"`

api/datadogV2/model_shift_included.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import (
88
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
99
)
1010

11-
// ShiftIncluded - The definition of `ShiftIncluded` object.
11+
// ShiftIncluded - Included data for shift operations.
1212
type ShiftIncluded struct {
1313
ScheduleUser *ScheduleUser
1414

0 commit comments

Comments
 (0)