Skip to content

GitLab

rest api standards · Changes

Page history
rcabral created page: gitlab administration authored by Rene Cabral's avatar Rene Cabral
Hide whitespace changes
Inline Side-by-side
rest-api-standards.markdown
View page @ fea4d9bd
......@@ -15,18 +15,18 @@
### Standards for KD Core API
| HTTP | Route | Action |
| -------- | ---------------------- | ------------------------- |
|`POST` | `/resources` | create resource, properties in json payload|
|`GET` | `/resources` | get resource collection|
|`GET` | `/resources?filter=:filter_param` | get filtered resource collection|
|`GET` | `/resources/:id` | get single resource|
|`GET` | `/resources/:id:(extra-property1)` | get single resource, requesting extra property|
|`DELETE` | `/resources/:id` | delete single resource|
|`DELETE` | `/resources/:id?recursive=:boolean` | delete single resource, additional parameters in `GET` string|
|`PATCH` | `/resources/:id` | update resource|
|`POST` | `/resources/:id/link` | link resource to specified resource(s), in payload []|
|`POST` | `/resources/:id/unlink` | unlink resource to specified resource(s), in payload []|
| HTTP | Route | Action |
| -------- | ---------------------- | ------------------------- |
|`POST` | `/resources` | create resource, properties in json payload|
|`GET` | `/resources` | get resource collection|
|`GET` | `/resources?filter=:filter_param` | get filtered resource collection|
|`GET` | `/resources/{id}` | get single resource|
|`GET` | `/resources/{id}:(extra-property1)` | get single resource, requesting extra property|
|`DELETE` | `/resources/{id}` | delete single resource|
|`DELETE` | `/resources/{id}?recursive=:boolean` | delete single resource, additional parameters in `GET` string|
|`PATCH` | `/resources/{id}` | update resource, properties in json payload|
|`POST` | `/resources/{id}/link` | link resource to specified resource(s), in json payload []|
|`POST` | `/resources/{id}/unlink` | unlink resource to specified resource(s), in json payload []|
......