diff --git a/.apigentools-info b/.apigentools-info index a8220bd03f676..b7d9beaff5ae3 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2025-04-22 18:30:05.951046", - "spec_repo_commit": "2b6fa951" + "regenerated": "2025-04-24 13:40:52.400928", + "spec_repo_commit": "4295fd1a" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2025-04-22 18:30:14.967308", - "spec_repo_commit": "2b6fa951" + "regenerated": "2025-04-24 13:41:01.298481", + "spec_repo_commit": "4295fd1a" } } } \ No newline at end of file diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index ad58138e02799..72f08d0025615 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -7478,7 +7478,7 @@ menu: - CreateOnCallSchedule unstable: [] order: 1 - - name: Update on call escalation policy + - name: Update on-call escalation policy url: '#update-on-call-escalation-policy' identifier: on-call-update-on-call-escalation-policy parent: on-call @@ -7490,7 +7490,7 @@ menu: - UpdateOnCallEscalationPolicy unstable: [] order: 6 - - name: Get on call escalation policy + - name: Get on-call escalation policy url: '#get-on-call-escalation-policy' identifier: on-call-get-on-call-escalation-policy parent: on-call @@ -7502,7 +7502,7 @@ menu: - GetOnCallEscalationPolicy unstable: [] order: 7 - - name: Delete on call escalation policy + - name: Delete on-call escalation policy url: '#delete-on-call-escalation-policy' identifier: on-call-delete-on-call-escalation-policy parent: on-call @@ -7514,7 +7514,7 @@ menu: - DeleteOnCallEscalationPolicy unstable: [] order: 8 - - name: Create on call escalation policy + - name: Create on-call escalation policy url: '#create-on-call-escalation-policy' identifier: on-call-create-on-call-escalation-policy parent: on-call diff --git a/content/en/api/v2/on-call/examples.json b/content/en/api/v2/on-call/examples.json index 358d946560055..e813a5ebfb38c 100644 --- a/content/en/api/v2/on-call/examples.json +++ b/content/en/api/v2/on-call/examples.json @@ -10,7 +10,7 @@ "resolve_page_on_policy_end": false, "retries": "integer" }, - "id": "string", + "id": "ab000000-0000-0000-0000-000000000000", "relationships": { "steps": { "data": [ @@ -182,7 +182,7 @@ "resolve_page_on_policy_end": false, "retries": "integer" }, - "id": "string", + "id": "ab000000-0000-0000-0000-000000000000", "relationships": { "steps": { "data": [ @@ -265,7 +265,7 @@ "resolve_page_on_policy_end": false, "retries": "integer" }, - "id": "string", + "id": "ab000000-0000-0000-0000-000000000000", "relationships": { "steps": { "data": [ @@ -542,7 +542,7 @@ "type": "schedules" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The core data wrapper for creating a schedule, encompassing attributes, relationships, and the resource type.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Describes the main attributes for creating a new schedule, including name, layers, time zone, and tags.

\n
\n
\n
\n
\n
\n

layers [required]

\n
\n

[object]

\n

The layers of on-call coverage that define rotation intervals and restrictions.

\n
\n
\n
\n
\n
\n

effective_date [required]

\n
\n

date-time

\n

The date/time when this layer becomes active (in ISO 8601).

\n
\n \n
\n
\n
\n
\n
\n

end_date

\n
\n

date-time

\n

The date/time after which this layer no longer applies (in ISO 8601).

\n
\n \n
\n
\n
\n
\n
\n

interval [required]

\n
\n

object

\n

Defines how frequently the rotation repeats, using days and/or seconds (up to certain limits).

\n
\n
\n
\n
\n
\n

days

\n
\n

int32

\n

The number of full days in each rotation period.

\n
\n \n
\n
\n
\n
\n
\n

seconds

\n
\n

int64

\n

Extra seconds that may be added to extend the rotation beyond whole days.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

members [required]

\n
\n

[object]

\n

A list of members who participate in this layer's rotation.

\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Identifies the user participating in this layer as a single object with an id.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The user's ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of this layer.

\n
\n \n
\n
\n
\n
\n
\n

restrictions

\n
\n

[object]

\n

Zero or more time-based restrictions (for example, only weekdays, during business hours).

\n
\n
\n
\n
\n
\n

end_day

\n
\n

enum

\n

The weekday when the restriction period ends (Monday through Sunday). \nAllowed enum values: monday,tuesday,wednesday,thursday,friday,saturday,sunday

\n
\n \n
\n
\n
\n
\n
\n

end_time

\n
\n

string

\n

The time of day when the restriction ends (hh:mm:ss).

\n
\n \n
\n
\n
\n
\n
\n

start_day

\n
\n

enum

\n

The weekday when the restriction period starts (Monday through Sunday). \nAllowed enum values: monday,tuesday,wednesday,thursday,friday,saturday,sunday

\n
\n \n
\n
\n
\n
\n
\n

start_time

\n
\n

string

\n

The time of day when the restriction begins (hh:mm:ss).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rotation_start [required]

\n
\n

date-time

\n

The date/time when the rotation for this layer starts (in ISO 8601).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

A human-readable name for the new schedule.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of tags for categorizing or filtering the schedule.

\n
\n \n
\n
\n
\n
\n
\n

time_zone [required]

\n
\n

string

\n

The time zone in which the schedule is defined.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Gathers relationship objects for the schedule creation request, including the teams to associate.

\n
\n
\n
\n
\n
\n

teams

\n
\n

object

\n

Associates the new schedule with one or more teams.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of team references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier for the team.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Schedules resource type. \nAllowed enum values: schedules

default: schedules

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The core data wrapper for creating a schedule, encompassing attributes, relationships, and the resource type.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Describes the main attributes for creating a new schedule, including name, layers, time zone, and tags.

\n
\n
\n
\n
\n
\n

layers [required]

\n
\n

[object]

\n

The layers of on-call coverage that define rotation intervals and restrictions.

\n
\n
\n
\n
\n
\n

effective_date [required]

\n
\n

date-time

\n

The date/time when this layer becomes active (in ISO 8601).

\n
\n \n
\n
\n
\n
\n
\n

end_date

\n
\n

date-time

\n

The date/time after which this layer no longer applies (in ISO 8601).

\n
\n \n
\n
\n
\n
\n
\n

interval [required]

\n
\n

object

\n

Defines how frequently the rotation repeats, using days and/or seconds (up to certain limits).

\n
\n
\n
\n
\n
\n

days

\n
\n

int32

\n

The number of full days in each rotation period.

\n
\n \n
\n
\n
\n
\n
\n

seconds

\n
\n

int64

\n

Extra seconds that may be added to extend the rotation beyond whole days.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

members [required]

\n
\n

[object]

\n

A list of members who participate in this layer's rotation.

\n
\n
\n
\n
\n
\n

user

\n
\n

object

\n

Identifies the user participating in this layer as a single object with an id.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The user's ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of this layer.

\n
\n \n
\n
\n
\n
\n
\n

restrictions

\n
\n

[object]

\n

Zero or more time-based restrictions (for example, only weekdays, during business hours).

\n
\n
\n
\n
\n
\n

end_day

\n
\n

enum

\n

The weekday when the restriction period ends (Monday through Sunday). \nAllowed enum values: monday,tuesday,wednesday,thursday,friday,saturday,sunday

\n
\n \n
\n
\n
\n
\n
\n

end_time

\n
\n

string

\n

The time of day when the restriction ends (hh:mm:ss).

\n
\n \n
\n
\n
\n
\n
\n

start_day

\n
\n

enum

\n

The weekday when the restriction period starts (Monday through Sunday). \nAllowed enum values: monday,tuesday,wednesday,thursday,friday,saturday,sunday

\n
\n \n
\n
\n
\n
\n
\n

start_time

\n
\n

string

\n

The time of day when the restriction begins (hh:mm:ss).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

rotation_start [required]

\n
\n

date-time

\n

The date/time when the rotation for this layer starts (in ISO 8601).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

A human-readable name for the new schedule.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of tags for categorizing or filtering the schedule.

\n
\n \n
\n
\n
\n
\n
\n

time_zone [required]

\n
\n

string

\n

The time zone in which the schedule is defined.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Gathers relationship objects for the schedule creation request, including the teams to associate.

\n
\n
\n
\n
\n
\n

teams

\n
\n

object

\n

Associates the new schedule with one or more teams.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

An array of team references for this schedule.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

A unique identifier for the team.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Teams resource type. \nAllowed enum values: teams

default: teams

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Schedules resource type. \nAllowed enum values: schedules

default: schedules

\n
\n \n
\n
\n
\n
" } }, "DeleteOnCallSchedule": { diff --git a/content/en/api/v2/on-call/request.UpdateOnCallEscalationPolicy.json b/content/en/api/v2/on-call/request.UpdateOnCallEscalationPolicy.json index 7b53a2f7dcc4e..89d7d8d18af9d 100644 --- a/content/en/api/v2/on-call/request.UpdateOnCallEscalationPolicy.json +++ b/content/en/api/v2/on-call/request.UpdateOnCallEscalationPolicy.json @@ -12,14 +12,14 @@ "id": "00000000-aba1-0000-0000-000000000000", "targets": [ { - "id": "c1d4eb9e-8bb0-974d-85a5-a7dd9db46bee", + "id": "string", "type": "users" } ] } ] }, - "id": "string", + "id": "ab000000-0000-0000-0000-000000000000", "relationships": { "teams": { "data": [ diff --git a/data/api/v2/CodeExamples.json b/data/api/v2/CodeExamples.json index caa23524eca01..e693c606ff67c 100644 --- a/data/api/v2/CodeExamples.json +++ b/data/api/v2/CodeExamples.json @@ -879,7 +879,7 @@ { "group": "on-call", "suffix": "", - "description": "Create on call escalation policy returns \"Created\" response" + "description": "Create on-call escalation policy returns \"Created\" response" } ], "CreateOnCallSchedule": [ @@ -893,7 +893,7 @@ { "group": "on-call", "suffix": "", - "description": "Update on call escalation policy returns \"OK\" response" + "description": "Update on-call escalation policy returns \"OK\" response" } ], "UpdateOnCallSchedule": [ diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index a9bf295b11428..0e624a109bf0c 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -12945,6 +12945,7 @@ components: $ref: '#/components/schemas/EscalationPolicyDataAttributes' id: description: Specifies the unique identifier of the escalation policy. + example: ab000000-0000-0000-0000-000000000000 type: string relationships: $ref: '#/components/schemas/EscalationPolicyDataRelationships' @@ -28662,6 +28663,7 @@ components: $ref: '#/components/schemas/ScheduleCreateRequestDataType' required: - type + - attributes type: object ScheduleCreateRequestDataAttributes: description: Describes the main attributes for creating a new schedule, including @@ -49819,7 +49821,7 @@ paths: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] - summary: Create on call escalation policy + summary: Create on-call escalation policy tags: - On-Call x-given: @@ -49878,7 +49880,7 @@ paths: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] - summary: Delete on call escalation policy + summary: Delete on-call escalation policy tags: - On-Call x-menu-order: 8 @@ -49922,7 +49924,7 @@ paths: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] - summary: Get on call escalation policy + summary: Get on-call escalation policy tags: - On-Call x-menu-order: 7 @@ -49972,7 +49974,7 @@ paths: - apiKeyAuth: [] appKeyAuth: [] - AuthZ: [] - summary: Update on call escalation policy + summary: Update on-call escalation policy tags: - On-Call x-menu-order: 6 diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index 176850710c78c..8a4c495a390cf 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -76739,6 +76739,7 @@ }, "id": { "description": "Specifies the unique identifier of the escalation policy.", + "example": "ab000000-0000-0000-0000-000000000000", "type": "string" }, "relationships": { @@ -77904,6 +77905,7 @@ }, "id": { "description": "Specifies the unique identifier of the escalation policy.", + "example": "ab000000-0000-0000-0000-000000000000", "type": "string" }, "relationships": { @@ -186930,7 +186932,8 @@ } }, "required": [ - "type" + "type", + "attributes" ], "type": "object" } @@ -187170,7 +187173,8 @@ } }, "required": [ - "type" + "type", + "attributes" ], "type": "object" }, @@ -377182,6 +377186,7 @@ }, "id": { "description": "Specifies the unique identifier of the escalation policy.", + "example": "ab000000-0000-0000-0000-000000000000", "type": "string" }, "relationships": { @@ -377734,7 +377739,7 @@ "AuthZ": [] } ], - "summary": "Create on call escalation policy", + "summary": "Create on-call escalation policy", "tags": [ "On-Call" ], @@ -377904,7 +377909,7 @@ "AuthZ": [] } ], - "summary": "Delete on call escalation policy", + "summary": "Delete on-call escalation policy", "tags": [ "On-Call" ], @@ -378055,6 +378060,7 @@ }, "id": { "description": "Specifies the unique identifier of the escalation policy.", + "example": "ab000000-0000-0000-0000-000000000000", "type": "string" }, "relationships": { @@ -378635,7 +378641,7 @@ "AuthZ": [] } ], - "summary": "Get on call escalation policy", + "summary": "Get on-call escalation policy", "tags": [ "On-Call" ], @@ -379007,6 +379013,7 @@ }, "id": { "description": "Specifies the unique identifier of the escalation policy.", + "example": "ab000000-0000-0000-0000-000000000000", "type": "string" }, "relationships": { @@ -379587,7 +379594,7 @@ "AuthZ": [] } ], - "summary": "Update on call escalation policy", + "summary": "Update on-call escalation policy", "tags": [ "On-Call" ], @@ -379896,7 +379903,8 @@ } }, "required": [ - "type" + "type", + "attributes" ], "type": "object" } diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index 25dec42cb739d..ef5f6727a383e 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -1277,21 +1277,21 @@ }, "CreateOnCallEscalationPolicy": { "description": "Create a new on-call escalation policy", - "summary": "Create on call escalation policy", + "summary": "Create on-call escalation policy", "request_description": "", "request_schema_description": "Represents a request to create a new escalation policy, including the policy data." }, "DeleteOnCallEscalationPolicy": { "description": "Delete an on-call escalation policy", - "summary": "Delete on call escalation policy" + "summary": "Delete on-call escalation policy" }, "GetOnCallEscalationPolicy": { "description": "Get an on-call escalation policy", - "summary": "Get on call escalation policy" + "summary": "Get on-call escalation policy" }, "UpdateOnCallEscalationPolicy": { "description": "Update an on-call escalation policy", - "summary": "Update on call escalation policy", + "summary": "Update on-call escalation policy", "request_description": "", "request_schema_description": "Represents a request to update an existing escalation policy, including the updated policy data." }, diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index 176850710c78c..8a4c495a390cf 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -76739,6 +76739,7 @@ }, "id": { "description": "Specifies the unique identifier of the escalation policy.", + "example": "ab000000-0000-0000-0000-000000000000", "type": "string" }, "relationships": { @@ -77904,6 +77905,7 @@ }, "id": { "description": "Specifies the unique identifier of the escalation policy.", + "example": "ab000000-0000-0000-0000-000000000000", "type": "string" }, "relationships": { @@ -186930,7 +186932,8 @@ } }, "required": [ - "type" + "type", + "attributes" ], "type": "object" } @@ -187170,7 +187173,8 @@ } }, "required": [ - "type" + "type", + "attributes" ], "type": "object" }, @@ -377182,6 +377186,7 @@ }, "id": { "description": "Specifies the unique identifier of the escalation policy.", + "example": "ab000000-0000-0000-0000-000000000000", "type": "string" }, "relationships": { @@ -377734,7 +377739,7 @@ "AuthZ": [] } ], - "summary": "Create on call escalation policy", + "summary": "Create on-call escalation policy", "tags": [ "On-Call" ], @@ -377904,7 +377909,7 @@ "AuthZ": [] } ], - "summary": "Delete on call escalation policy", + "summary": "Delete on-call escalation policy", "tags": [ "On-Call" ], @@ -378055,6 +378060,7 @@ }, "id": { "description": "Specifies the unique identifier of the escalation policy.", + "example": "ab000000-0000-0000-0000-000000000000", "type": "string" }, "relationships": { @@ -378635,7 +378641,7 @@ "AuthZ": [] } ], - "summary": "Get on call escalation policy", + "summary": "Get on-call escalation policy", "tags": [ "On-Call" ], @@ -379007,6 +379013,7 @@ }, "id": { "description": "Specifies the unique identifier of the escalation policy.", + "example": "ab000000-0000-0000-0000-000000000000", "type": "string" }, "relationships": { @@ -379587,7 +379594,7 @@ "AuthZ": [] } ], - "summary": "Update on call escalation policy", + "summary": "Update on-call escalation policy", "tags": [ "On-Call" ], @@ -379896,7 +379903,8 @@ } }, "required": [ - "type" + "type", + "attributes" ], "type": "object" }