Commit 75c195f5 authored by Eulyeon Ko's avatar Eulyeon Ko Committed by Jan Provaznik

Update the documentation for emailsDisabled field

Make the description to be more explicit.
parent c7c3323e
...@@ -75,7 +75,7 @@ module Types ...@@ -75,7 +75,7 @@ module Types
description: 'List of participants in the issue' description: 'List of participants in the issue'
field :emails_disabled, GraphQL::BOOLEAN_TYPE, null: false, field :emails_disabled, GraphQL::BOOLEAN_TYPE, null: false,
method: :project_emails_disabled?, method: :project_emails_disabled?,
description: 'Indicates if a project has email notifications disabled' description: 'Indicates if a project has email notifications disabled: `true` if email notifications are disabled'
field :subscribed, GraphQL::BOOLEAN_TYPE, method: :subscribed?, null: false, complexity: 5, field :subscribed, GraphQL::BOOLEAN_TYPE, method: :subscribed?, null: false, complexity: 5,
description: 'Indicates the currently logged in user is subscribed to the issue' description: 'Indicates the currently logged in user is subscribed to the issue'
field :time_estimate, GraphQL::INT_TYPE, null: false, field :time_estimate, GraphQL::INT_TYPE, null: false,
......
...@@ -7646,7 +7646,7 @@ type EpicIssue implements CurrentUserTodos & Noteable { ...@@ -7646,7 +7646,7 @@ type EpicIssue implements CurrentUserTodos & Noteable {
dueDate: Time dueDate: Time
""" """
Indicates if a project has email notifications disabled Indicates if a project has email notifications disabled: `true` if email notifications are disabled
""" """
emailsDisabled: Boolean! emailsDisabled: Boolean!
...@@ -10185,7 +10185,7 @@ type Issue implements CurrentUserTodos & Noteable { ...@@ -10185,7 +10185,7 @@ type Issue implements CurrentUserTodos & Noteable {
dueDate: Time dueDate: Time
""" """
Indicates if a project has email notifications disabled Indicates if a project has email notifications disabled: `true` if email notifications are disabled
""" """
emailsDisabled: Boolean! emailsDisabled: Boolean!
......
...@@ -21191,7 +21191,7 @@ ...@@ -21191,7 +21191,7 @@
}, },
{ {
"name": "emailsDisabled", "name": "emailsDisabled",
"description": "Indicates if a project has email notifications disabled", "description": "Indicates if a project has email notifications disabled: `true` if email notifications are disabled",
"args": [ "args": [
], ],
...@@ -27886,7 +27886,7 @@ ...@@ -27886,7 +27886,7 @@
}, },
{ {
"name": "emailsDisabled", "name": "emailsDisabled",
"description": "Indicates if a project has email notifications disabled", "description": "Indicates if a project has email notifications disabled: `true` if email notifications are disabled",
"args": [ "args": [
], ],
...@@ -1272,7 +1272,7 @@ Relationship between an epic and an issue. ...@@ -1272,7 +1272,7 @@ Relationship between an epic and an issue.
| `discussions` | DiscussionConnection! | All discussions on this noteable | | `discussions` | DiscussionConnection! | All discussions on this noteable |
| `downvotes` | Int! | Number of downvotes the issue has received | | `downvotes` | Int! | Number of downvotes the issue has received |
| `dueDate` | Time | Due date of the issue | | `dueDate` | Time | Due date of the issue |
| `emailsDisabled` | Boolean! | Indicates if a project has email notifications disabled | | `emailsDisabled` | Boolean! | Indicates if a project has email notifications disabled: `true` if email notifications are disabled |
| `epic` | Epic | Epic to which this issue belongs | | `epic` | Epic | Epic to which this issue belongs |
| `epicIssueId` | ID! | ID of the epic-issue relation | | `epicIssueId` | ID! | ID of the epic-issue relation |
| `healthStatus` | HealthStatus | Current health status. Returns null if `save_issuable_health_status` feature flag is disabled. | | `healthStatus` | HealthStatus | Current health status. Returns null if `save_issuable_health_status` feature flag is disabled. |
...@@ -1541,7 +1541,7 @@ Represents a recorded measurement (object count) for the Admins. ...@@ -1541,7 +1541,7 @@ Represents a recorded measurement (object count) for the Admins.
| `discussions` | DiscussionConnection! | All discussions on this noteable | | `discussions` | DiscussionConnection! | All discussions on this noteable |
| `downvotes` | Int! | Number of downvotes the issue has received | | `downvotes` | Int! | Number of downvotes the issue has received |
| `dueDate` | Time | Due date of the issue | | `dueDate` | Time | Due date of the issue |
| `emailsDisabled` | Boolean! | Indicates if a project has email notifications disabled | | `emailsDisabled` | Boolean! | Indicates if a project has email notifications disabled: `true` if email notifications are disabled |
| `epic` | Epic | Epic to which this issue belongs | | `epic` | Epic | Epic to which this issue belongs |
| `healthStatus` | HealthStatus | Current health status. Returns null if `save_issuable_health_status` feature flag is disabled. | | `healthStatus` | HealthStatus | Current health status. Returns null if `save_issuable_health_status` feature flag is disabled. |
| `humanTimeEstimate` | String | Human-readable time estimate of the issue | | `humanTimeEstimate` | String | Human-readable time estimate of the issue |
......
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