Skip to content

Commit 5573c9c

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Improve oncall schedule endpoint documentation (#889)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 0e70568 commit 5573c9c

File tree

7 files changed

+21
-21
lines changed

7 files changed

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

LICENSE-3rdparty.csv

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ instant,https://github.com/sebcrozet/instant,BSD-3-Clause,sebcrozet <developer@c
7272
io-uring,https://github.com/tokio-rs/io-uring,MIT OR Apache-2.0,quininer <[email protected]>
7373
ipnet,https://github.com/krisprice/ipnet,MIT OR Apache-2.0,Kris Price <[email protected]>
7474
itoa,https://github.com/dtolnay/itoa,MIT OR Apache-2.0,David Tolnay <[email protected]>
75-
js-sys,https://github.com/rustwasm/wasm-bindgen/tree/master/crates/js-sys,MIT OR Apache-2.0,The wasm-bindgen Developers
75+
js-sys,https://github.com/wasm-bindgen/wasm-bindgen/tree/master/crates/js-sys,MIT OR Apache-2.0,The wasm-bindgen Developers
7676
lazy_static,https://github.com/rust-lang-nursery/lazy-static.rs,MIT OR Apache-2.0,Marvin Löbel <[email protected]>
7777
libc,https://github.com/rust-lang/libc,MIT OR Apache-2.0,The Rust Project Developers
7878
linux-raw-sys,https://github.com/sunfishcode/linux-raw-sys,Apache-2.0 WITH LLVM-exception OR Apache-2.0 OR MIT,Dan Gohman <[email protected]>
@@ -166,14 +166,14 @@ uuid-macro-internal,https://github.com/uuid-rs/uuid,Apache-2.0 OR MIT,QnnOkabaya
166166
want,https://github.com/seanmonstar/want,MIT,Sean McArthur <[email protected]>
167167
wasi,https://github.com/bytecodealliance/wasi,Apache-2.0 WITH LLVM-exception OR Apache-2.0 OR MIT,The Cranelift Project Developers
168168
wasi,https://github.com/bytecodealliance/wasi-rs,Apache-2.0 WITH LLVM-exception OR Apache-2.0 OR MIT,The Cranelift Project Developers
169-
wasm-bindgen,https://github.com/rustwasm/wasm-bindgen,MIT OR Apache-2.0,The wasm-bindgen Developers
170-
wasm-bindgen-backend,https://github.com/rustwasm/wasm-bindgen/tree/master/crates/backend,MIT OR Apache-2.0,The wasm-bindgen Developers
171-
wasm-bindgen-futures,https://github.com/rustwasm/wasm-bindgen/tree/master/crates/futures,MIT OR Apache-2.0,The wasm-bindgen Developers
172-
wasm-bindgen-macro,https://github.com/rustwasm/wasm-bindgen/tree/master/crates/macro,MIT OR Apache-2.0,The wasm-bindgen Developers
173-
wasm-bindgen-macro-support,https://github.com/rustwasm/wasm-bindgen/tree/master/crates/macro-support,MIT OR Apache-2.0,The wasm-bindgen Developers
174-
wasm-bindgen-shared,https://github.com/rustwasm/wasm-bindgen/tree/master/crates/shared,MIT OR Apache-2.0,The wasm-bindgen Developers
169+
wasm-bindgen,https://github.com/wasm-bindgen/wasm-bindgen,MIT OR Apache-2.0,The wasm-bindgen Developers
170+
wasm-bindgen-backend,https://github.com/wasm-bindgen/wasm-bindgen/tree/master/crates/backend,MIT OR Apache-2.0,The wasm-bindgen Developers
171+
wasm-bindgen-futures,https://github.com/wasm-bindgen/wasm-bindgen/tree/master/crates/futures,MIT OR Apache-2.0,The wasm-bindgen Developers
172+
wasm-bindgen-macro,https://github.com/wasm-bindgen/wasm-bindgen/tree/master/crates/macro,MIT OR Apache-2.0,The wasm-bindgen Developers
173+
wasm-bindgen-macro-support,https://github.com/wasm-bindgen/wasm-bindgen/tree/master/crates/macro-support,MIT OR Apache-2.0,The wasm-bindgen Developers
174+
wasm-bindgen-shared,https://github.com/wasm-bindgen/wasm-bindgen/tree/master/crates/shared,MIT OR Apache-2.0,The wasm-bindgen Developers
175175
wasm-timer,https://github.com/tomaka/wasm-timer,MIT,Pierre Krieger <[email protected]>
176-
web-sys,https://github.com/rustwasm/wasm-bindgen/tree/master/crates/web-sys,MIT OR Apache-2.0,The wasm-bindgen Developers
176+
web-sys,https://github.com/wasm-bindgen/wasm-bindgen/tree/master/crates/web-sys,MIT OR Apache-2.0,The wasm-bindgen Developers
177177
winapi,https://github.com/retep998/winapi-rs,MIT OR Apache-2.0,Peter Atashian <[email protected]>
178178
winapi-i686-pc-windows-gnu,https://github.com/retep998/winapi-rs,MIT OR Apache-2.0,Peter Atashian <[email protected]>
179179
winapi-x86_64-pc-windows-gnu,https://github.com/retep998/winapi-rs,MIT OR Apache-2.0,Peter Atashian <[email protected]>

src/datadogV2/model/model_shift.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ use serde::{Deserialize, Deserializer, Serialize};
66
use serde_with::skip_serializing_none;
77
use std::fmt::{self, Formatter};
88

9-
/// The definition of `Shift` object.
9+
/// An on-call shift with its associated data and relationships.
1010
#[non_exhaustive]
1111
#[skip_serializing_none]
1212
#[derive(Clone, Debug, PartialEq, Serialize)]
1313
pub struct Shift {
14-
/// The definition of `ShiftData` object.
14+
/// Data for an on-call shift.
1515
#[serde(rename = "data")]
1616
pub data: Option<crate::datadogV2::model::ShiftData>,
1717
/// The `Shift` `included`.

src/datadogV2/model/model_shift_data.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ use serde::{Deserialize, Deserializer, Serialize};
66
use serde_with::skip_serializing_none;
77
use std::fmt::{self, Formatter};
88

9-
/// The definition of `ShiftData` object.
9+
/// Data for an on-call shift.
1010
#[non_exhaustive]
1111
#[skip_serializing_none]
1212
#[derive(Clone, Debug, PartialEq, Serialize)]
1313
pub struct ShiftData {
14-
/// The definition of `ShiftDataAttributes` object.
14+
/// Attributes for an on-call shift.
1515
#[serde(rename = "attributes")]
1616
pub attributes: Option<crate::datadogV2::model::ShiftDataAttributes>,
1717
/// The `ShiftData` `id`.
1818
#[serde(rename = "id")]
1919
pub id: Option<String>,
20-
/// The definition of `ShiftDataRelationships` object.
20+
/// Relationships for an on-call shift.
2121
#[serde(rename = "relationships")]
2222
pub relationships: Option<crate::datadogV2::model::ShiftDataRelationships>,
2323
/// Indicates that the resource is of type 'shifts'.

src/datadogV2/model/model_shift_data_attributes.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ use serde::{Deserialize, Deserializer, Serialize};
66
use serde_with::skip_serializing_none;
77
use std::fmt::{self, Formatter};
88

9-
/// The definition of `ShiftDataAttributes` object.
9+
/// Attributes for an on-call shift.
1010
#[non_exhaustive]
1111
#[skip_serializing_none]
1212
#[derive(Clone, Debug, PartialEq, Serialize)]

src/datadogV2/model/model_shift_data_relationships.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ use serde::{Deserialize, Deserializer, Serialize};
66
use serde_with::skip_serializing_none;
77
use std::fmt::{self, Formatter};
88

9-
/// The definition of `ShiftDataRelationships` object.
9+
/// Relationships for an on-call shift.
1010
#[non_exhaustive]
1111
#[skip_serializing_none]
1212
#[derive(Clone, Debug, PartialEq, Serialize)]

src/datadogV2/model/model_shift_included.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// Copyright 2019-Present Datadog, Inc.
44
use serde::{Deserialize, Deserializer, Serialize};
55

6-
/// The definition of `ShiftIncluded` object.
6+
/// Included data for shift operations.
77
#[non_exhaustive]
88
#[derive(Clone, Debug, PartialEq, Serialize)]
99
#[serde(untagged)]

0 commit comments

Comments
 (0)