Mirrored_Repos/InvenTree
1
0
Fork 0
mirror of https://github.com/inventree/InvenTree synced 2024-08-30 18:33:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #400 from SchrodingersGat/python-api-doc

Browse Source 
Added some docs
This commit is contained in:
Oliver 2019-06-18 08:39:34 +10:00 committed by GitHub
commit f114192264
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/forms.rst
View File

@ -42,7 +42,7 @@ Sequence of Events
#. Client sends the completed form to server via POST #. Client sends the completed form to server via POST
#. Django backend handles POST request, specifically determines if the form is valid #. Django backend handles POST request, specifically determines if the form is valid
#. Return a JSON object containing status of form validity #. Return a JSON object containing status of form validity
* If the form is valid, return (at minimum) {form_valid: true}. Client will close the modal. * If the form is valid, return (at minimum) ``{form_valid: true}``. Client will close the modal.
* If the form is invalid, re-render the form and send back to the client. Process repeats * If the form is invalid, re-render the form and send back to the client. Process repeats
At the end of this process (i.e. after successful processing of the form) the client closes the modal and runs any optional post-processes (depending on the implementation). At the end of this process (i.e. after successful processing of the form) the client closes the modal and runs any optional post-processes (depending on the implementation).

5
docs/rest.rst
View File

@ -35,3 +35,8 @@ API Code
-------- --------
Javascript/jQuery code for interacting with the server via the REST API can be found under ``InvenTree/static/script/InvenTree``. Javascript/jQuery code for interacting with the server via the REST API can be found under ``InvenTree/static/script/InvenTree``.
Python interface
----------------
A Python library for interacting with the InvenTree API is provided on `GitHub <https://github.com/inventree/inventree-python>`_