diff options
| author | Achilleas Pipinellis <axilleas@axilleas.me> | 2017-04-08 10:54:00 +0200 |
|---|---|---|
| committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2017-04-08 12:38:59 +0200 |
| commit | 5422554b8647c3fc01c44a5790b35c20596f1770 (patch) | |
| tree | bb70e15cd48471131f60e622c895cb7b3ceb6072 /doc/api/projects.md | |
| parent | 82fad17a7d40b7d19e0ee56abbe484c187d3360d (diff) | |
| download | gitlab-ce-5422554b8647c3fc01c44a5790b35c20596f1770.tar.gz | |
Mention URL path encoding to all API docs
Diffstat (limited to 'doc/api/projects.md')
| -rw-r--r-- | doc/api/projects.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md index 5da0d90689b..1c66d411972 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -158,8 +158,8 @@ Parameters: ### Get single project -Get a specific project, identified by project ID or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding), which is owned by the authenticated user. -This endpoint can be accessed without authentication if the project is publicly accessible. +Get a specific project. This endpoint can be accessed without authentication if +the project is publicly accessible. ``` GET /projects/:id @@ -169,7 +169,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [urlencoded NAMESPACE/PROJECT_NAME 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) | ```json { @@ -295,7 +295,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [urlencoded NAMESPACE/PROJECT_NAME 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) | ```json [ @@ -497,7 +497,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [urlencoded NAMESPACE/PROJECT_NAME 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) | | `name` | string | yes | The name of the project | | `path` | string | no | Custom repository name for the project. By default generated based on name | | `default_branch` | string | no | `master` by default | @@ -529,7 +529,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [urlencoded NAMESPACE/PROJECT_NAME 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) | | `namespace` | integer/string | yes | The ID or path of the namespace that the project will be forked to | ### Star a project @@ -544,7 +544,7 @@ Parameters: | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [urlencoded NAMESPACE/PROJECT_NAME 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) | ```bash curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/5/star" |