c3lf/c3lf-system-3
7
0
Fork 0
Code Issues 52 Pull requests Projects 2 Releases Wiki Activity Actions

meka api.md a little more explicit

Browse source
This commit is contained in:
j3d1 2019-12-18 00:41:38 +01:00
parent 489c6253c0
commit bd295a8e4c
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
API.md
View file

@ -17,25 +17,25 @@ json endpoints returning a list should always be encapsulated ba an object to ma
#### ``GET /api/<version.major>/<event.id>/items/<search_query>`` #### ``GET /api/<version.major>/<event.id>/items/<search_query>``
Returns all results of a fuzzy search over all items for <search_query>. The <search_query> should be url-encoded. Returns all results of a fuzzy search over all items for <search_query>. The <search_query> should be url-encoded.
#### ``GET /api/<version.major>/<event.id>/item/<item.id>`` #### ``GET /api/<version.major>/<event.id>/item/<item.uid>``
#### ``DELETE /api/<version.major>/<event.id>/item/<item.id>`` #### ``DELETE /api/<version.major>/<event.id>/item/<item.uid>``
#### ``PUT /api/<version.major>/<event.id>/item/<item.id>`` #### ``PUT /api/<version.major>/<event.id>/item/<item.uid>``
#### ``POST /api/<version.major>/<event.id>/item/<item.id>`` #### ``POST /api/<version.major>/<event.id>/item/<item.uid>``
### Boxes ### Boxes
#### ``GET /api/<version.major>/boxes`` #### ``GET /api/<version.major>/boxes``
#### ``GET /api/<version.major>/box/<box.id>`` #### ``GET /api/<version.major>/box/<box.cid>``
#### ``DELETE /api/<version.major>/box/<box.id>`` #### ``DELETE /api/<version.major>/box/<box.cid>``
#### ``PUT /api/<version.major>/box/<box.id>`` #### ``PUT /api/<version.major>/box/<box.cid>``
#### ``POST /api/<version.major>/box/<box.id>`` #### ``POST /api/<version.major>/box/<box.cid>``
### Events ### Events
```json ```json