Update ./doc/api

This commit is contained in:
Tomasz Maczukin 2016-01-07 14:10:49 +01:00
parent b60c146267
commit b604459068
3 changed files with 108 additions and 1 deletions

View file

@ -23,6 +23,7 @@
- [Namespaces](namespaces.md)
- [Settings](settings.md)
- [Keys](keys.md)
- [Variables](variables.md)
## Clients

106
doc/api/variables.md Normal file
View file

@ -0,0 +1,106 @@
# Variables
## Variables keys
All variable keys must contains only letters, digits and '\_'. They must also be no longer than 255 characters.
## List project variables
Get list of variables of a project.
```
GET /projects/:id/variables
```
Parameters:
- `id` (required) - The ID of a project
```json
[
{
"key": "TEST_VARIABLE_1",
"value": "TEST_1"
},
{
"key": "TEST_VARIABLE_2",
"value": "TEST_2"
}
]
```
## Show variable details
Get details of specifica variable of a project.
```
GET /projects/:id/variables/:key
```
Parameters:
- `id` (required) - The ID of a project
- `key` (required) - The `key` of variable
```json
{
"key": "TEST_VARIABLE_1",
"value": "TEST_1"
}
```
## Create variable
Create new variable in project.
```
POST /projects/:id/variables
```
Parameters:
- `id` (required) - The ID of a project
- `key` (required) - The `key` for variable
- `value` (required) - The `value` for variable
```json
{
"key": "NEW_VARIABLE",
"value": "new value"
}
```
## Update variable
Update variable.
```
PUT /projects/:id/variables/:key
```
Parameters:
- `id` (required) - The ID of a project
- `key` (required) - The `key` for variable
- `value` (required) - The `value` for variable
```json
{
"key": "NEW_VARIABLE",
"value": "updated value"
}
```
## Remove variable
Remove variable.
```
DELETE /projects/:id/variables/:key
```
Parameters:
- `id` (required) - The ID of a project
- `key` (required) - The `key` for variable

View file

@ -367,7 +367,7 @@ module API
end
class Variable < Grape::Entity
expose :id, :key, :value
expose :key, :value
end
end
end