Refactor of API landing page

eread · axilleas · commit fb6e59ebe34f · 2019-02-15T09:39:23.000Z
- Breaks up into more sections.
- Also minor fixes to pages within sections.
diff --git a/doc/api/README.md b/doc/api/README.md
diff --git a/doc/api/lint.md b/doc/api/lint.md
@@ -2,7 +2,7 @@
 
 > [Introduced][ce-5953] in GitLab 8.12.
 
-Checks if your .gitlab-ci.yml file is valid.
+Checks if your `.gitlab-ci.yml` file is valid.
 
 ```
 POST /lint
diff --git a/doc/api/pages_domains.md b/doc/api/pages_domains.md
@@ -8,7 +8,7 @@ The GitLab Pages feature must be enabled to use these endpoints. Find out more a
 
 Get a list of all pages domains. The user must have admin permissions.
 
-```http
+```text
 GET /pages/domains
 ```
 
@@ -34,7 +34,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/ap
 
 Get a list of project pages domains. The user must have permissions to view pages domains.
 
-```http
+```text
 GET /projects/:id/pages/domains
 ```
 
@@ -69,7 +69,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/ap
 
 Get a single project pages domain. The user must have permissions to view pages domains.
 
-```http
+```text
 GET /projects/:id/pages/domains/:domain
 ```
 
@@ -110,7 +110,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/ap
 
 Creates a new pages domain. The user must have permissions to create new pages domains.
 
-```http
+```text
 POST /projects/:id/pages/domains
 ```
 
@@ -146,7 +146,7 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form "domain
 
 Updates an existing project pages domain. The user must have permissions to change an existing pages domains.
 
-```http
+```text
 PUT /projects/:id/pages/domains/:domain
 ```
 
@@ -182,7 +182,7 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --form "certifi
 
 Deletes an existing project pages domain.
 
-```http
+```text
 DELETE /projects/:id/pages/domains/:domain
 ```
 
diff --git a/doc/api/project_import_export.md b/doc/api/project_import_export.md
@@ -1,8 +1,8 @@
 # Project import/export API
 
-[Introduced][ce-41899] in GitLab 10.6
+> [Introduced][ce-41899] in GitLab 10.6.
 
-[See also the project import/export documentation](../user/project/settings/import_export.md)
+See also the [project import/export documentation](../user/project/settings/import_export.md).
 
 ## Schedule an export
 
@@ -16,7 +16,7 @@ data file uploads to the final server.
 If the `upload` params is present, `upload[url]` param is required.
  (**Note:** This feature was introduced in GitLab 10.7)
 
-```http
+```text
 POST /projects/:id/export
 ```
 
@@ -28,8 +28,7 @@ POST /projects/:id/export
 | `upload[url]`      | string | yes      | The URL to upload the project |
 | `upload[http_method]`      | string | no      | The HTTP method to upload the exported project. Only `PUT` and `POST` methods allowed. Default is `PUT` |
 
-
-```console
+```sh
 curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/export \
     --data "upload[http_method]=PUT" \
     --data-urlencode "upload[url]=https://example-bucket.s3.eu-west-3.amazonaws.com/backup?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIMBJHN2O62W8IELQ%2F20180312%2Feu-west-3%2Fs3%2Faws4_request&X-Amz-Date=20180312T110328Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=8413facb20ff33a49a147a0b4abcff4c8487cc33ee1f7e450c46e8f695569dbd"
@@ -45,15 +44,15 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab
 
 Get the status of export.
 
-```http
+```text
 GET /projects/:id/export
 ```
 
 | Attribute | Type           | Required | Description                              |
 | --------- | -------------- | -------- | ---------------------------------------- |
 | `id`      | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
 
-```console
+```sh
 curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/export
 ```
 
@@ -86,26 +85,26 @@ to a web server, etc.
 
 Download the finished export.
 
-```http
+```text
 GET /projects/:id/export/download
 ```
 
 | Attribute | Type           | Required | Description                              |
 | --------- | -------------- | -------- | ---------------------------------------- |
 | `id`      | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
 
-```console
+```sh
 curl --header "PRIVATE-TOKEN: <your_access_token>" --remote-header-name --remote-name https://gitlab.example.com/api/v4/projects/5/export/download
 ```
 
-```console
+```sh
 ls *export.tar.gz
 2017-12-05_22-11-148_namespace_project_export.tar.gz
 ```
 
 ## Import a file
 
-```http
+```text
 POST /projects/import
 ```
 
@@ -124,7 +123,7 @@ cURL to post data using the header `Content-Type: multipart/form-data`.
 The `file=` parameter must point to a file on your file system and be preceded
 by `@`. For example:
 
-```console
+```sh
 curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form "path=api-project" --form "file=@/path/to/file" https://gitlab.example.com/api/v4/projects/import
 ```
 
@@ -168,15 +167,15 @@ requests.post(url, headers=headers, data=data, files=files)
 
 Get the status of an import.
 
-```http
+```text
 GET /projects/:id/import
 ```
 
 | Attribute | Type           | Required | Description                              |
 | --------- | -------------- | -------- | ---------------------------------------- |
 | `id`      | integer/string | yes      | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
 
-```console
+```sh
 curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/import
 ```
 
diff --git a/doc/api/protected_branches.md b/doc/api/protected_branches.md
@@ -5,6 +5,7 @@
 **Valid access levels**
 
 The access levels are defined in the `ProtectedRefAccess.allowed_access_levels` method. Currently, these levels are recognized:
+
 ```
 0  => No access
 30 => Developer access
diff --git a/doc/api/releases/index.md b/doc/api/releases/index.md
@@ -2,7 +2,7 @@
 
 > - [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/41766) in GitLab 11.7.
 > - Using this API you can manipulate GitLab's [Release](../../user/project/releases/index.md) entries.
-> - For manipulating links as a release asset, see [Release Links API](links.md)
+> - For manipulating links as a release asset, see [Release Links API](links.md).
 
 ## List Releases
 
diff --git a/doc/api/templates/gitignores.md b/doc/api/templates/gitignores.md
@@ -1,8 +1,8 @@
-# Gitignores API
+# `.gitignore` API
 
-## List gitignore templates
+## List `.gitignore` templates
 
-Get all gitignore templates.
+Get all `.gitignore` templates.
 
 ```
 GET /templates/gitignores
@@ -99,17 +99,17 @@ Example response:
 ]
 ```
 
-## Single gitignore template
+## Single `.gitignore` template
 
-Get a single gitignore template.
+Get a single `.gitignore` template.
 
 ```
 GET /templates/gitignores/:key
 ```
 
 | Attribute  | Type   | Required | Description |
 | ---------- | ------ | -------- | ----------- |
-| `key`      | string | yes      | The key of the gitignore template |
+| `key`      | string | yes      | The key of the `.gitignore` template |
 
 ```bash
 curl https://gitlab.example.com/api/v4/templates/gitignores/Ruby
