diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-02-25 12:10:45 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-02-25 12:10:45 +0300 |
commit | bcfab67c0f33aeda96041f341f92cf0ff1e062d3 (patch) | |
tree | 2d3a9c5ccd7693112ed48d410a9a940f6a1fa8de /doc | |
parent | c1ccb69fc9b1f07a00d3310f5fbd2e4622db9482 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/graphql/reference/index.md | 13 | ||||
-rw-r--r-- | doc/development/api_graphql_styleguide.md | 26 |
2 files changed, 28 insertions, 11 deletions
diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index aba9825efc5..b092a5d9fb4 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -1913,6 +1913,7 @@ Relationship between an epic and an issue. | `author` | User! | User that created the issue. | | `blocked` | Boolean! | Indicates the issue is blocked. | | `blockedByCount` | Int | Count of issues blocking this issue. | +| `blockedByIssues` | IssueConnection | Issues blocking this issue. | | `closedAt` | Time | Timestamp of when the issue was closed. | | `confidential` | Boolean! | Indicates the issue is confidential. | | `createNoteEmail` | String | User specific email address for the issue. | @@ -1973,6 +1974,7 @@ Represents an epic board list. | ----- | ---- | ----------- | | `collapsed` | Boolean | Indicates if this list is collapsed for this user. | | `epics` | EpicConnection | List epics. | +| `epicsCount` | Int | Count of epics in the list. | | `id` | BoardsEpicListID! | Global ID of the board list. | | `label` | Label | Label of the list. | | `listType` | String! | Type of the list. | @@ -2293,6 +2295,7 @@ A block of time for which a participant is on-call. | `author` | User! | User that created the issue. | | `blocked` | Boolean! | Indicates the issue is blocked. | | `blockedByCount` | Int | Count of issues blocking this issue. | +| `blockedByIssues` | IssueConnection | Issues blocking this issue. | | `closedAt` | Time | Timestamp of when the issue was closed. | | `confidential` | Boolean! | Indicates the issue is confidential. | | `createNoteEmail` | String | User specific email address for the issue. | @@ -3491,6 +3494,16 @@ Represents an asset link associated with a release. | `name` | String | Name of the link. | | `url` | String | URL of the link. | +### ReleaseAssetLinkCreatePayload + +Autogenerated return type of ReleaseAssetLinkCreate. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `link` | ReleaseAssetLink | The asset link after mutation. | + ### ReleaseAssets A container for all assets associated with a release. diff --git a/doc/development/api_graphql_styleguide.md b/doc/development/api_graphql_styleguide.md index f32aaf6ffa8..54e2cb9c68d 100644 --- a/doc/development/api_graphql_styleguide.md +++ b/doc/development/api_graphql_styleguide.md @@ -490,15 +490,18 @@ def foo end ``` -## Deprecating fields and enum values +## Deprecating fields, arguments, and enum values The GitLab GraphQL API is versionless, which means we maintain backwards -compatibility with older versions of the API with every change. Rather -than removing a field or [enum value](#enums), we need to _deprecate_ it instead. +compatibility with older versions of the API with every change. + +Rather than removing fields, arguments, or [enum values](#enums), they +must be _deprecated_ instead. + The deprecated parts of the schema can then be removed in a future release in accordance with the [GitLab deprecation process](../api/graphql/index.md#deprecation-process). -Fields and enum values are deprecated using the `deprecated` property. +Fields, arguments, and enum values are deprecated using the `deprecated` property. The value of the property is a `Hash` of: - `reason` - Reason for the deprecation. @@ -518,14 +521,15 @@ is appended to the `description`. ### Deprecation reason style guide -Where the reason for deprecation is due to the field or enum value being -replaced, the `reason` must be: +Where the reason for deprecation is due to the field, argument, or enum value being +replaced, the `reason` must indicate the replacement. For example, the +following is a `reason` for a replaced field: ```plaintext Use `otherFieldName` ``` -Example: +Examples: ```ruby field :designs, ::Types::DesignManagement::DesignCollectionType, null: true, @@ -544,8 +548,8 @@ module Types end ``` -If the field is not being replaced by another field, a descriptive -deprecation `reason` should be given. +If the field, argument, or enum value being deprecated is not being replaced, +a descriptive deprecation `reason` should be given. See also [Aliasing and deprecating mutations](#aliasing-and-deprecating-mutations). @@ -594,7 +598,7 @@ end ``` Enum values can be deprecated using the -[`deprecated` keyword](#deprecating-fields-and-enum-values). +[`deprecated` keyword](#deprecating-fields-arguments-and-enum-values). ### Defining GraphQL enums dynamically from Rails enums @@ -1567,7 +1571,7 @@ mount_aliased_mutation 'BarMutation', Mutations::FooMutation ``` This allows us to rename a mutation and continue to support the old name, -when coupled with the [`deprecated`](#deprecating-fields-and-enum-values) +when coupled with the [`deprecated`](#deprecating-fields-arguments-and-enum-values) argument. Example: |