diff options
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 87 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 210 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 14 |
3 files changed, 300 insertions, 11 deletions
diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index ecf34b14aa0..f698db84982 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -1406,12 +1406,12 @@ input DiffImagePositionInput { width: Int! """ - X position on which the comment was made + X position of the note """ x: Int! """ - Y position on which the comment was made + Y position of the note """ y: Int! } @@ -1475,12 +1475,12 @@ type DiffPosition { width: Int """ - X position on which the comment was made + X position of the note """ x: Int """ - Y position on which the comment was made + Y position of the note """ y: Int } @@ -4660,6 +4660,18 @@ type Mutation { todosMarkAllDone(input: TodosMarkAllDoneInput!): TodosMarkAllDonePayload toggleAwardEmoji(input: ToggleAwardEmojiInput!): ToggleAwardEmojiPayload updateEpic(input: UpdateEpicInput!): UpdateEpicPayload + + """ + Updates a DiffNote on an image (a `Note` where the `position.positionType` is + `"image"`). If the body of the Note contains only quick actions, the Note will + be destroyed during the update, and no Note will be returned + """ + updateImageDiffNote(input: UpdateImageDiffNoteInput!): UpdateImageDiffNotePayload + + """ + Updates a Note. If the body of the Note contains only quick actions, the Note + will be destroyed during the update, and no Note will be returned + """ updateNote(input: UpdateNoteInput!): UpdateNotePayload updateSnippet(input: UpdateSnippetInput!): UpdateSnippetPayload } @@ -7533,6 +7545,28 @@ enum TypeEnum { project } +input UpdateDiffImagePositionInput { + """ + Total height of the image + """ + height: Int + + """ + Total width of the image + """ + width: Int + + """ + X position of the note + """ + x: Int + + """ + Y position of the note + """ + y: Int +} + """ Autogenerated input type of UpdateEpic """ @@ -7619,6 +7653,51 @@ type UpdateEpicPayload { } """ +Autogenerated input type of UpdateImageDiffNote +""" +input UpdateImageDiffNoteInput { + """ + Content of the note + """ + body: String + + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The global id of the note to update + """ + id: ID! + + """ + The position of this note on a diff + """ + position: UpdateDiffImagePositionInput +} + +""" +Autogenerated return type of UpdateImageDiffNote +""" +type UpdateImageDiffNotePayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Reasons why the mutation failed. + """ + errors: [String!]! + + """ + The note after mutation + """ + note: Note +} + +""" Autogenerated input type of UpdateNote """ input UpdateNoteInput { diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index 33252993682..38a836acb6b 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -8063,7 +8063,7 @@ }, { "name": "x", - "description": "X position on which the comment was made", + "description": "X position of the note", "args": [ ], @@ -8077,7 +8077,7 @@ }, { "name": "y", - "description": "Y position on which the comment was made", + "description": "Y position of the note", "args": [ ], @@ -19427,8 +19427,35 @@ "deprecationReason": null }, { + "name": "updateImageDiffNote", + "description": "Updates a DiffNote on an image (a `Note` where the `position.positionType` is `\"image\"`). If the body of the Note contains only quick actions, the Note will be destroyed during the update, and no Note will be returned", + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "UpdateImageDiffNoteInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UpdateImageDiffNotePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "updateNote", - "description": null, + "description": "Updates a Note. If the body of the Note contains only quick actions, the Note will be destroyed during the update, and no Note will be returned", "args": [ { "name": "input", @@ -21640,7 +21667,7 @@ }, { "name": "x", - "description": "X position on which the comment was made", + "description": "X position of the note", "type": { "kind": "NON_NULL", "name": null, @@ -21654,7 +21681,7 @@ }, { "name": "y", - "description": "Y position on which the comment was made", + "description": "Y position of the note", "type": { "kind": "NON_NULL", "name": null, @@ -21817,6 +21844,179 @@ }, { "kind": "OBJECT", + "name": "UpdateImageDiffNotePayload", + "description": "Autogenerated return type of UpdateImageDiffNote", + "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": "note", + "description": "The note after mutation", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "Note", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "UpdateImageDiffNoteInput", + "description": "Autogenerated input type of UpdateImageDiffNote", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The global id of the note to update", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "body", + "description": "Content of the note", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "position", + "description": "The position of this note on a diff", + "type": { + "kind": "INPUT_OBJECT", + "name": "UpdateDiffImagePositionInput", + "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": "INPUT_OBJECT", + "name": "UpdateDiffImagePositionInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "x", + "description": "X position of the note", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "y", + "description": "Y position of the note", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "width", + "description": "Total width of the image", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "height", + "description": "Total height of the image", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", "name": "DestroyNotePayload", "description": "Autogenerated return type of DestroyNote", "fields": [ diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 43e7aef59e8..c1a5882eb25 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -246,8 +246,8 @@ Autogenerated return type of DestroySnippet | `oldPath` | String | Path of the file on the start SHA | | `positionType` | DiffPositionType! | Type of file the position refers to | | `width` | Int | Total width of the image | -| `x` | Int | X position on which the comment was made | -| `y` | Int | Y position on which the comment was made | +| `x` | Int | X position of the note | +| `y` | Int | Y position of the note | ## DiffRefs @@ -1230,6 +1230,16 @@ Autogenerated return type of UpdateEpic | `epic` | Epic | The epic after mutation | | `errors` | String! => Array | Reasons why the mutation failed. | +## UpdateImageDiffNotePayload + +Autogenerated return type of UpdateImageDiffNote + +| Name | Type | Description | +| --- | ---- | ---------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Reasons why the mutation failed. | +| `note` | Note | The note after mutation | + ## UpdateNotePayload Autogenerated return type of UpdateNote |