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
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-12-17 14:59:07 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2020-12-17 14:59:07 +0300
commit8b573c94895dc0ac0e1d9d59cf3e8745e8b539ca (patch)
tree544930fb309b30317ae9797a9683768705d664c4 /doc/api/templates
parent4b1de649d0168371549608993deac953eb692019 (diff)
Add latest changes from gitlab-org/gitlab@13-7-stable-eev13.7.0-rc42
Diffstat (limited to 'doc/api/templates')
-rw-r--r--doc/api/templates/dockerfiles.md6
-rw-r--r--doc/api/templates/gitignores.md19
-rw-r--r--doc/api/templates/gitlab_ci_ymls.md2
-rw-r--r--doc/api/templates/licenses.md10
4 files changed, 18 insertions, 19 deletions
diff --git a/doc/api/templates/dockerfiles.md b/doc/api/templates/dockerfiles.md
index fd0edfce8e5..a86dc36e141 100644
--- a/doc/api/templates/dockerfiles.md
+++ b/doc/api/templates/dockerfiles.md
@@ -1,7 +1,7 @@
---
stage: none
group: unassigned
-info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
+info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
type: reference
---
@@ -20,7 +20,7 @@ GET /templates/dockerfiles
```
```shell
-curl https://gitlab.example.com/api/v4/templates/dockerfiles
+curl "https://gitlab.example.com/api/v4/templates/dockerfiles"
```
Example response:
@@ -119,7 +119,7 @@ GET /templates/dockerfiles/:key
| `key` | string | yes | The key of the Dockerfile template |
```shell
-curl https://gitlab.example.com/api/v4/templates/dockerfiles/Binary
+curl "https://gitlab.example.com/api/v4/templates/dockerfiles/Binary"
```
Example response:
diff --git a/doc/api/templates/gitignores.md b/doc/api/templates/gitignores.md
index b957c582755..6f2e5a83903 100644
--- a/doc/api/templates/gitignores.md
+++ b/doc/api/templates/gitignores.md
@@ -1,19 +1,18 @@
---
stage: none
group: unassigned
-info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
+info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
type: reference
---
# .gitignore API
-In GitLab, there is an API endpoint available for `.gitignore`. For more
-information on `gitignore`, see the
-[Git documentation](https://git-scm.com/docs/gitignore).
+In GitLab, the `/gitignores` endpoint returns a list of Git `.gitignore` templates. For more information,
+see the [Git documentation for `.gitignore`](https://git-scm.com/docs/gitignore).
-## List `.gitignore` templates
+## Get all `.gitignore` templates
-Get all `.gitignore` templates.
+Get a list of all `.gitignore` templates:
```plaintext
GET /templates/gitignores
@@ -22,7 +21,7 @@ GET /templates/gitignores
Example request:
```shell
-curl https://gitlab.example.com/api/v4/templates/gitignores
+curl "https://gitlab.example.com/api/v4/templates/gitignores"
```
Example response:
@@ -112,9 +111,9 @@ Example response:
]
```
-## Single `.gitignore` template
+## Get a single `.gitignore` template
-Get a single `.gitignore` template.
+Get a single `.gitignore` template:
```plaintext
GET /templates/gitignores/:key
@@ -127,7 +126,7 @@ GET /templates/gitignores/:key
Example request:
```shell
-curl https://gitlab.example.com/api/v4/templates/gitignores/Ruby
+curl "https://gitlab.example.com/api/v4/templates/gitignores/Ruby"
```
Example response:
diff --git a/doc/api/templates/gitlab_ci_ymls.md b/doc/api/templates/gitlab_ci_ymls.md
index 45bc0f55095..8f78c600392 100644
--- a/doc/api/templates/gitlab_ci_ymls.md
+++ b/doc/api/templates/gitlab_ci_ymls.md
@@ -1,7 +1,7 @@
---
stage: Verify
group: Continuous Integration
-info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
+info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
type: reference
---
diff --git a/doc/api/templates/licenses.md b/doc/api/templates/licenses.md
index d1044b23306..fb76bd81e50 100644
--- a/doc/api/templates/licenses.md
+++ b/doc/api/templates/licenses.md
@@ -1,7 +1,7 @@
---
stage: none
group: unassigned
-info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
+info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
type: reference
---
@@ -25,7 +25,7 @@ GET /templates/licenses
| `popular` | boolean | no | If passed, returns only popular licenses |
```shell
-curl https://gitlab.example.com/api/v4/templates/licenses?popular=1
+curl "https://gitlab.example.com/api/v4/templates/licenses?popular=1"
```
Example response:
@@ -123,12 +123,12 @@ GET /templates/licenses/:key
| `project` | string | no | The copyrighted project name |
| `fullname` | string | no | The full-name of the copyright holder |
-NOTE: **Note:**
+NOTE:
If you omit the `fullname` parameter but authenticate your request, the name of
-the authenticated user will be used to replace the copyright holder placeholder.
+the authenticated user replaces the copyright holder placeholder.
```shell
-curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/templates/licenses/mit?project=My+Cool+Project
+curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/templates/licenses/mit?project=My+Cool+Project"
```
Example response: