summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTomasz Maczukin <tomasz@maczukin.pl>2016-01-07 14:10:49 +0100
committerTomasz Maczukin <tomasz@maczukin.pl>2016-01-07 14:10:49 +0100
commitb60445906849e84ff52ac6a5d7d501bb5a21eb60 (patch)
tree4f07771dc0f82a2059a983599d37c931aace7249 /doc
parentb60c146267dfa8dc1c170426e1817c6b2a168d1a (diff)
downloadgitlab-ce-b60445906849e84ff52ac6a5d7d501bb5a21eb60.tar.gz
Update ./doc/api
Diffstat (limited to 'doc')
-rw-r--r--doc/api/README.md1
-rw-r--r--doc/api/variables.md106
2 files changed, 107 insertions, 0 deletions
diff --git a/doc/api/README.md b/doc/api/README.md
index 25a31b235cc..198b4ddfee1 100644
--- a/doc/api/README.md
+++ b/doc/api/README.md
@@ -23,6 +23,7 @@
- [Namespaces](namespaces.md)
- [Settings](settings.md)
- [Keys](keys.md)
+- [Variables](variables.md)
## Clients
diff --git a/doc/api/variables.md b/doc/api/variables.md
new file mode 100644
index 00000000000..cdc9ba42254
--- /dev/null
+++ b/doc/api/variables.md
@@ -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
+