Skip to content

Commit

Permalink
add pointer to CIMI docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cjdcordeiro committed Apr 13, 2018
1 parent b4f25b1 commit 6decc69
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
30 changes: 30 additions & 0 deletions documentation/user_guide/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
API
===

The mF2C system is equipped with a RESTful (HTTP) API for the management of infrastructure resources.
This API is based on the Cloud Infrastructure Management Interface (CIMI_) specification from DMTF.

The CIMI standard defined patterns for all the usual database actions: Search (or Query), Create, Read, Update, and Delete (SCRUD).

+---------------+-------------+---------------------+
| Action | HTTP Method | Target |
+===============+=============+=====================+
| Search | GET or PUT | resource collection |
+---------------+-------------+---------------------+
| Add (create) | POST | resource collection |
+---------------+-------------+---------------------+
| Read | GET | resource |
+---------------+-------------+---------------------+
| Edit (update) | PUT | resource |
+---------------+-------------+---------------------+
| Delete | DELETE | resource |
+---------------+-------------+---------------------+


The mF2C API implementation has been adopted from the open source implementation used in SlipStream_.


.. _CIMI: https://www.dmtf.org/sites/default/files/standards/documents/DSP0263_2.0.0.pdf
.. _SlipStream: http://ssapi.sixsq.com/#resource-selection


2 changes: 1 addition & 1 deletion documentation/user_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ This is the user guide
:maxdepth: 1
:hidden:


api.rst

0 comments on commit 6decc69

Please sign in to comment.