summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/graphql/reference/gitlab_schema.graphql63
-rw-r--r--doc/api/graphql/reference/gitlab_schema.json224
-rw-r--r--doc/api/graphql/reference/index.md19
3 files changed, 306 insertions, 0 deletions
diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql
index 9a70d71a202..14aeb7f8268 100644
--- a/doc/api/graphql/reference/gitlab_schema.graphql
+++ b/doc/api/graphql/reference/gitlab_schema.graphql
@@ -5933,6 +5933,46 @@ type JiraImportStartPayload {
jiraImport: JiraImport
}
+"""
+Autogenerated input type of JiraImportUsers
+"""
+input JiraImportUsersInput {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ The project to import the Jira users into
+ """
+ projectPath: ID!
+
+ """
+ The index of the record the import should started at, default 0 (50 records returned)
+ """
+ startAt: Int
+}
+
+"""
+Autogenerated return type of JiraImportUsers
+"""
+type JiraImportUsersPayload {
+ """
+ A unique identifier for the client performing the mutation.
+ """
+ clientMutationId: String
+
+ """
+ Errors encountered during execution of the mutation.
+ """
+ errors: [String!]!
+
+ """
+ Users returned from Jira, matched by email and name if possible.
+ """
+ jiraUsers: [JiraUser!]
+}
+
type JiraProject {
"""
Key of the Jira project
@@ -6027,6 +6067,28 @@ type JiraService implements Service {
type: String
}
+type JiraUser {
+ """
+ Id of the matched GitLab user
+ """
+ gitlabId: Int
+
+ """
+ Account id of the Jira user
+ """
+ jiraAccountId: String!
+
+ """
+ Display name of the Jira user
+ """
+ jiraDisplayName: String!
+
+ """
+ Email of the Jira user, returned only for users with public emails
+ """
+ jiraEmail: String
+}
+
type Label {
"""
Background color of the label
@@ -7271,6 +7333,7 @@ type Mutation {
issueSetIteration(input: IssueSetIterationInput!): IssueSetIterationPayload
issueSetWeight(input: IssueSetWeightInput!): IssueSetWeightPayload
jiraImportStart(input: JiraImportStartInput!): JiraImportStartPayload
+ jiraImportUsers(input: JiraImportUsersInput!): JiraImportUsersPayload
markAsSpamSnippet(input: MarkAsSpamSnippetInput!): MarkAsSpamSnippetPayload
mergeRequestCreate(input: MergeRequestCreateInput!): MergeRequestCreatePayload
mergeRequestSetAssignees(input: MergeRequestSetAssigneesInput!): MergeRequestSetAssigneesPayload
diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json
index 7c31d5ab41c..4b62ac22db8 100644
--- a/doc/api/graphql/reference/gitlab_schema.json
+++ b/doc/api/graphql/reference/gitlab_schema.json
@@ -16359,6 +16359,126 @@
"possibleTypes": null
},
{
+ "kind": "INPUT_OBJECT",
+ "name": "JiraImportUsersInput",
+ "description": "Autogenerated input type of JiraImportUsers",
+ "fields": null,
+ "inputFields": [
+ {
+ "name": "projectPath",
+ "description": "The project to import the Jira users into",
+ "type": {
+ "kind": "NON_NULL",
+ "name": null,
+ "ofType": {
+ "kind": "SCALAR",
+ "name": "ID",
+ "ofType": null
+ }
+ },
+ "defaultValue": null
+ },
+ {
+ "name": "startAt",
+ "description": "The index of the record the import should started at, default 0 (50 records returned)",
+ "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": "JiraImportUsersPayload",
+ "description": "Autogenerated return type of JiraImportUsers",
+ "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": "Errors encountered during execution of the mutation.",
+ "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": "jiraUsers",
+ "description": "Users returned from Jira, matched by email and name if possible.",
+ "args": [
+
+ ],
+ "type": {
+ "kind": "LIST",
+ "name": null,
+ "ofType": {
+ "kind": "NON_NULL",
+ "name": null,
+ "ofType": {
+ "kind": "OBJECT",
+ "name": "JiraUser",
+ "ofType": null
+ }
+ }
+ },
+ "isDeprecated": false,
+ "deprecationReason": null
+ }
+ ],
+ "inputFields": null,
+ "interfaces": [
+
+ ],
+ "enumValues": null,
+ "possibleTypes": null
+ },
+ {
"kind": "OBJECT",
"name": "JiraProject",
"description": null,
@@ -16643,6 +16763,83 @@
},
{
"kind": "OBJECT",
+ "name": "JiraUser",
+ "description": null,
+ "fields": [
+ {
+ "name": "gitlabId",
+ "description": "Id of the matched GitLab user",
+ "args": [
+
+ ],
+ "type": {
+ "kind": "SCALAR",
+ "name": "Int",
+ "ofType": null
+ },
+ "isDeprecated": false,
+ "deprecationReason": null
+ },
+ {
+ "name": "jiraAccountId",
+ "description": "Account id of the Jira user",
+ "args": [
+
+ ],
+ "type": {
+ "kind": "NON_NULL",
+ "name": null,
+ "ofType": {
+ "kind": "SCALAR",
+ "name": "String",
+ "ofType": null
+ }
+ },
+ "isDeprecated": false,
+ "deprecationReason": null
+ },
+ {
+ "name": "jiraDisplayName",
+ "description": "Display name of the Jira user",
+ "args": [
+
+ ],
+ "type": {
+ "kind": "NON_NULL",
+ "name": null,
+ "ofType": {
+ "kind": "SCALAR",
+ "name": "String",
+ "ofType": null
+ }
+ },
+ "isDeprecated": false,
+ "deprecationReason": null
+ },
+ {
+ "name": "jiraEmail",
+ "description": "Email of the Jira user, returned only for users with public emails",
+ "args": [
+
+ ],
+ "type": {
+ "kind": "SCALAR",
+ "name": "String",
+ "ofType": null
+ },
+ "isDeprecated": false,
+ "deprecationReason": null
+ }
+ ],
+ "inputFields": null,
+ "interfaces": [
+
+ ],
+ "enumValues": null,
+ "possibleTypes": null
+ },
+ {
+ "kind": "OBJECT",
"name": "Label",
"description": null,
"fields": [
@@ -21054,6 +21251,33 @@
"deprecationReason": null
},
{
+ "name": "jiraImportUsers",
+ "description": null,
+ "args": [
+ {
+ "name": "input",
+ "description": null,
+ "type": {
+ "kind": "NON_NULL",
+ "name": null,
+ "ofType": {
+ "kind": "INPUT_OBJECT",
+ "name": "JiraImportUsersInput",
+ "ofType": null
+ }
+ },
+ "defaultValue": null
+ }
+ ],
+ "type": {
+ "kind": "OBJECT",
+ "name": "JiraImportUsersPayload",
+ "ofType": null
+ },
+ "isDeprecated": false,
+ "deprecationReason": null
+ },
+ {
"name": "markAsSpamSnippet",
"description": null,
"args": [
diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md
index 00429423bb4..f5b5a8816d1 100644
--- a/doc/api/graphql/reference/index.md
+++ b/doc/api/graphql/reference/index.md
@@ -869,6 +869,16 @@ Autogenerated return type of JiraImportStart
| `errors` | String! => Array | Errors encountered during execution of the mutation. |
| `jiraImport` | JiraImport | The Jira import data after mutation |
+## JiraImportUsersPayload
+
+Autogenerated return type of JiraImportUsers
+
+| Name | Type | Description |
+| --- | ---- | ---------- |
+| `clientMutationId` | String | A unique identifier for the client performing the mutation. |
+| `errors` | String! => Array | Errors encountered during execution of the mutation. |
+| `jiraUsers` | JiraUser! => Array | Users returned from Jira, matched by email and name if possible. |
+
## JiraProject
| Name | Type | Description |
@@ -885,6 +895,15 @@ Autogenerated return type of JiraImportStart
| `projects` | JiraProjectConnection | List of Jira projects fetched through Jira REST API |
| `type` | String | Class name of the service |
+## JiraUser
+
+| Name | Type | Description |
+| --- | ---- | ---------- |
+| `gitlabId` | Int | Id of the matched GitLab user |
+| `jiraAccountId` | String! | Account id of the Jira user |
+| `jiraDisplayName` | String! | Display name of the Jira user |
+| `jiraEmail` | String | Email of the Jira user, returned only for users with public emails |
+
## Label
| Name | Type | Description |
View Lorry Controller Status