Commit 789ad1ea authored by Mike Lewis's avatar Mike Lewis

Merge branch 'docs-verify-api-metadata' into 'master'

Add metadata to verify api docs

See merge request gitlab-org/gitlab!38146
parents 48f61094 2fb20eca
---
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
---
# Instance-level CI/CD variables API # Instance-level CI/CD variables API
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14108) in GitLab 13.0 > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14108) in GitLab 13.0
......
---
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
---
# Jobs API # Jobs API
## List project jobs ## List project jobs
......
---
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
---
# Validate the `.gitlab-ci.yml` (API) # Validate the `.gitlab-ci.yml` (API)
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/5953) in GitLab 8.12. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/5953) in GitLab 8.12.
......
---
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
---
# Pipeline schedules API # Pipeline schedules API
You can read more about [pipeline schedules](../ci/pipelines/schedules.md). You can read more about [pipeline schedules](../ci/pipelines/schedules.md).
......
---
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
---
# Pipeline triggers API # Pipeline triggers API
You can read more about [triggering pipelines through the API](../ci/triggers/README.md). You can read more about [triggering pipelines through the API](../ci/triggers/README.md).
......
---
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
---
# Pipelines API # Pipelines API
## Single Pipeline Requests ## Single Pipeline Requests
......
--- ---
stage: Create stage: Verify
group: Source Code 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/#designated-technical-writers
type: reference, api type: reference, api
--- ---
......
--- ---
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
type: reference type: reference
--- ---
...@@ -8,9 +11,9 @@ In GitLab, there is an API endpoint available to work with GitLab CI/CD YMLs. Fo ...@@ -8,9 +11,9 @@ In GitLab, there is an API endpoint available to work with GitLab CI/CD YMLs. Fo
information on CI/CD pipeline configuration in GitLab, see the information on CI/CD pipeline configuration in GitLab, see the
[configuration reference documentation](../../ci/yaml/README.md). [configuration reference documentation](../../ci/yaml/README.md).
## List GitLab CI YML templates ## List GitLab CI YAML templates
Get all GitLab CI/CD YML templates. Get all GitLab CI/CD YAML templates.
```plaintext ```plaintext
GET /templates/gitlab_ci_ymls GET /templates/gitlab_ci_ymls
...@@ -19,7 +22,7 @@ GET /templates/gitlab_ci_ymls ...@@ -19,7 +22,7 @@ GET /templates/gitlab_ci_ymls
Example request: Example request:
```shell ```shell
curl https://gitlab.example.com/api/v4/templates/gitlab_ci_ymls curl "https://gitlab.example.com/api/v4/templates/gitlab_ci_ymls"
``` ```
Example response: Example response:
...@@ -109,9 +112,9 @@ Example response: ...@@ -109,9 +112,9 @@ Example response:
] ]
``` ```
## Single GitLab CI YML template ## Single GitLab CI YAML template
Get a single GitLab CI/CD YML template. Get a single GitLab CI/CD YAML template.
```plaintext ```plaintext
GET /templates/gitlab_ci_ymls/:key GET /templates/gitlab_ci_ymls/:key
...@@ -119,12 +122,12 @@ GET /templates/gitlab_ci_ymls/:key ...@@ -119,12 +122,12 @@ GET /templates/gitlab_ci_ymls/:key
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| ---------- | ------ | -------- | ------------------------------------- | | ---------- | ------ | -------- | ------------------------------------- |
| `key` | string | yes | The key of the GitLab CI/CD YML template | | `key` | string | yes | The key of the GitLab CI/CD YAML template |
Example request: Example request:
```shell ```shell
curl https://gitlab.example.com/api/v4/templates/gitlab_ci_ymls/Ruby curl "https://gitlab.example.com/api/v4/templates/gitlab_ci_ymls/Ruby"
``` ```
Example response: Example response:
......
--- ---
stage: Create stage: Verify
group: Source Code group: Testing
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/#designated-technical-writers
type: reference, api type: reference, api
--- ---
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment