Skip to content

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

Update definitions from 'todo' to 'to-do' 

Update the definitions to the correct spelling, so they'll stop
showing up for the Technical Writing team as spelling errors.
parent 7a503520
Hide whitespace changes
Inline Side-by-side
Showing with 65 additions and 65 deletions
app/graphql/mutations/todos/mark_done.rb
View file @ 1b6ea201
......@@ -10,11 +10,11 @@ module Mutations
argument :id,
::Types::GlobalIDType[::Todo],
required: true,
description: 'The global ID of the todo to mark as done.'
description: 'The global ID of the to-do to mark as done.'
field :todo, Types::TodoType,
null: false,
description: 'The requested todo.'
description: 'The requested to-do.'
def resolve(id:)
todo = authorized_find!(id: id)
......
app/graphql/mutations/todos/restore.rb
View file @ 1b6ea201
......@@ -10,11 +10,11 @@ module Mutations
argument :id,
::Types::GlobalIDType[::Todo],
required: true,
description: 'The global ID of the todo to restore.'
description: 'The global ID of the to-do to restore.'
field :todo, Types::TodoType,
null: false,
description: 'The requested todo.'
description: 'The requested to-do.'
def resolve(id:)
todo = authorized_find!(id: id)
......
app/graphql/mutations/todos/restore_many.rb
View file @ 1b6ea201
......@@ -10,16 +10,16 @@ module Mutations
argument :ids,
[::Types::GlobalIDType[::Todo]],
required: true,
description: 'The global IDs of the todos to restore (a maximum of 50 is supported at once).'
description: 'The global IDs of the to-dos to restore (a maximum of 50 is supported at once).'
field :updated_ids, [::Types::GlobalIDType[Todo]],
null: false,
description: 'The IDs of the updated todo items.',
description: 'The IDs of the updated to-do items.',
deprecated: { reason: 'Use todos', milestone: '13.2' }
field :todos, [::Types::TodoType],
null: false,
description: 'Updated todos.'
description: 'Updated to-dos.'
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 todos requested.'
raise Gitlab::Graphql::Errors::ArgumentError, 'Too many to-dos requested.'
end
def check_update_amount_limit!(ids)
......
app/graphql/types/todo_type.rb
View file @ 1b6ea201
......@@ -3,49 +3,49 @@
module Types
class TodoType < BaseObject
graphql_name 'Todo'
description 'Representing a todo entry'
description 'Representing a to-do entry'
present_using TodoPresenter
authorize :read_todo
field :id, GraphQL::ID_TYPE,
description: 'ID of the todo',
description: 'ID of the to-do',
null: false
field :project, Types::ProjectType,
description: 'The project this todo is associated with',
description: 'The project this to-do is associated with',
null: true,
authorize: :read_project
field :group, Types::GroupType,
description: 'Group this todo is associated with',
description: 'Group this to-do is associated with',
null: true,
authorize: :read_group
field :author, Types::UserType,
description: 'The author of this todo',
description: 'The author of this to-do',
null: false
field :action, Types::TodoActionEnum,
description: 'Action of the todo',
description: 'Action of the to-do',
null: false
field :target_type, Types::TodoTargetEnum,
description: 'Target type of the todo',
description: 'Target type of the to-do',
null: false
field :body, GraphQL::STRING_TYPE,
description: 'Body of the todo',
description: 'Body of the to-do',
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 todo',
description: 'State of the to-do',
null: false
field :created_at, Types::TimeType,
description: 'Timestamp this todo was created',
description: 'Timestamp this to-do was created',
null: false
def project
......
doc/api/graphql/reference/gitlab_schema.graphql
View file @ 1b6ea201
......@@ -24542,51 +24542,51 @@ type TimelogEdge {
}
"""
Representing a todo entry
Representing a to-do entry
"""
type Todo {
"""
Action of the todo
Action of the to-do
"""
action: TodoActionEnum!
"""
The author of this todo
The author of this to-do
"""
author: User!
"""
Body of the todo
Body of the to-do
"""
body: String!
"""
Timestamp this todo was created
Timestamp this to-do was created
"""
createdAt: Time!
"""
Group this todo is associated with
Group this to-do is associated with
"""
group: Group
"""
ID of the todo
ID of the to-do
"""
id: ID!
"""
The project this todo is associated with
The project this to-do is associated with
"""
project: Project
"""
State of the todo
State of the to-do
"""
state: TodoStateEnum!
"""
Target type of the todo
Target type of the to-do
"""
targetType: TodoTargetEnum!
}
......@@ -24686,7 +24686,7 @@ input TodoMarkDoneInput {
clientMutationId: String
"""
The global ID of the todo to mark as done.
The global ID of the to-do to mark as done.
"""
id: TodoID!
}
......@@ -24706,7 +24706,7 @@ type TodoMarkDonePayload {
errors: [String!]!
"""
The requested todo.
The requested to-do.
"""
todo: Todo!
}
......@@ -24721,7 +24721,7 @@ input TodoRestoreInput {
clientMutationId: String
"""
The global ID of the todo to restore.
The global ID of the to-do to restore.
"""
id: TodoID!
}
......@@ -24736,7 +24736,7 @@ input TodoRestoreManyInput {
clientMutationId: String
"""
The global IDs of the todos to restore (a maximum of 50 is supported at once).
The global IDs of the to-dos to restore (a maximum of 50 is supported at once).
"""
ids: [TodoID!]!
}
......@@ -24756,12 +24756,12 @@ type TodoRestoreManyPayload {
errors: [String!]!
"""
Updated todos.
Updated to-dos.
"""
todos: [Todo!]!
"""
The IDs of the updated todo items. Deprecated in 13.2: Use todos.
The IDs of the updated to-do items. Deprecated in 13.2: Use todos.
"""
updatedIds: [TodoID!]! @deprecated(reason: "Use todos. Deprecated in 13.2.")
}
......@@ -24781,7 +24781,7 @@ type TodoRestorePayload {
errors: [String!]!
"""
The requested todo.
The requested to-do.
"""
todo: Todo!
}
......
doc/api/graphql/reference/gitlab_schema.json
View file @ 1b6ea201
......@@ -71345,11 +71345,11 @@
{
"kind": "OBJECT",
"name": "Todo",
"description": "Representing a todo entry",
"description": "Representing a to-do entry",
"fields": [
{
"name": "action",
"description": "Action of the todo",
"description": "Action of the to-do",
"args": [
],
......@@ -71367,7 +71367,7 @@
},
{
"name": "author",
"description": "The author of this todo",
"description": "The author of this to-do",
"args": [
],
......@@ -71385,7 +71385,7 @@
},
{
"name": "body",
"description": "Body of the todo",
"description": "Body of the to-do",
"args": [
],
......@@ -71403,7 +71403,7 @@
},
{
"name": "createdAt",
"description": "Timestamp this todo was created",
"description": "Timestamp this to-do was created",
"args": [
],
......@@ -71421,7 +71421,7 @@
},
{
"name": "group",
"description": "Group this todo is associated with",
"description": "Group this to-do is associated with",
"args": [
],
......@@ -71435,7 +71435,7 @@
},
{
"name": "id",
"description": "ID of the todo",
"description": "ID of the to-do",
"args": [
],
......@@ -71453,7 +71453,7 @@
},
{
"name": "project",
"description": "The project this todo is associated with",
"description": "The project this to-do is associated with",
"args": [
],
......@@ -71467,7 +71467,7 @@
},
{
"name": "state",
"description": "State of the todo",
"description": "State of the to-do",
"args": [
],
......@@ -71485,7 +71485,7 @@
},
{
"name": "targetType",
"description": "Target type of the todo",
"description": "Target type of the to-do",
"args": [
],
......@@ -71794,7 +71794,7 @@
"inputFields": [
{
"name": "id",
"description": "The global ID of the todo to mark as done.",
"description": "The global ID of the to-do to mark as done.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -71868,7 +71868,7 @@
},
{
"name": "todo",
"description": "The requested todo.",
"description": "The requested to-do.",
"args": [
],
......@@ -71900,7 +71900,7 @@
"inputFields": [
{
"name": "id",
"description": "The global ID of the todo to restore.",
"description": "The global ID of the to-do to restore.",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -71935,7 +71935,7 @@
"inputFields": [
{
"name": "ids",
"description": "The global IDs of the todos to restore (a maximum of 50 is supported at once).",
"description": "The global IDs of the to-dos to restore (a maximum of 50 is supported at once).",
"type": {
"kind": "NON_NULL",
"name": null,
......@@ -72017,7 +72017,7 @@
},
{
"name": "todos",
"description": "Updated todos.",
"description": "Updated to-dos.",
"args": [
],
......@@ -72043,7 +72043,7 @@
},
{
"name": "updatedIds",
"description": "The IDs of the updated todo items. Deprecated in 13.2: Use todos.",
"description": "The IDs of the updated to-do items. Deprecated in 13.2: Use todos.",
"args": [
],
......@@ -72122,7 +72122,7 @@
},
{
"name": "todo",
"description": "The requested todo.",
"description": "The requested to-do.",
"args": [
],
doc/api/graphql/reference/index.md
View file @ 1b6ea201
......@@ -3649,19 +3649,19 @@ Represents a historically accurate report about the timebox.
### Todo
Representing a todo entry.
Representing a to-do entry.
| Field | Type | Description |
| ----- | ---- | ----------- |
| `action` | TodoActionEnum! | Action of the todo |
| `author` | User! | The author of this todo |
| `body` | String! | Body of the todo |
| `createdAt` | Time! | Timestamp this todo was created |
| `group` | Group | Group this todo is associated with |
| `id` | ID! | ID of the todo |
| `project` | Project | The project this todo is associated with |
| `state` | TodoStateEnum! | State of the todo |
| `targetType` | TodoTargetEnum! | Target type of the todo |
| `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 |
### TodoCreatePayload
......@@ -3681,7 +3681,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 todo. |
| `todo` | Todo! | The requested to-do. |
### TodoRestoreManyPayload
......@@ -3691,7 +3691,7 @@ 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 todos. |
| `todos` | Todo! => Array | Updated to-dos. |
| `updatedIds` **{warning-solid}** | TodoID! => Array | **Deprecated:** Use todos. Deprecated in 13.2. |
### TodoRestorePayload
......@@ -3702,7 +3702,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 todo. |
| `todo` | Todo! | The requested to-do. |
### TodosMarkAllDonePayload
......
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