diff options
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/README.md | 4 | ||||
| -rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 58 | ||||
| -rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 175 | ||||
| -rw-r--r-- | doc/api/graphql/reference/index.md | 13 |
4 files changed, 245 insertions, 5 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index 99d74aab83f..e08006a7f7f 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -417,7 +417,7 @@ The response header includes a link to the next page. For example: ```http HTTP/1.1 200 OK ... -Link: <https://gitlab.example.com/api/v4/projects?pagination=keyset&per_page=50&order_by=id&sort=asc&id_after=42>; rel="next" +Links: <https://gitlab.example.com/api/v4/projects?pagination=keyset&per_page=50&order_by=id&sort=asc&id_after=42>; rel="next" Status: 200 OK ... ``` @@ -425,7 +425,7 @@ Status: 200 OK The link to the next page contains an additional filter `id_after=42` which excludes records we have retrieved already. Note the type of filter depends on the `order_by` option used and we may have more than one additional filter. -When the end of the collection has been reached and there are no additional records to retrieve, the `Link` header is absent and the resulting array is empty. +When the end of the collection has been reached and there are no additional records to retrieve, the `Links` header is absent and the resulting array is empty. We recommend using only the given link to retrieve the next page instead of building your own URL. Apart from the headers shown, we don't expose additional pagination headers. diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index 3522a5a50eb..9f5f0278f91 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -411,6 +411,56 @@ type BoardListEdge { node: BoardList } +""" +Autogenerated input type of BoardListUpdateLimitMetrics +""" +input BoardListUpdateLimitMetricsInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The new limit metric type for the list. + """ + limitMetric: ListLimitMetric + + """ + The global ID of the list. + """ + listId: ID! + + """ + The new maximum issue count limit. + """ + maxIssueCount: Int + + """ + The new maximum issue weight limit. + """ + maxIssueWeight: Int +} + +""" +Autogenerated return type of BoardListUpdateLimitMetrics +""" +type BoardListUpdateLimitMetricsPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Reasons why the mutation failed. + """ + errors: [String!]! + + """ + The updated list + """ + list: BoardList +} + type Commit { """ Author of the commit @@ -4460,12 +4510,17 @@ scalar JSON type JiraImport { """ + Timestamp of when the Jira import was created + """ + createdAt: Time + + """ Project key for the imported Jira project """ jiraProjectKey: String! """ - Timestamp of when the Jira import was created + Timestamp of when the Jira import was scheduled """ scheduledAt: Time @@ -5689,6 +5744,7 @@ enum MoveType { type Mutation { addAwardEmoji(input: AddAwardEmojiInput!): AddAwardEmojiPayload adminSidekiqQueuesDeleteJobs(input: AdminSidekiqQueuesDeleteJobsInput!): AdminSidekiqQueuesDeleteJobsPayload + boardListUpdateLimitMetrics(input: BoardListUpdateLimitMetricsInput!): BoardListUpdateLimitMetricsPayload createDiffNote(input: CreateDiffNoteInput!): CreateDiffNotePayload createEpic(input: CreateEpicInput!): CreateEpicPayload createImageDiffNote(input: CreateImageDiffNoteInput!): CreateImageDiffNotePayload diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index 4c8fb099faa..140519d403e 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -1263,6 +1263,138 @@ "possibleTypes": null }, { + "kind": "INPUT_OBJECT", + "name": "BoardListUpdateLimitMetricsInput", + "description": "Autogenerated input type of BoardListUpdateLimitMetrics", + "fields": null, + "inputFields": [ + { + "name": "listId", + "description": "The global ID of the list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "limitMetric", + "description": "The new limit metric type for the list.", + "type": { + "kind": "ENUM", + "name": "ListLimitMetric", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "maxIssueCount", + "description": "The new maximum issue count limit.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "maxIssueWeight", + "description": "The new maximum issue weight limit.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "clientMutationId", + "description": "A unique identifier for the client performing the mutation.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BoardListUpdateLimitMetricsPayload", + "description": "Autogenerated return type of BoardListUpdateLimitMetrics", + "fields": [ + { + "name": "clientMutationId", + "description": "A unique identifier for the client performing the mutation.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "Reasons why the mutation failed.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "list", + "description": "The updated list", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "BoardList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { "kind": "SCALAR", "name": "Boolean", "description": "Represents `true` or `false` values.", @@ -12636,6 +12768,20 @@ "description": null, "fields": [ { + "name": "createdAt", + "description": "Timestamp of when the Jira import was created", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Time", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "jiraProjectKey", "description": "Project key for the imported Jira project", "args": [ @@ -12655,7 +12801,7 @@ }, { "name": "scheduledAt", - "description": "Timestamp of when the Jira import was created", + "description": "Timestamp of when the Jira import was scheduled", "args": [ ], @@ -16353,6 +16499,33 @@ "deprecationReason": null }, { + "name": "boardListUpdateLimitMetrics", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "BoardListUpdateLimitMetricsInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "BoardListUpdateLimitMetricsPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "createDiffNote", "description": null, "args": [ diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index af126f48c50..6205c97d77c 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -97,6 +97,16 @@ Represents a list for an issue board | `position` | Int | Position of list within the board | | `title` | String! | Title of the list | +## BoardListUpdateLimitMetricsPayload + +Autogenerated return type of BoardListUpdateLimitMetrics + +| Name | Type | Description | +| --- | ---- | ---------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Reasons why the mutation failed. | +| `list` | BoardList | The updated list | + ## Commit | Name | Type | Description | @@ -667,8 +677,9 @@ Autogenerated return type of IssueSetWeight | Name | Type | Description | | --- | ---- | ---------- | +| `createdAt` | Time | Timestamp of when the Jira import was created | | `jiraProjectKey` | String! | Project key for the imported Jira project | -| `scheduledAt` | Time | Timestamp of when the Jira import was created | +| `scheduledAt` | Time | Timestamp of when the Jira import was scheduled | | `scheduledBy` | User | User that started the Jira import | ## JiraImportStartPayload |