Skip to content

Commit

Permalink
Update api.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
kingmalza committed Jan 26, 2019
1 parent 9ab97b7 commit cd81a9e
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,11 @@ Aida integrates the ability to interact with its database through API interface.
Using methods calls like GET, POST, DELETE, PUT, it is possible to interface with external programs or to perform extractions, insertions, table updates directly from code.

Using the link in the main menu "**Schema API**" it will be possible to display the page relative to the published schema of the aida tables, the manageable fields and their type and methods.

.. figure:: img/schema.png
:scale: 50 %
:alt: Aida test keywords

.. warning::
**Methods such as INSERT, DELETE, PUT make table changes without requiring confirmation.**
The use of this type of interaction should only be used in cases where it is absolutely safe not to cause damage to the entire system, incorrect use could lead to the impossibility of using aida with the consequent risk of irreversible data loss.

0 comments on commit cd81a9e

Please sign in to comment.