Documentation API

This commit is contained in:
RubenPX 2022-04-28 11:53:49 +02:00
parent a945fc085f
commit 2ffa606bc3
1 changed files with 6 additions and 1 deletions

View File

@ -9,6 +9,12 @@ dags-with-materialized-paths-using-postgres-ltree/>`_ you have
a low-level technical implementation of how lots and their a low-level technical implementation of how lots and their
relationships are mapped. relationships are mapped.
Getting lots
************
You can get lots list by ``GET /lots/``
There are one optional filter ``type``, only works with this 3 values ``temporary``, ``incoming`` and ``outgoing``
Create lots Create lots
*********** ***********
You create a lot by ``POST /lots/`` a `JSON Lot object <https:// You create a lot by ``POST /lots/`` a `JSON Lot object <https://
@ -28,7 +34,6 @@ And for devices is all the same:
``POST /lots/<parent-lot-id>/devices/?id=<device-id-1>&id=<device-id-2>``; ``POST /lots/<parent-lot-id>/devices/?id=<device-id-1>&id=<device-id-2>``;
idem for removing devices. idem for removing devices.
Sharing lots Sharing lots
************ ************
Sharing a lot means giving certain permissions to users, like reading Sharing a lot means giving certain permissions to users, like reading