Skip to content

G
gitlab-ce
Commit 573dd0e8 authored by Sean Arnold's avatar Sean Arnold
Browse files
Options

Update description to include period 

- update docs
parent 3363230b
Show whitespace changes
Inline Side-by-side
Showing with 45 additions and 45 deletions
doc/api/graphql/reference/gitlab_schema.graphql
View file @ 573dd0e8
......@@ -15635,12 +15635,12 @@ type OncallParticipantType {
colorWeight: String
"""
ID of the on-call participant
ID of the on-call participant.
"""
id: IncidentManagementOncallParticipantID!
"""
The user who is participating
The user who is participating.
"""
user: User!
}
......@@ -15690,32 +15690,32 @@ input OncallRotationCreateInput {
clientMutationId: String
"""
The name of the on-call rotation
The name of the on-call rotation.
"""
name: String!
"""
The usernames of users participating in the on-call rotation
The usernames of users participating in the on-call rotation.
"""
participants: [OncallUserInputType!]!
"""
The project to create the on-call schedule in
The project to create the on-call schedule in.
"""
projectPath: ID!
"""
The rotation length of the on-call rotation
The rotation length of the on-call rotation.
"""
rotationLength: OncallRotationLengthInputType!
"""
The iid of the on-call schedule to create the on-call rotation in
The iid of the on-call schedule to create the on-call rotation in.
"""
scheduleIid: String!
"""
The start date and time of the on-call rotation, in the timezone of the on-call schedule
The start date and time of the on-call rotation, in the timezone of the on-call schedule.
"""
startsAt: OncallRotationDateInputType!
}
......@@ -15735,7 +15735,7 @@ type OncallRotationCreatePayload {
errors: [String!]!
"""
The on-call rotation
The on-call rotation.
"""
oncallRotation: IncidentManagementOncallRotation
}
......@@ -15745,12 +15745,12 @@ Date input type for on-call rotation
"""
input OncallRotationDateInputType {
"""
The date component of the date in YYYY-MM-DD format
The date component of the date in YYYY-MM-DD format.
"""
date: String!
"""
The time component of the date in 24hr HH:MM format
The time component of the date in 24hr HH:MM format.
"""
time: String!
}
......@@ -15760,12 +15760,12 @@ The rotation length of the on-call rotation
"""
input OncallRotationLengthInputType {
"""
The rotation length of the on-call rotation
The rotation length of the on-call rotation.
"""
length: Int!
"""
The unit of the rotation length of the on-call rotation
The unit of the rotation length of the on-call rotation.
"""
unit: OncallRotationUnitEnum!
}
......@@ -15950,7 +15950,7 @@ input OncallUserInputType {
colorWeight: DataVisualizationWeightEnum
"""
The username of the user to participate in the on-call rotation. i.e user_one
The username of the user to participate in the on-call rotation. i.e user_one.
"""
username: String!
}
......
doc/api/graphql/reference/gitlab_schema.json
View file @ 573dd0e8
......@@ -46446,7 +46446,7 @@
},
{
"name": "id",
"description": "ID of the on-call participant",
"description": "ID of the on-call participant.",
"args": [
],
......@@ -46464,7 +46464,7 @@
},
{
"name": "user",
"description": "The user who is participating",
"description": "The user who is participating.",
"args": [
],
......@@ -46608,7 +46608,7 @@
"inputFields": [
{
"name": "projectPath",
"description": "The project to create the on-call schedule in",
"description": "The project to create the on-call schedule in.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -46622,7 +46622,7 @@
},
{
"name": "scheduleIid",
"description": "The iid of the on-call schedule to create the on-call rotation in",
"description": "The iid of the on-call schedule to create the on-call rotation in.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -46636,7 +46636,7 @@
},
{
"name": "name",
"description": "The name of the on-call rotation",
"description": "The name of the on-call rotation.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -46650,7 +46650,7 @@
},
{
"name": "startsAt",
"description": "The start date and time of the on-call rotation, in the timezone of the on-call schedule",
"description": "The start date and time of the on-call rotation, in the timezone of the on-call schedule.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -46664,7 +46664,7 @@
},
{
"name": "rotationLength",
"description": "The rotation length of the on-call rotation",
"description": "The rotation length of the on-call rotation.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -46678,7 +46678,7 @@
},
{
"name": "participants",
"description": "The usernames of users participating in the on-call rotation",
"description": "The usernames of users participating in the on-call rotation.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -46760,7 +46760,7 @@
},
{
"name": "oncallRotation",
"description": "The on-call rotation",
"description": "The on-call rotation.",
"args": [
],
......@@ -46788,7 +46788,7 @@
"inputFields": [
{
"name": "date",
"description": "The date component of the date in YYYY-MM-DD format",
"description": "The date component of the date in YYYY-MM-DD format.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -46802,7 +46802,7 @@
},
{
"name": "time",
"description": "The time component of the date in 24hr HH:MM format",
"description": "The time component of the date in 24hr HH:MM format.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -46827,7 +46827,7 @@
"inputFields": [
{
"name": "length",
"description": "The rotation length of the on-call rotation",
"description": "The rotation length of the on-call rotation.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -46841,7 +46841,7 @@
},
{
"name": "unit",
"description": "The unit of the rotation length of the on-call rotation",
"description": "The unit of the rotation length of the on-call rotation.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -47297,7 +47297,7 @@
"inputFields": [
{
"name": "username",
"description": "The username of the user to participate in the on-call rotation. i.e user_one",
"description": "The username of the user to participate in the on-call rotation. i.e user_one.",
"type": {
"kind": "NON_NULL",
"name": null,
doc/api/graphql/reference/index.md
View file @ 573dd0e8
......@@ -2399,8 +2399,8 @@ The rotation participant and color palette.
| ----- | ---- | ----------- |
| `colorPalette` | String | The color palette to assign to the on-call user. For example "blue". |
| `colorWeight` | String | The color weight to assign to for the on-call user, for example "500". Max 4 chars. For easy identification of the user. |
| `id` | IncidentManagementOncallParticipantID! | ID of the on-call participant |
| `user` | User! | The user who is participating |
| `id` | IncidentManagementOncallParticipantID! | ID of the on-call participant. |
| `user` | User! | The user who is participating. |
### OncallRotationCreatePayload
......@@ -2410,7 +2410,7 @@ Autogenerated return type of OncallRotationCreate.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `oncallRotation` | IncidentManagementOncallRotation | The on-call rotation |
| `oncallRotation` | IncidentManagementOncallRotation | The on-call rotation. |
### OncallScheduleCreatePayload
......
ee/app/graphql/mutations/incident_management/oncall_rotation/base.rb
View file @ 573dd0e8
......@@ -7,7 +7,7 @@ module Mutations
field :oncall_rotation,
::Types::IncidentManagement::OncallRotationType,
null: true,
description: 'The on-call rotation'
description: 'The on-call rotation.'
authorize :admin_incident_management_oncall_schedule
......
ee/app/graphql/mutations/incident_management/oncall_rotation/create.rb
View file @ 573dd0e8
......@@ -10,29 +10,29 @@ module Mutations
argument :project_path, GraphQL::ID_TYPE,
required: true,
description: 'The project to create the on-call schedule in'
description: 'The project to create the on-call schedule in.'
argument :schedule_iid, GraphQL::STRING_TYPE,
required: true,
description: 'The iid of the on-call schedule to create the on-call rotation in',
description: 'The iid of the on-call schedule to create the on-call rotation in.',
as: :iid
argument :name, GraphQL::STRING_TYPE,
required: true,
description: 'The name of the on-call rotation'
description: 'The name of the on-call rotation.'
argument :starts_at, Types::IncidentManagement::OncallRotationDateInputType,
required: true,
description: 'The start date and time of the on-call rotation, in the timezone of the on-call schedule'
description: 'The start date and time of the on-call rotation, in the timezone of the on-call schedule.'
argument :rotation_length, Types::IncidentManagement::OncallRotationLengthInputType,
required: true,
description: 'The rotation length of the on-call rotation'
description: 'The rotation length of the on-call rotation.'
argument :participants,
[Types::IncidentManagement::OncallUserInputType],
required: true,
description: 'The usernames of users participating in the on-call rotation'
description: 'The usernames of users participating in the on-call rotation.'
MAXIMUM_PARTICIPANTS = 100
......
ee/app/graphql/types/incident_management/oncall_participant_type.rb
View file @ 573dd0e8
......@@ -10,11 +10,11 @@ module Types
field :id,
Types::GlobalIDType[::IncidentManagement::OncallParticipant],
null: false,
description: 'ID of the on-call participant'
description: 'ID of the on-call participant.'
field :user, Types::UserType,
null: false,
description: 'The user who is participating'
description: 'The user who is participating.'
field :color_palette, GraphQL::STRING_TYPE,
null: true,
......
ee/app/graphql/types/incident_management/oncall_rotation_date_input_type.rb
View file @ 573dd0e8
......@@ -9,11 +9,11 @@ module Types
argument :date, GraphQL::STRING_TYPE,
required: true,
description: 'The date component of the date in YYYY-MM-DD format'
description: 'The date component of the date in YYYY-MM-DD format.'
argument :time, GraphQL::STRING_TYPE,
required: true,
description: 'The time component of the date in 24hr HH:MM format'
description: 'The time component of the date in 24hr HH:MM format.'
DATE_FORMAT = %r[\d{4}-[0123]\d-\d{2}].freeze
TIME_FORMAT = %r[[012]\d:\d{2}].freeze
......
ee/app/graphql/types/incident_management/oncall_rotation_length_input_type.rb
View file @ 573dd0e8
......@@ -9,11 +9,11 @@ module Types
argument :length, GraphQL::INT_TYPE,
required: true,
description: 'The rotation length of the on-call rotation'
description: 'The rotation length of the on-call rotation.'
argument :unit, Types::IncidentManagement::OncallRotationLengthUnitEnum,
required: true,
description: 'The unit of the rotation length of the on-call rotation'
description: 'The unit of the rotation length of the on-call rotation.'
end
# rubocop: enable Graphql/AuthorizeTypes
end
......
ee/app/graphql/types/incident_management/oncall_user_input_type.rb
View file @ 573dd0e8
......@@ -9,7 +9,7 @@ module Types
argument :username, GraphQL::STRING_TYPE,
required: true,
description: 'The username of the user to participate in the on-call rotation. i.e user_one'
description: 'The username of the user to participate in the on-call rotation. i.e user_one.'
argument :color_palette, ::Types::DataVisualizationPalette::ColorEnum,
required: false,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7