Skip to content

Commit 8b29911

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Improve oncall schedule endpoint documentation (#2644)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 132d7fd commit 8b29911

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:

lib/datadog_api_client/v2/models/shift.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
# The definition of `Shift` object.
20+
# An on-call shift with its associated data and relationships.
2121
class Shift
2222
include BaseGenericModel
2323

24-
# The definition of `ShiftData` object.
24+
# Data for an on-call shift.
2525
attr_accessor :data
2626

2727
# The `Shift` `included`.

lib/datadog_api_client/v2/models/shift_data.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
# The definition of `ShiftData` object.
20+
# Data for an on-call shift.
2121
class ShiftData
2222
include BaseGenericModel
2323

24-
# The definition of `ShiftDataAttributes` object.
24+
# Attributes for an on-call shift.
2525
attr_accessor :attributes
2626

2727
# The `ShiftData` `id`.
2828
attr_accessor :id
2929

30-
# The definition of `ShiftDataRelationships` object.
30+
# Relationships for an on-call shift.
3131
attr_accessor :relationships
3232

3333
# Indicates that the resource is of type 'shifts'.

lib/datadog_api_client/v2/models/shift_data_attributes.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
# The definition of `ShiftDataAttributes` object.
20+
# Attributes for an on-call shift.
2121
class ShiftDataAttributes
2222
include BaseGenericModel
2323

lib/datadog_api_client/v2/models/shift_data_relationships.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
# The definition of `ShiftDataRelationships` object.
20+
# Relationships for an on-call shift.
2121
class ShiftDataRelationships
2222
include BaseGenericModel
2323

lib/datadog_api_client/v2/models/shift_included.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V2
20-
# The definition of `ShiftIncluded` object.
20+
# Included data for shift operations.
2121
module ShiftIncluded
2222
class << self
2323
include BaseOneOfModel

0 commit comments

Comments
 (0)