Skip to content

G
gitlab-ce
Commit c397b417 authored by Amy Qualls's avatar Amy Qualls
Browse files
Options

Merge branch 'docs-aqualls-fix-graphql-definitions' into 'master' 

API descriptions: revise from 'to[-]dos' to 'to-do items'

See merge request gitlab-org/gitlab!53158
parents ca6cef2e c61cd206
Show whitespace changes
Inline Side-by-side
Showing with 136 additions and 136 deletions
app/graphql/mutations/alert_management/base.rb
View file @ c397b417
......@@ -21,7 +21,7 @@ module Mutations
field :todo,
Types::TodoType,
null: true,
description: "The todo after mutation."
description: "The to-do item after mutation."
field :issue,
Types::IssueType,
......
app/graphql/mutations/todos/create.rb
View file @ c397b417
......@@ -14,7 +14,7 @@ module Mutations
field :todo, Types::TodoType,
null: true,
description: 'The to-do created.'
description: 'The to-do item created.'
def resolve(target_id:)
id = ::Types::GlobalIDType[Todoable].coerce_isolated_input(target_id)
......
app/graphql/mutations/todos/mark_all_done.rb
View file @ c397b417
......@@ -10,12 +10,12 @@ module Mutations
field :updated_ids,
[::Types::GlobalIDType[::Todo]],
null: false,
deprecated: { reason: 'Use todos', milestone: '13.2' },
description: 'Ids of the updated todos.'
deprecated: { reason: 'Use to-do items', milestone: '13.2' },
description: 'IDs of the updated to-do items.'
field :todos, [::Types::TodoType],
null: false,
description: 'Updated todos.'
description: 'Updated to-do items.'
def resolve
authorize!(current_user)
......
app/graphql/mutations/todos/mark_done.rb
View file @ c397b417
......@@ -10,11 +10,11 @@ module Mutations
argument :id,
::Types::GlobalIDType[::Todo],
required: true,
description: 'The global ID of the to-do to mark as done.'
description: 'The global ID of the to-do item to mark as done.'
field :todo, Types::TodoType,
null: false,
description: 'The requested to-do.'
description: 'The requested to-do item.'
def resolve(id:)
todo = authorized_find!(id: id)
......
app/graphql/mutations/todos/restore.rb
View file @ c397b417
......@@ -10,11 +10,11 @@ module Mutations
argument :id,
::Types::GlobalIDType[::Todo],
required: true,
description: 'The global ID of the to-do to restore.'
description: 'The global ID of the to-do item to restore.'
field :todo, Types::TodoType,
null: false,
description: 'The requested to-do.'
description: 'The requested to-do item.'
def resolve(id:)
todo = authorized_find!(id: id)
......
app/graphql/mutations/todos/restore_many.rb
View file @ c397b417
......@@ -10,16 +10,16 @@ module Mutations
argument :ids,
[::Types::GlobalIDType[::Todo]],
required: true,
description: 'The global IDs of the to-dos to restore (a maximum of 50 is supported at once).'
description: 'The global IDs of the to-do items to restore (a maximum of 50 is supported at once).'
field :updated_ids, [::Types::GlobalIDType[Todo]],
null: false,
description: 'The IDs of the updated to-do items.',
deprecated: { reason: 'Use todos', milestone: '13.2' }
deprecated: { reason: 'Use to-do items', milestone: '13.2' }
field :todos, [::Types::TodoType],
null: false,
description: 'Updated to-dos.'
description: 'Updated to-do items.'
def resolve(ids:)
check_update_amount_limit!(ids)
......@@ -46,7 +46,7 @@ module Mutations
end
def raise_too_many_todos_requested_error
raise Gitlab::Graphql::Errors::ArgumentError, 'Too many to-dos requested.'
raise Gitlab::Graphql::Errors::ArgumentError, 'Too many to-do items requested.'
end
def check_update_amount_limit!(ids)
......
app/graphql/types/alert_management/alert_type.rb
View file @ c397b417
......@@ -112,7 +112,7 @@ module Types
field :todos,
Types::TodoType.connection_type,
null: true,
description: 'To-dos of the current user for the alert.',
description: 'To-do items of the current user for the alert.',
resolver: Resolvers::TodoResolver
field :details_url,
......
app/graphql/types/current_user_todos.rb
View file @ c397b417
......@@ -8,10 +8,10 @@ module Types
field_class Types::BaseField
field :current_user_todos, Types::TodoType.connection_type,
description: 'Todos for the current user.',
description: 'To-do items for the current user.',
null: false do
argument :state, Types::TodoStateEnum,
description: 'State of the todos.',
description: 'State of the to-do items.',
required: false
end
......
app/graphql/types/todo_type.rb
View file @ c397b417
......@@ -10,42 +10,42 @@ module Types
authorize :read_todo
field :id, GraphQL::ID_TYPE,
description: 'ID of the to-do',
description: 'ID of the to-do item',
null: false
field :project, Types::ProjectType,
description: 'The project this to-do is associated with',
description: 'The project this to-do item is associated with',
null: true,
authorize: :read_project
field :group, Types::GroupType,
description: 'Group this to-do is associated with',
description: 'Group this to-do item is associated with',
null: true,
authorize: :read_group
field :author, Types::UserType,
description: 'The author of this to-do',
description: 'The author of this to-do item',
null: false
field :action, Types::TodoActionEnum,
description: 'Action of the to-do',
description: 'Action of the to-do item',
null: false
field :target_type, Types::TodoTargetEnum,
description: 'Target type of the to-do',
description: 'Target type of the to-do item',
null: false
field :body, GraphQL::STRING_TYPE,
description: 'Body of the to-do',
description: 'Body of the to-do item',
null: false,
calls_gitaly: true # TODO This is only true when `target_type` is `Commit`. See https://gitlab.com/gitlab-org/gitlab/issues/34757#note_234752665
field :state, Types::TodoStateEnum,
description: 'State of the to-do',
description: 'State of the to-do item',
null: false
field :created_at, Types::TimeType,
description: 'Timestamp this to-do was created',
description: 'Timestamp this to-do item was created',
null: false
def project
......
app/graphql/types/user_type.rb
View file @ c397b417
......@@ -31,7 +31,7 @@ module Types
description: 'Web path of the user'
field :todos, Types::TodoType.connection_type, null: false,
resolver: Resolvers::TodoResolver,
description: 'Todos of the user'
description: 'To-do items of the user'
field :group_memberships, Types::GroupMemberType.connection_type, null: true,
description: 'Group memberships of the user'
field :group_count, GraphQL::INT_TYPE, null: true,
......
doc/api/graphql/reference/gitlab_schema.graphql
View file @ c397b417
......@@ -350,7 +350,7 @@ type AlertManagementAlert implements Noteable {
title: String
"""
To-dos of the current user for the alert.
To-do items of the current user for the alert.
"""
todos(
"""
......@@ -1017,7 +1017,7 @@ type AlertSetAssigneesPayload {
issue: Issue
"""
The todo after mutation.
The to-do item after mutation.
"""
todo: Todo
}
......@@ -1067,7 +1067,7 @@ type AlertTodoCreatePayload {
issue: Issue
"""
The todo after mutation.
The to-do item after mutation.
"""
todo: Todo
}
......@@ -1734,7 +1734,7 @@ type BoardEpic implements CurrentUserTodos & Noteable {
createdAt: Time
"""
Todos for the current user.
To-do items for the current user.
"""
currentUserTodos(
"""
......@@ -1758,7 +1758,7 @@ type BoardEpic implements CurrentUserTodos & Noteable {
last: Int
"""
State of the todos.
State of the to-do items.
"""
state: TodoStateEnum
): TodoConnection!
......@@ -4515,7 +4515,7 @@ type CreateAlertIssuePayload {
issue: Issue
"""
The todo after mutation.
The to-do item after mutation.
"""
todo: Todo
}
......@@ -5480,7 +5480,7 @@ type CreateTestCasePayload {
interface CurrentUserTodos {
"""
Todos for the current user.
To-do items for the current user.
"""
currentUserTodos(
"""
......@@ -5504,7 +5504,7 @@ interface CurrentUserTodos {
last: Int
"""
State of the todos.
State of the to-do items.
"""
state: TodoStateEnum
): TodoConnection!
......@@ -6622,7 +6622,7 @@ A single design
"""
type Design implements CurrentUserTodos & DesignFields & Noteable {
"""
Todos for the current user.
To-do items for the current user.
"""
currentUserTodos(
"""
......@@ -6646,7 +6646,7 @@ type Design implements CurrentUserTodos & DesignFields & Noteable {
last: Int
"""
State of the todos.
State of the to-do items.
"""
state: TodoStateEnum
): TodoConnection!
......@@ -8580,7 +8580,7 @@ type Epic implements CurrentUserTodos & Noteable {
createdAt: Time
"""
Todos for the current user.
To-do items for the current user.
"""
currentUserTodos(
"""
......@@ -8604,7 +8604,7 @@ type Epic implements CurrentUserTodos & Noteable {
last: Int
"""
State of the todos.
State of the to-do items.
"""
state: TodoStateEnum
): TodoConnection!
......@@ -9260,7 +9260,7 @@ type EpicIssue implements CurrentUserTodos & Noteable {
createdAt: Time!
"""
Todos for the current user.
To-do items for the current user.
"""
currentUserTodos(
"""
......@@ -9284,7 +9284,7 @@ type EpicIssue implements CurrentUserTodos & Noteable {
last: Int
"""
State of the todos.
State of the to-do items.
"""
state: TodoStateEnum
): TodoConnection!
......@@ -12471,7 +12471,7 @@ type Issue implements CurrentUserTodos & Noteable {
createdAt: Time!
"""
Todos for the current user.
To-do items for the current user.
"""
currentUserTodos(
"""
......@@ -12495,7 +12495,7 @@ type Issue implements CurrentUserTodos & Noteable {
last: Int
"""
State of the todos.
State of the to-do items.
"""
state: TodoStateEnum
): TodoConnection!
......@@ -14554,7 +14554,7 @@ type MergeRequest implements CurrentUserTodos & Noteable {
createdAt: Time!
"""
Todos for the current user.
To-do items for the current user.
"""
currentUserTodos(
"""
......@@ -14578,7 +14578,7 @@ type MergeRequest implements CurrentUserTodos & Noteable {
last: Int
"""
State of the todos.
State of the to-do items.
"""
state: TodoStateEnum
): TodoConnection!
......@@ -24925,47 +24925,47 @@ Representing a to-do entry
"""
type Todo {
"""
Action of the to-do
Action of the to-do item
"""
action: TodoActionEnum!
"""
The author of this to-do
The author of this to-do item
"""
author: User!
"""
Body of the to-do
Body of the to-do item
"""
body: String!
"""
Timestamp this to-do was created
Timestamp this to-do item was created
"""
createdAt: Time!
"""
Group this to-do is associated with
Group this to-do item is associated with
"""
group: Group
"""
ID of the to-do
ID of the to-do item
"""
id: ID!
"""
The project this to-do is associated with
The project this to-do item is associated with
"""
project: Project
"""
State of the to-do
State of the to-do item
"""
state: TodoStateEnum!
"""
Target type of the to-do
Target type of the to-do item
"""
targetType: TodoTargetEnum!
}
......@@ -25030,7 +25030,7 @@ type TodoCreatePayload {
errors: [String!]!
"""
The to-do created.
The to-do item created.
"""
todo: Todo
}
......@@ -25065,7 +25065,7 @@ input TodoMarkDoneInput {
clientMutationId: String
"""
The global ID of the to-do to mark as done.
The global ID of the to-do item to mark as done.
"""
id: TodoID!
}
......@@ -25085,7 +25085,7 @@ type TodoMarkDonePayload {
errors: [String!]!
"""
The requested to-do.
The requested to-do item.
"""
todo: Todo!
}
......@@ -25100,7 +25100,7 @@ input TodoRestoreInput {
clientMutationId: String
"""
The global ID of the to-do to restore.
The global ID of the to-do item to restore.
"""
id: TodoID!
}
......@@ -25115,7 +25115,7 @@ input TodoRestoreManyInput {
clientMutationId: String
"""
The global IDs of the to-dos to restore (a maximum of 50 is supported at once).
The global IDs of the to-do items to restore (a maximum of 50 is supported at once).
"""
ids: [TodoID!]!
}
......@@ -25135,14 +25135,14 @@ type TodoRestoreManyPayload {
errors: [String!]!
"""
Updated to-dos.
Updated to-do items.
"""
todos: [Todo!]!
"""
The IDs of the updated to-do items. Deprecated in 13.2: Use todos.
The IDs of the updated to-do items. Deprecated in 13.2: Use to-do items.
"""
updatedIds: [TodoID!]! @deprecated(reason: "Use todos. Deprecated in 13.2.")
updatedIds: [TodoID!]! @deprecated(reason: "Use to-do items. Deprecated in 13.2.")
}
"""
......@@ -25160,7 +25160,7 @@ type TodoRestorePayload {
errors: [String!]!
"""
The requested to-do.
The requested to-do item.
"""
todo: Todo!
}
......@@ -25232,14 +25232,14 @@ type TodosMarkAllDonePayload {
errors: [String!]!
"""
Updated todos.
Updated to-do items.
"""
todos: [Todo!]!
"""
Ids of the updated todos. Deprecated in 13.2: Use todos.
IDs of the updated to-do items. Deprecated in 13.2: Use to-do items.
"""
updatedIds: [TodoID!]! @deprecated(reason: "Use todos. Deprecated in 13.2.")
updatedIds: [TodoID!]! @deprecated(reason: "Use to-do items. Deprecated in 13.2.")
}
"""
......@@ -25509,7 +25509,7 @@ type UpdateAlertStatusPayload {
issue: Issue
"""
The todo after mutation.
The to-do item after mutation.
"""
todo: Todo
}
......@@ -26839,7 +26839,7 @@ type User {
status: UserStatus
"""
Todos of the user
To-do items of the user
"""
todos(
"""
......
doc/api/graphql/reference/gitlab_schema.json
View file @ c397b417
......@@ -953,7 +953,7 @@
},
{
"name": "todos",
"description": "To-dos of the current user for the alert.",
"description": "To-do items of the current user for the alert.",
"args": [
{
"name": "action",
......@@ -2504,7 +2504,7 @@
},
{
"name": "todo",
"description": "The todo after mutation.",
"description": "The to-do item after mutation.",
"args": [
],
......@@ -2648,7 +2648,7 @@
},
{
"name": "todo",
"description": "The todo after mutation.",
"description": "The to-do item after mutation.",
"args": [
],
......@@ -4482,7 +4482,7 @@
},
{
"name": "currentUserTodos",
"description": "Todos for the current user.",
"description": "To-do items for the current user.",
"args": [
{
"name": "after",
......@@ -4526,7 +4526,7 @@
},
{
"name": "state",
"description": "State of the todos.",
"description": "State of the to-do items.",
"type": {
"kind": "ENUM",
"name": "TodoStateEnum",
......@@ -12313,7 +12313,7 @@
},
{
"name": "todo",
"description": "The todo after mutation.",
"description": "The to-do item after mutation.",
"args": [
],
......@@ -14902,7 +14902,7 @@
"fields": [
{
"name": "currentUserTodos",
"description": "Todos for the current user.",
"description": "To-do items for the current user.",
"args": [
{
"name": "after",
......@@ -14946,7 +14946,7 @@
},
{
"name": "state",
"description": "State of the todos.",
"description": "State of the to-do items.",
"type": {
"kind": "ENUM",
"name": "TodoStateEnum",
......@@ -17991,7 +17991,7 @@
"fields": [
{
"name": "currentUserTodos",
"description": "Todos for the current user.",
"description": "To-do items for the current user.",
"args": [
{
"name": "after",
......@@ -18035,7 +18035,7 @@
},
{
"name": "state",
"description": "State of the todos.",
"description": "State of the to-do items.",
"type": {
"kind": "ENUM",
"name": "TodoStateEnum",
......@@ -23713,7 +23713,7 @@
},
{
"name": "currentUserTodos",
"description": "Todos for the current user.",
"description": "To-do items for the current user.",
"args": [
{
"name": "after",
......@@ -23757,7 +23757,7 @@
},
{
"name": "state",
"description": "State of the todos.",
"description": "State of the to-do items.",
"type": {
"kind": "ENUM",
"name": "TodoStateEnum",
......@@ -25584,7 +25584,7 @@
},
{
"name": "currentUserTodos",
"description": "Todos for the current user.",
"description": "To-do items for the current user.",
"args": [
{
"name": "after",
......@@ -25628,7 +25628,7 @@
},
{
"name": "state",
"description": "State of the todos.",
"description": "State of the to-do items.",
"type": {
"kind": "ENUM",
"name": "TodoStateEnum",
......@@ -34062,7 +34062,7 @@
},
{
"name": "currentUserTodos",
"description": "Todos for the current user.",
"description": "To-do items for the current user.",
"args": [
{
"name": "after",
......@@ -34106,7 +34106,7 @@
},
{
"name": "state",
"description": "State of the todos.",
"description": "State of the to-do items.",
"type": {
"kind": "ENUM",
"name": "TodoStateEnum",
......@@ -39886,7 +39886,7 @@
},
{
"name": "currentUserTodos",
"description": "Todos for the current user.",
"description": "To-do items for the current user.",
"args": [
{
"name": "after",
......@@ -39930,7 +39930,7 @@
},
{
"name": "state",
"description": "State of the todos.",
"description": "State of the to-do items.",
"type": {
"kind": "ENUM",
"name": "TodoStateEnum",
......@@ -72418,7 +72418,7 @@
"fields": [
{
"name": "action",
"description": "Action of the to-do",
"description": "Action of the to-do item",
"args": [
],
......@@ -72436,7 +72436,7 @@
},
{
"name": "author",
"description": "The author of this to-do",
"description": "The author of this to-do item",
"args": [
],
......@@ -72454,7 +72454,7 @@
},
{
"name": "body",
"description": "Body of the to-do",
"description": "Body of the to-do item",
"args": [
],
......@@ -72472,7 +72472,7 @@
},
{
"name": "createdAt",
"description": "Timestamp this to-do was created",
"description": "Timestamp this to-do item was created",
"args": [
],
......@@ -72490,7 +72490,7 @@
},
{
"name": "group",
"description": "Group this to-do is associated with",
"description": "Group this to-do item is associated with",
"args": [
],
......@@ -72504,7 +72504,7 @@
},
{
"name": "id",
"description": "ID of the to-do",
"description": "ID of the to-do item",
"args": [
],
......@@ -72522,7 +72522,7 @@
},
{
"name": "project",
"description": "The project this to-do is associated with",
"description": "The project this to-do item is associated with",
"args": [
],
......@@ -72536,7 +72536,7 @@
},
{
"name": "state",
"description": "State of the to-do",
"description": "State of the to-do item",
"args": [
],
......@@ -72554,7 +72554,7 @@
},
{
"name": "targetType",
"description": "Target type of the to-do",
"description": "Target type of the to-do item",
"args": [
],
......@@ -72780,7 +72780,7 @@
},
{
"name": "todo",
"description": "The to-do created.",
"description": "The to-do item created.",
"args": [
],
......@@ -72863,7 +72863,7 @@
"inputFields": [
{
"name": "id",
"description": "The global ID of the to-do to mark as done.",
"description": "The global ID of the to-do item to mark as done.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -72937,7 +72937,7 @@
},
{
"name": "todo",
"description": "The requested to-do.",
"description": "The requested to-do item.",
"args": [
],
......@@ -72969,7 +72969,7 @@
"inputFields": [
{
"name": "id",
"description": "The global ID of the to-do to restore.",
"description": "The global ID of the to-do item to restore.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -73004,7 +73004,7 @@
"inputFields": [
{
"name": "ids",
"description": "The global IDs of the to-dos to restore (a maximum of 50 is supported at once).",
"description": "The global IDs of the to-do items to restore (a maximum of 50 is supported at once).",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -73086,7 +73086,7 @@
},
{
"name": "todos",
"description": "Updated to-dos.",
"description": "Updated to-do items.",
"args": [
],
......@@ -73112,7 +73112,7 @@
},
{
"name": "updatedIds",
"description": "The IDs of the updated to-do items. Deprecated in 13.2: Use todos.",
"description": "The IDs of the updated to-do items. Deprecated in 13.2: Use to-do items.",
"args": [
],
......@@ -73134,7 +73134,7 @@
}
},
"isDeprecated": true,
"deprecationReason": "Use todos. Deprecated in 13.2."
"deprecationReason": "Use to-do items. Deprecated in 13.2."
}
],
"inputFields": null,
......@@ -73191,7 +73191,7 @@
},
{
"name": "todo",
"description": "The requested to-do.",
"description": "The requested to-do item.",
"args": [
],
......@@ -73363,7 +73363,7 @@
},
{
"name": "todos",
"description": "Updated todos.",
"description": "Updated to-do items.",
"args": [
],
......@@ -73389,7 +73389,7 @@
},
{
"name": "updatedIds",
"description": "Ids of the updated todos. Deprecated in 13.2: Use todos.",
"description": "IDs of the updated to-do items. Deprecated in 13.2: Use to-do items.",
"args": [
],
......@@ -73411,7 +73411,7 @@
}
},
"isDeprecated": true,
"deprecationReason": "Use todos. Deprecated in 13.2."
"deprecationReason": "Use to-do items. Deprecated in 13.2."
}
],
"inputFields": null,
......@@ -74189,7 +74189,7 @@
},
{
"name": "todo",
"description": "The todo after mutation.",
"description": "The to-do item after mutation.",
"args": [
],
......@@ -77580,7 +77580,7 @@
},
{
"name": "todos",
"description": "Todos of the user",
"description": "To-do items of the user",
"args": [
{
"name": "action",
doc/api/graphql/reference/index.md
View file @ c397b417
......@@ -102,7 +102,7 @@ Describes an alert from the project's Alert Management.
| `startedAt` | Time | Timestamp the alert was raised. |
| `status` | AlertManagementStatus | Status of the alert. |
| `title` | String | Title of the alert. |
| `todos` | TodoConnection | To-dos of the current user for the alert. |
| `todos` | TodoConnection | To-do items of the current user for the alert. |
| `updatedAt` | Time | Timestamp the alert was last updated. |
### AlertManagementAlertStatusCountsType
......@@ -166,7 +166,7 @@ Autogenerated return type of AlertSetAssignees.
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue created after mutation. |
| `todo` | Todo | The todo after mutation. |
| `todo` | Todo | The to-do item after mutation. |
### AlertTodoCreatePayload
......@@ -178,7 +178,7 @@ Autogenerated return type of AlertTodoCreate.
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue created after mutation. |
| `todo` | Todo | The todo after mutation. |
| `todo` | Todo | The to-do item after mutation. |
### AwardEmoji
......@@ -278,7 +278,7 @@ Represents an epic on an issue board.
| `closedAt` | Time | Timestamp of when the epic was closed. |
| `confidential` | Boolean | Indicates if the epic is confidential. |
| `createdAt` | Time | Timestamp of when the epic was created. |
| `currentUserTodos` | TodoConnection! | Todos for the current user. |
| `currentUserTodos` | TodoConnection! | To-do items for the current user. |
| `descendantCounts` | EpicDescendantCount | Number of open and closed descendant epics and issues. |
| `descendantWeightSum` | EpicDescendantWeights | Total weight of open and closed issues in the epic and its descendants. |
| `description` | String | Description of the epic. |
......@@ -705,7 +705,7 @@ Autogenerated return type of CreateAlertIssue.
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue created after mutation. |
| `todo` | Todo | The todo after mutation. |
| `todo` | Todo | The to-do item after mutation. |
### CreateAnnotationPayload
......@@ -1078,7 +1078,7 @@ A single design.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `currentUserTodos` | TodoConnection! | Todos for the current user. |
| `currentUserTodos` | TodoConnection! | To-do items for the current user. |
| `diffRefs` | DiffRefs! | The diff refs for this design. |
| `discussions` | DiscussionConnection! | All discussions on this noteable |
| `event` | DesignVersionEvent! | How this design was changed in the current version. |
......@@ -1400,7 +1400,7 @@ Represents an epic.
| `closedAt` | Time | Timestamp of when the epic was closed. |
| `confidential` | Boolean | Indicates if the epic is confidential. |
| `createdAt` | Time | Timestamp of when the epic was created. |
| `currentUserTodos` | TodoConnection! | Todos for the current user. |
| `currentUserTodos` | TodoConnection! | To-do items for the current user. |
| `descendantCounts` | EpicDescendantCount | Number of open and closed descendant epics and issues. |
| `descendantWeightSum` | EpicDescendantWeights | Total weight of open and closed issues in the epic and its descendants. |
| `description` | String | Description of the epic. |
......@@ -1516,7 +1516,7 @@ Relationship between an epic and an issue.
| `confidential` | Boolean! | Indicates the issue is confidential |
| `createNoteEmail` | String | User specific email address for the issue |
| `createdAt` | Time! | Timestamp of when the issue was created |
| `currentUserTodos` | TodoConnection! | Todos for the current user. |
| `currentUserTodos` | TodoConnection! | To-do items for the current user. |
| `description` | String | Description of the issue |
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
| `designCollection` | DesignCollection | Collection of design images associated with this issue |
......@@ -1891,7 +1891,7 @@ Represents a recorded measurement (object count) for the Admins.
| `confidential` | Boolean! | Indicates the issue is confidential |
| `createNoteEmail` | String | User specific email address for the issue |
| `createdAt` | Time! | Timestamp of when the issue was created |
| `currentUserTodos` | TodoConnection! | Todos for the current user. |
| `currentUserTodos` | TodoConnection! | To-do items for the current user. |
| `description` | String | Description of the issue |
| `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` |
| `designCollection` | DesignCollection | Collection of design images associated with this issue |
......@@ -2202,7 +2202,7 @@ Autogenerated return type of MarkAsSpamSnippet.
| `commitsWithoutMergeCommits` | CommitConnection | Merge request commits excluding merge commits |
| `conflicts` | Boolean! | Indicates if the merge request has conflicts |
| `createdAt` | Time! | Timestamp of when the merge request was created |
| `currentUserTodos` | TodoConnection! | Todos for the current user. |
| `currentUserTodos` | TodoConnection! | To-do items for the current user. |
| `defaultMergeCommitMessage` | String | Default merge commit message of the merge request |
| `defaultMergeCommitMessageWithDescription` | String | Default merge commit message of the merge request with description |
| `defaultSquashCommitMessage` | String | Default squash commit message of the merge request |
......@@ -3703,15 +3703,15 @@ Representing a to-do entry.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `action` | TodoActionEnum! | Action of the to-do |
| `author` | User! | The author of this to-do |
| `body` | String! | Body of the to-do |
| `createdAt` | Time! | Timestamp this to-do was created |
| `group` | Group | Group this to-do is associated with |
| `id` | ID! | ID of the to-do |
| `project` | Project | The project this to-do is associated with |
| `state` | TodoStateEnum! | State of the to-do |
| `targetType` | TodoTargetEnum! | Target type of the to-do |
| `action` | TodoActionEnum! | Action of the to-do item |
| `author` | User! | The author of this to-do item |
| `body` | String! | Body of the to-do item |
| `createdAt` | Time! | Timestamp this to-do item was created |
| `group` | Group | Group this to-do item is associated with |
| `id` | ID! | ID of the to-do item |
| `project` | Project | The project this to-do item is associated with |
| `state` | TodoStateEnum! | State of the to-do item |
| `targetType` | TodoTargetEnum! | Target type of the to-do item |
### TodoCreatePayload
......@@ -3721,7 +3721,7 @@ Autogenerated return type of TodoCreate.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `todo` | Todo | The to-do created. |
| `todo` | Todo | The to-do item created. |
### TodoMarkDonePayload
......@@ -3731,7 +3731,7 @@ Autogenerated return type of TodoMarkDone.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `todo` | Todo! | The requested to-do. |
| `todo` | Todo! | The requested to-do item. |
### TodoRestoreManyPayload
......@@ -3741,8 +3741,8 @@ Autogenerated return type of TodoRestoreMany.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `todos` | Todo! => Array | Updated to-dos. |
| `updatedIds` **{warning-solid}** | TodoID! => Array | **Deprecated:** Use todos. Deprecated in 13.2. |
| `todos` | Todo! => Array | Updated to-do items. |
| `updatedIds` **{warning-solid}** | TodoID! => Array | **Deprecated:** Use to-do items. Deprecated in 13.2. |
### TodoRestorePayload
......@@ -3752,7 +3752,7 @@ Autogenerated return type of TodoRestore.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `todo` | Todo! | The requested to-do. |
| `todo` | Todo! | The requested to-do item. |
### TodosMarkAllDonePayload
......@@ -3762,8 +3762,8 @@ Autogenerated return type of TodosMarkAllDone.
| ----- | ---- | ----------- |
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `todos` | Todo! => Array | Updated todos. |
| `updatedIds` **{warning-solid}** | TodoID! => Array | **Deprecated:** Use todos. Deprecated in 13.2. |
| `todos` | Todo! => Array | Updated to-do items. |
| `updatedIds` **{warning-solid}** | TodoID! => Array | **Deprecated:** Use to-do items. Deprecated in 13.2. |
### ToggleAwardEmojiPayload
......@@ -3810,7 +3810,7 @@ Autogenerated return type of UpdateAlertStatus.
| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `issue` | Issue | The issue created after mutation. |
| `todo` | Todo | The todo after mutation. |
| `todo` | Todo | The to-do item after mutation. |
### UpdateBoardEpicUserPreferencesPayload
......@@ -3976,7 +3976,7 @@ Autogenerated return type of UpdateSnippet.
| `starredProjects` | ProjectConnection | Projects starred by the user |
| `state` | UserState! | State of the user |
| `status` | UserStatus | User status |
| `todos` | TodoConnection! | Todos of the user |
| `todos` | TodoConnection! | To-do items of the user |
| `userPermissions` | UserPermissions! | Permissions for the current user on the resource |
| `username` | String! | Username of the user. Unique within this instance of GitLab |
| `webPath` | String! | Web path of the user |
......
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