Remove extra whitespaces in docs
Removes all the extra whitespaces at end of lines, inside tags, and removes extra newlines
This commit is contained in:
parent
c697706aad
commit
25aa4e0322
|
|
@ -229,7 +229,6 @@ PUT /projects/:id/boards/:board_id
|
|||
| `labels` | string | no | Comma-separated list of label names which the board should be scoped to |
|
||||
| `weight` | integer | no | The weight range from 0 to 9, to which the board should be scoped to |
|
||||
|
||||
|
||||
```bash
|
||||
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards/1?name=new_name&milestone_id=43&assignee_id=1&labels=Doing&weight=4
|
||||
```
|
||||
|
|
|
|||
|
|
@ -302,7 +302,7 @@ POST /groups/:id/epics/:epic_iid/todo
|
|||
| Attribute | Type | Required | Description |
|
||||
|-------------|---------|----------|--------------------------------------|
|
||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||
| `epic_iid ` | integer | yes | The internal ID of a group's epic |
|
||||
| `epic_iid` | integer | yes | The internal ID of a group's epic |
|
||||
|
||||
```bash
|
||||
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics/5/todo
|
||||
|
|
|
|||
|
|
@ -67,7 +67,6 @@ POST /projects/:id/issues/:issue_iid/links
|
|||
| `target_project_id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) of a target project |
|
||||
| `target_issue_iid` | integer/string | yes | The internal ID of a target project's issue |
|
||||
|
||||
|
||||
```json
|
||||
{
|
||||
"source_issue" : {
|
||||
|
|
@ -141,14 +140,12 @@ Deletes an issue link, thus removes the two-way relationship.
|
|||
DELETE /projects/:id/issues/:issue_iid/links/:issue_link_id
|
||||
```
|
||||
|
||||
|
||||
| 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 |
|
||||
| `issue_iid` | integer | yes | The internal ID of a project's issue |
|
||||
| `issue_link_id` | integer/string | yes | The ID of an issue relationship |
|
||||
|
||||
|
||||
```json
|
||||
{
|
||||
"source_issue" : {
|
||||
|
|
|
|||
|
|
@ -57,7 +57,7 @@ GET /issues?confidential=true
|
|||
| `created_before` | datetime | no | Return issues created on or before the given time |
|
||||
| `updated_after` | datetime | no | Return issues updated on or after the given time |
|
||||
| `updated_before` | datetime | no | Return issues updated on or before the given time |
|
||||
| `confidential ` | Boolean | no | Filter confidential or public issues. |
|
||||
| `confidential` | Boolean | no | Filter confidential or public issues. |
|
||||
|
||||
```bash
|
||||
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/issues
|
||||
|
|
@ -206,7 +206,7 @@ GET /groups/:id/issues?confidential=true
|
|||
| `created_before` | datetime | no | Return issues created on or before the given time |
|
||||
| `updated_after` | datetime | no | Return issues updated on or after the given time |
|
||||
| `updated_before` | datetime | no | Return issues updated on or before the given time |
|
||||
| `confidential ` | Boolean | no | Filter confidential or public issues. |
|
||||
| `confidential` | Boolean | no | Filter confidential or public issues. |
|
||||
|
||||
```bash
|
||||
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/4/issues
|
||||
|
|
@ -355,7 +355,7 @@ GET /projects/:id/issues?confidential=true
|
|||
| `created_before` | datetime | no | Return issues created on or before the given time |
|
||||
| `updated_after` | datetime | no | Return issues updated on or after the given time |
|
||||
| `updated_before` | datetime | no | Return issues updated on or before the given time |
|
||||
| `confidential ` | Boolean | no | Filter confidential or public issues. |
|
||||
| `confidential` | Boolean | no | Filter confidential or public issues. |
|
||||
|
||||
|
||||
```bash
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ GET /issues_statistics?confidential=true
|
|||
| `created_before` | datetime | no | Return issues created on or before the given time |
|
||||
| `updated_after` | datetime | no | Return issues updated on or after the given time |
|
||||
| `updated_before` | datetime | no | Return issues updated on or before the given time |
|
||||
| `confidential ` | Boolean | no | Filter confidential or public issues. |
|
||||
| `confidential` | Boolean | no | Filter confidential or public issues. |
|
||||
|
||||
```bash
|
||||
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/issues_statistics
|
||||
|
|
@ -99,7 +99,7 @@ GET /groups/:id/issues_statistics?confidential=true
|
|||
| `created_before` | datetime | no | Return issues created on or before the given time |
|
||||
| `updated_after` | datetime | no | Return issues updated on or after the given time |
|
||||
| `updated_before` | datetime | no | Return issues updated on or before the given time |
|
||||
| `confidential ` | Boolean | no | Filter confidential or public issues. |
|
||||
| `confidential` | Boolean | no | Filter confidential or public issues. |
|
||||
|
||||
```bash
|
||||
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/4/issues_statistics
|
||||
|
|
@ -155,8 +155,7 @@ GET /projects/:id/issues_statistics?confidential=true
|
|||
| `created_before` | datetime | no | Return issues created on or before the given time |
|
||||
| `updated_after` | datetime | no | Return issues updated on or after the given time |
|
||||
| `updated_before` | datetime | no | Return issues updated on or before the given time |
|
||||
| `confidential ` | Boolean | no | Filter confidential or public issues. |
|
||||
|
||||
| `confidential` | Boolean | no | Filter confidential or public issues. |
|
||||
|
||||
```bash
|
||||
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/issues_statistics
|
||||
|
|
|
|||
|
|
@ -485,7 +485,7 @@ Parameters
|
|||
| Attribute | Type | Required | Description |
|
||||
|-----------------|----------------|----------|------------------------------------------------------------------------------------------------------------------|
|
||||
| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. |
|
||||
| `job_id ` | integer | yes | The unique job identifier. |
|
||||
| `job_id` | integer | yes | The unique job identifier. |
|
||||
| `artifact_path` | string | yes | Path to a file inside the artifacts archive. |
|
||||
|
||||
Example request:
|
||||
|
|
@ -782,7 +782,6 @@ DELETE /projects/:id/jobs/:job_id/artifacts
|
|||
| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||
| `job_id` | integer | yes | ID of a job. |
|
||||
|
||||
|
||||
Example request:
|
||||
|
||||
```sh
|
||||
|
|
|
|||
|
|
@ -131,7 +131,6 @@ Returns:
|
|||
- `201 Created` if the license is successfully added.
|
||||
- `400 Bad Request` if the license couldn't be added, with an error message explaining the reason.
|
||||
|
||||
|
||||
## Delete a license
|
||||
|
||||
```
|
||||
|
|
|
|||
|
|
@ -178,7 +178,6 @@ PUT /projects/:id/approvers
|
|||
}
|
||||
```
|
||||
|
||||
|
||||
## Merge Request-level MR approvals
|
||||
|
||||
Configuration for approvals on a specific Merge Request. Must be authenticated for all endpoints.
|
||||
|
|
@ -250,7 +249,6 @@ POST /projects/:id/merge_requests/:merge_request_iid/approvals
|
|||
| `merge_request_iid` | integer | yes | The IID of MR |
|
||||
| `approvals_required` | integer | yes | Approvals required before MR can be merged |
|
||||
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 5,
|
||||
|
|
|
|||
|
|
@ -91,7 +91,7 @@ POST /projects/:id/badges
|
|||
|
||||
| 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 |
|
||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||
| `link_url` | string | yes | URL of the badge link |
|
||||
| `image_url` | string | yes | URL of the badge image |
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ GET /projects/:id/statistics
|
|||
|
||||
| Attribute | Type | Required | Description |
|
||||
| ---------- | ------ | -------- | ----------- |
|
||||
| `id ` | integer / string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||
| `id` | integer / string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||
|
||||
Example response:
|
||||
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ GET /projects/:id/templates/:type
|
|||
|
||||
| Attribute | Type | Required | Description |
|
||||
| ---------- | ------ | -------- | ----------- |
|
||||
| `id ` | integer / string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||
| `id` | integer / string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||
| `type` | string | yes| The type `(dockerfiles|gitignores|gitlab_ci_ymls|licenses)` of the template |
|
||||
|
||||
Example response (licenses):
|
||||
|
|
@ -93,7 +93,7 @@ GET /projects/:id/templates/:type/:key
|
|||
|
||||
| Attribute | Type | Required | Description |
|
||||
| ---------- | ------ | -------- | ----------- |
|
||||
| `id ` | integer / string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||
| `id` | integer / string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) |
|
||||
| `type` | string | yes| The type `(dockerfiles|gitignores|gitlab_ci_ymls|licenses)` of the template |
|
||||
| `key` | string | yes | The key of the template, as obtained from the collection endpoint |
|
||||
| `project` | string | no | The project name to use when expanding placeholders in the template. Only affects licenses |
|
||||
|
|
|
|||
|
|
@ -53,7 +53,7 @@ allowed.
|
|||
|
||||
### Exclude params from parent namespaces!
|
||||
|
||||
> By default `declared(params) `includes parameters that were defined in all
|
||||
> By default `declared(params)`includes parameters that were defined in all
|
||||
parent namespaces.
|
||||
|
||||
– <https://github.com/ruby-grape/grape#include-parent-namespaces>
|
||||
|
|
|
|||
|
|
@ -654,7 +654,6 @@ and related tools such as:
|
|||
- <https://explain.depesz.com/>
|
||||
- <http://tatiyants.com/postgres-query-plan-visualization/>
|
||||
|
||||
|
||||
## Producing query plans
|
||||
|
||||
There are a few ways to get the output of a query plan. Of course you
|
||||
|
|
|
|||
Loading…
Reference in New Issue