VladPolskiy/gitlab-foss
1
0
Fork 0
mirror of https://gitlab.com/gitlab-org/gitlab-foss.git synced 2025-08-20 14:11:11 +00:00
Code Issues Packages Projects Releases 1 Wiki Activity

Merge branch 'sh-document-plus-encoding-api' into 'master'

Browse Source 
Document converting `+` to `%2B` in an API query parameter

See merge request gitlab-org/gitlab-ce!14948
This commit is contained in:
Achilleas Pipinellis
2017-10-19 15:19:12 +00:00
parent 16998e2e13 efbb9cfb7b
commit ed339b6901
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
doc/api/README.md
View File

@ -455,6 +455,23 @@ Content-Type: application/json
}
```
## Encoding `+` in ISO 8601 dates
If you need to include a `+` in a query parameter, you may need to use `%2B` instead due
a [W3 recommendation]((http://www.w3.org/Addressing/URL/4_URI_Recommentations.html) that
causes a `+` to be interpreted as a space. For example, in an ISO 8601 date, you may want to pass
a time in Mountain Standard Time, such as:
```
2017-10-17T23:11:13.000+05:30
```
The correct encoding for the query parameter would be:
```
2017-10-17T23:11:13.000%2B05:30
```
## Clients
There are many unofficial GitLab API Clients for most of the popular