Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2019-12-20 12:24:38 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2019-12-20 12:24:38 +0300
commit898e2cc1dfa88b4ac39cb4b35011f61b37f57b51 (patch)
treec6524edb6c9a43cccf93be05c36883fde1a53ee4 /doc/api
parentb5571e6e22cdacc81f78eff5943d68c8ba220fbb (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/graphql/reference/gitlab_schema.graphql56
-rw-r--r--doc/api/graphql/reference/gitlab_schema.json34
-rw-r--r--doc/api/graphql/reference/index.md26
-rw-r--r--doc/api/project_level_variables.md1
4 files changed, 80 insertions, 37 deletions
diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql
index bc3395920ab..1e25e977286 100644
--- a/doc/api/graphql/reference/gitlab_schema.graphql
+++ b/doc/api/graphql/reference/gitlab_schema.graphql
@@ -503,6 +503,9 @@ type CreateSnippetPayload {
}
type Design implements Noteable {
+ """
+ Diff refs of the design
+ """
diffRefs: DiffRefs!
"""
@@ -531,13 +534,34 @@ type Design implements Noteable {
): DiscussionConnection!
"""
- The change that happened to the design at this version
+ Type of change made to the design at the version specified by the `atVersion`
+ argument if supplied. Defaults to the latest version
"""
event: DesignVersionEvent!
+
+ """
+ Filename of the design file
+ """
filename: String!
+
+ """
+ Full path of the design file
+ """
fullPath: String!
+
+ """
+ ID of the design
+ """
id: ID!
+
+ """
+ Image of the design
+ """
image: String!
+
+ """
+ Issue associated with the design
+ """
issue: Issue!
"""
@@ -566,13 +590,17 @@ type Design implements Noteable {
): NoteConnection!
"""
- The total count of user-created notes for this design
+ Total count of user-created notes for the design
"""
notesCount: Int!
+
+ """
+ Project associated with the design
+ """
project: Project!
"""
- All versions related to this design ordered newest first
+ All versions related to the design, ordered newest first
"""
versions(
"""
@@ -599,7 +627,7 @@ type Design implements Noteable {
type DesignCollection {
"""
- All designs for this collection
+ All designs for the design collection
"""
designs(
"""
@@ -638,11 +666,19 @@ type DesignCollection {
"""
last: Int
): DesignConnection!
+
+ """
+ Issue associated with the design collection
+ """
issue: Issue!
+
+ """
+ Project associated with the design collection
+ """
project: Project!
"""
- All versions related to all designs ordered newest first
+ All versions related to all designs, ordered newest first
"""
versions(
"""
@@ -799,7 +835,7 @@ type DesignManagementUploadPayload {
type DesignVersion {
"""
- All designs that were changed in this version
+ All designs that were changed in the version
"""
designs(
"""
@@ -822,7 +858,15 @@ type DesignVersion {
"""
last: Int
): DesignConnection!
+
+ """
+ ID of the design version
+ """
id: ID!
+
+ """
+ SHA of the design version
+ """
sha: ID!
}
diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json
index 3c30d2482e8..e71fd3fc71b 100644
--- a/doc/api/graphql/reference/gitlab_schema.json
+++ b/doc/api/graphql/reference/gitlab_schema.json
@@ -9206,7 +9206,7 @@
"fields": [
{
"name": "designs",
- "description": "All designs for this collection",
+ "description": "All designs for the design collection",
"args": [
{
"name": "ids",
@@ -9309,7 +9309,7 @@
},
{
"name": "issue",
- "description": null,
+ "description": "Issue associated with the design collection",
"args": [
],
@@ -9327,7 +9327,7 @@
},
{
"name": "project",
- "description": null,
+ "description": "Project associated with the design collection",
"args": [
],
@@ -9345,7 +9345,7 @@
},
{
"name": "versions",
- "description": "All versions related to all designs ordered newest first",
+ "description": "All versions related to all designs, ordered newest first",
"args": [
{
"name": "after",
@@ -10322,7 +10322,7 @@
"fields": [
{
"name": "diffRefs",
- "description": null,
+ "description": "Diff refs of the design",
"args": [
],
@@ -10397,7 +10397,7 @@
},
{
"name": "event",
- "description": "The change that happened to the design at this version",
+ "description": "Type of change made to the design at the version specified by the `atVersion` argument if supplied. Defaults to the latest version",
"args": [
],
@@ -10415,7 +10415,7 @@
},
{
"name": "filename",
- "description": null,
+ "description": "Filename of the design file",
"args": [
],
@@ -10433,7 +10433,7 @@
},
{
"name": "fullPath",
- "description": null,
+ "description": "Full path of the design file",
"args": [
],
@@ -10451,7 +10451,7 @@
},
{
"name": "id",
- "description": null,
+ "description": "ID of the design",
"args": [
],
@@ -10469,7 +10469,7 @@
},
{
"name": "image",
- "description": null,
+ "description": "Image of the design",
"args": [
],
@@ -10487,7 +10487,7 @@
},
{
"name": "issue",
- "description": null,
+ "description": "Issue associated with the design",
"args": [
],
@@ -10562,7 +10562,7 @@
},
{
"name": "notesCount",
- "description": "The total count of user-created notes for this design",
+ "description": "Total count of user-created notes for the design",
"args": [
],
@@ -10580,7 +10580,7 @@
},
{
"name": "project",
- "description": null,
+ "description": "Project associated with the design",
"args": [
],
@@ -10598,7 +10598,7 @@
},
{
"name": "versions",
- "description": "All versions related to this design ordered newest first",
+ "description": "All versions related to the design, ordered newest first",
"args": [
{
"name": "after",
@@ -10819,7 +10819,7 @@
"fields": [
{
"name": "designs",
- "description": "All designs that were changed in this version",
+ "description": "All designs that were changed in the version",
"args": [
{
"name": "after",
@@ -10876,7 +10876,7 @@
},
{
"name": "id",
- "description": null,
+ "description": "ID of the design version",
"args": [
],
@@ -10894,7 +10894,7 @@
},
{
"name": "sha",
- "description": null,
+ "description": "SHA of the design version",
"args": [
],
diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md
index 1669e3d604c..f142cee8544 100644
--- a/doc/api/graphql/reference/index.md
+++ b/doc/api/graphql/reference/index.md
@@ -104,22 +104,22 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph
| Name | Type | Description |
| --- | ---- | ---------- |
-| `id` | ID! | |
-| `project` | Project! | |
-| `issue` | Issue! | |
-| `notesCount` | Int! | The total count of user-created notes for this design |
-| `filename` | String! | |
-| `fullPath` | String! | |
-| `event` | DesignVersionEvent! | The change that happened to the design at this version |
-| `image` | String! | |
-| `diffRefs` | DiffRefs! | |
+| `id` | ID! | ID of the design |
+| `project` | Project! | Project associated with the design |
+| `issue` | Issue! | Issue associated with the design |
+| `notesCount` | Int! | Total count of user-created notes for the design |
+| `filename` | String! | Filename of the design file |
+| `fullPath` | String! | Full path of the design file |
+| `event` | DesignVersionEvent! | Type of change made to the design at the version specified by the `atVersion` argument if supplied. Defaults to the latest version |
+| `image` | String! | Image of the design |
+| `diffRefs` | DiffRefs! | Diff refs of the design |
### DesignCollection
| Name | Type | Description |
| --- | ---- | ---------- |
-| `project` | Project! | |
-| `issue` | Issue! | |
+| `project` | Project! | Project associated with the design collection |
+| `issue` | Issue! | Issue associated with the design collection |
### DesignManagementDeletePayload
@@ -142,8 +142,8 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph
| Name | Type | Description |
| --- | ---- | ---------- |
-| `id` | ID! | |
-| `sha` | ID! | |
+| `id` | ID! | ID of the design version |
+| `sha` | ID! | SHA of the design version |
### DestroyNotePayload
diff --git a/doc/api/project_level_variables.md b/doc/api/project_level_variables.md
index 591911bb8ec..d4bda992f7c 100644
--- a/doc/api/project_level_variables.md
+++ b/doc/api/project_level_variables.md
@@ -86,7 +86,6 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitla
"value": "new value",
"protected": false,
"variable_type": "env_var",
- "protected": false,
"masked": false,
"environment_scope": "*"
}