diff --git a/docs/_static/w2fm_apis_apikey_get.svg b/docs/_static/w2fm_apis_apikey_get.svg new file mode 100644 index 0000000..086267d --- /dev/null +++ b/docs/_static/w2fm_apis_apikey_get.svg @@ -0,0 +1,3 @@ + + +
GET
GET
SEARCHING FOR ACCESS TOKEN
SEARCHING FOR ACCESS TOKEN
REQUEST
REQUEST
CONTENTS - HTTP 1.1 or 2.0
CONTENTS - HTTP 1.1 or 2.0
HEADER
HEADER
USERNAME
USERNAME
PASSWORD
PASSWORD
BODY
BODY
USERNAME
USERNAME
RESPONSE
RESPONSE
SUCCESS
SUCCESS
BODY
BODY
USERNAME
USERNAME
APIKEY_LIST
APIKEY_LIST
CODE
CODE
200 OK
200 OK
RESPONSE
RESPONSE
FAILURE as USERNAME not provided 
FAILURE as USERNAME not provided 
BODY
BODY
ERROR
ERROR
CODE
CODE
400 Bad Request
400 Bad Request
RESPONSE
RESPONSE
FAILURE as USER is not authorized
FAILURE as USER is not authorized
BODY
BODY
ERROR
ERROR
CODE
CODE
401 Unauthorized
401 Unauthorized
RESPONSE
RESPONSE
FAILURE as USER is not allowed
FAILURE as USER is not allowed
BODY
BODY
ERROR
ERROR
CODE
CODE
403 Forbidden
403 Forbidden
RESPONSE
RESPONSE
FAILURE as USER not found
FAILURE as USER not found
BODY
BODY
ERROR
ERROR
CODE
CODE
404 Not Found
404 Not Found
RESPONSE
RESPONSE
FAILURE as FAILURE
FAILURE as FAILURE
BODY
BODY
ERROR
ERROR
CODE
CODE
500 Internal Server Error
500 Internal Server Error \ No newline at end of file diff --git a/docs/_static/w2fm_apis_apikey_get_all.svg b/docs/_static/w2fm_apis_apikey_get_all.svg new file mode 100644 index 0000000..4d5fcc6 --- /dev/null +++ b/docs/_static/w2fm_apis_apikey_get_all.svg @@ -0,0 +1,3 @@ + + +
GET
GET
LISTING ALL ACCESS TOKENS
LISTING ALL ACCESS TOKENS
REQUEST
REQUEST
CONTENTS - HTTP 1.1 or 2.0
CONTENTS - HTTP 1.1 or 2.0
HEADER
HEADER
USERNAME
USERNAME
PASSWORD
PASSWORD
BODY
BODY
USERNAME
USERNAME
RESPONSE
RESPONSE
SUCCESS
SUCCESS
BODY
BODY
APIKEY_LIST
APIKEY_LIST
CODE
CODE
200 OK
200 OK
RESPONSE
RESPONSE
FAILURE as USERNAME not provided 
FAILURE as USERNAME not provided 
BODY
BODY
ERROR
ERROR
CODE
CODE
400 Bad Request
400 Bad Request
RESPONSE
RESPONSE
FAILURE as USER is not authorized
FAILURE as USER is not authorized
BODY
BODY
ERROR
ERROR
CODE
CODE
401 Unauthorized
401 Unauthorized
RESPONSE
RESPONSE
FAILURE as USER is not allowed
FAILURE as USER is not allowed
BODY
BODY
ERROR
ERROR
CODE
CODE
403 Forbidden
403 Forbidden
RESPONSE
RESPONSE
FAILURE as USER not found
FAILURE as USER not found
BODY
BODY
ERROR
ERROR
CODE
CODE
404 Not Found
404 Not Found
RESPONSE
RESPONSE
FAILURE as FAILURE
FAILURE as FAILURE
BODY
BODY
ERROR
ERROR
CODE
CODE
500 Internal Server Error
500 Internal Server Error \ No newline at end of file diff --git a/docs/_static/w2fm_apis_apikey_get_one.svg b/docs/_static/w2fm_apis_apikey_get_one.svg new file mode 100644 index 0000000..400837d --- /dev/null +++ b/docs/_static/w2fm_apis_apikey_get_one.svg @@ -0,0 +1,3 @@ + + +
GET
GET
LOOKING UP AN ACCESS TOKEN
LOOKING UP AN ACCESS TOKEN
REQUEST
REQUEST
CONTENTS - HTTP 1.1 or 2.0
CONTENTS - HTTP 1.1 or 2.0
HEADER
HEADER
USERNAME
USERNAME
PASSWORD
PASSWORD
BODY
BODY
APIKEY_UUID
APIKEY_UUID
RESPONSE
RESPONSE
SUCCESS
SUCCESS
BODY
BODY
UUID
UUID
NAME
NAME
VALID_FROM
VALID_FROM
VALID_TILL
VALID_TILL
IS_VALID
IS_VALID
CODE
CODE
200 OK
200 OK
RESPONSE
RESPONSE
FAILURE as USERNAME not provided 
FAILURE as USERNAME not provided 
BODY
BODY
ERROR
ERROR
CODE
CODE
400 Bad Request
400 Bad Request
RESPONSE
RESPONSE
FAILURE as USER is not authorized
FAILURE as USER is not authorized
BODY
BODY
ERROR
ERROR
CODE
CODE
401 Unauthorized
401 Unauthorized
RESPONSE
RESPONSE
FAILURE as USER is not allowed
FAILURE as USER is not allowed
BODY
BODY
ERROR
ERROR
CODE
CODE
403 Forbidden
403 Forbidden
RESPONSE
RESPONSE
FAILURE as APIKEY_UUID not found
FAILURE as APIKEY_UUID not found
BODY
BODY
ERROR
ERROR
CODE
CODE
404 Not Found
404 Not Found
RESPONSE
RESPONSE
FAILURE as FAILURE
FAILURE as FAILURE
BODY
BODY
ERROR
ERROR
CODE
CODE
500 Internal Server Error
500 Internal Server Error \ No newline at end of file diff --git a/docs/_static/w2fm_apis_apikey_post.svg b/docs/_static/w2fm_apis_apikey_post.svg new file mode 100644 index 0000000..6355f36 --- /dev/null +++ b/docs/_static/w2fm_apis_apikey_post.svg @@ -0,0 +1,3 @@ + + +
POST
POST
CREATING NEW ACCESS TOKEN
CREATING NEW ACCESS TOKEN
REQUEST
REQUEST
CONTENTS - HTTP 1.1 or 2.0
CONTENTS - HTTP 1.1 or 2.0
HEADER
HEADER
USERNAME
USERNAME
PASSWORD
PASSWORD
BODY
BODY
USERNAME
USERNAME
VALID_TILL
VALID_TILL
NAME
NAME
RESPONSE
RESPONSE
SUCCESS
SUCCESS
BODY
BODY
UUID
UUID
CODE
CODE
CODE
CODE
201 Created
201 Created
RESPONSE
RESPONSE
FAILURE as USERNAME not provided
FAILURE as USERNAME not provided
BODY
BODY
ERROR
ERROR
CODE
CODE
400 Bad Request
400 Bad Request
RESPONSE
RESPONSE
FAILURE as USER is not authorized
FAILURE as USER is not authorized
BODY
BODY
ERROR
ERROR
CODE
CODE
401 Unauthorized
401 Unauthorized
RESPONSE
RESPONSE
FAILURE as USER is not allowed
FAILURE as USER is not allowed
BODY
BODY
ERROR
ERROR
CODE
CODE
403 Forbidden
403 Forbidden
RESPONSE
RESPONSE
FAILURE as APIKEY already exists
FAILURE as APIKEY already exists
BODY
BODY
ERROR
ERROR
CODE
CODE
409 Conflict
409 Conflict
RESPONSE
RESPONSE
FAILURE as FAILURE
FAILURE as FAILURE
BODY
BODY
ERROR
ERROR
CODE
CODE
500 Internal Server Error
500 Internal Server Error \ No newline at end of file diff --git a/docs/_static/w2fm_apis_apikey_put.svg b/docs/_static/w2fm_apis_apikey_put.svg new file mode 100644 index 0000000..8bb7854 --- /dev/null +++ b/docs/_static/w2fm_apis_apikey_put.svg @@ -0,0 +1,3 @@ + + +
PUT
PUT
REVOKING AN ACCESS TOKEN
REVOKING AN ACCESS TOKEN
REQUEST
REQUEST
CONTENTS - HTTP 1.1 or 2.0
CONTENTS - HTTP 1.1 or 2.0
HEADER
HEADER
USERNAME
USERNAME
PASSWORD
PASSWORD
BODY
BODY
USERNAME
USERNAME
APIKEY_UUID
APIKEY_UUID
RESPONSE
RESPONSE
SUCCESS
SUCCESS
BODY
BODY
UUID
UUID
IS_VALID
IS_VALID
CODE
CODE
200 OK
200 OK
RESPONSE
RESPONSE
FAILURE as USERNAME not found
FAILURE as USERNAME not found
BODY
BODY
ERROR
ERROR
CODE
CODE
400 Bad Request
400 Bad Request
RESPONSE
RESPONSE
FAILURE as USER is not authorized
FAILURE as USER is not authorized
BODY
BODY
ERROR
ERROR
CODE
CODE
401 Unauthorized
401 Unauthorized
RESPONSE
RESPONSE
FAILURE as USER is not allowed
FAILURE as USER is not allowed
BODY
BODY
ERROR
ERROR
CODE
CODE
403 Forbidden
403 Forbidden
RESPONSE
RESPONSE
FAILURE as APIKEY not found
FAILURE as APIKEY not found
BODY
BODY
ERROR
ERROR
CODE
CODE
400 Bad Request
400 Bad Request
RESPONSE
RESPONSE
FAILURE as FAILURE
FAILURE as FAILURE
BODY
BODY
ERROR
ERROR
CODE
CODE
500 Internal Server Error
500 Internal Server Error \ No newline at end of file diff --git a/docs/_static/w2fm_apis_message_post.svg b/docs/_static/w2fm_apis_message_post.svg new file mode 100644 index 0000000..b36e6fa --- /dev/null +++ b/docs/_static/w2fm_apis_message_post.svg @@ -0,0 +1,3 @@ + + +
POST
POST
INVOKING AN EVENT
INVOKING AN EVENT
REQUEST
REQUEST
CONTENTS - HTTP 1.1 or 2.0
CONTENTS - HTTP 1.1 or 2.0
HEADER
HEADER
USERNAME
USERNAME
PASSWORD
PASSWORD
BODY
BODY
SERVICE_UUID
SERVICE_UUID
MESG_TOPIC
MESG_TOPIC
MESG_STORY
MESG_STORY
RESPONSE
RESPONSE
SUCCESS
SUCCESS
BODY
BODY
UUID
UUID
DIGEST
DIGEST
CODE
CODE
200 OK
200 OK
RESPONSE
RESPONSE
FAILURE as SERVICE not found
FAILURE as SERVICE not found
BODY
BODY
ERROR
ERROR
CODE
CODE
400 Bad Request
400 Bad Request
RESPONSE
RESPONSE
FAILURE as USER is not authorized
FAILURE as USER is not authorized
BODY
BODY
ERROR
ERROR
CODE
CODE
401 Unauthorized
401 Unauthorized
RESPONSE
RESPONSE
FAILURE as USER is not allowed
FAILURE as USER is not allowed
BODY
BODY
ERROR
ERROR
CODE
CODE
403 Forbidden
403 Forbidden
RESPONSE
RESPONSE
FAILURE as UUID already exists
FAILURE as UUID already exists
BODY
BODY
ERROR
ERROR
CODE
CODE
409 Conflict
409 Conflict
RESPONSE
RESPONSE
FAILURE as FAILURE
FAILURE as FAILURE
BODY
BODY
ERROR
ERROR
CODE
CODE
500 Internal Server Error
500 Internal Server Error \ No newline at end of file diff --git a/docs/_static/w2fm_apis_service_get_all.svg b/docs/_static/w2fm_apis_service_get_all.svg new file mode 100644 index 0000000..f2b3470 --- /dev/null +++ b/docs/_static/w2fm_apis_service_get_all.svg @@ -0,0 +1,3 @@ + + +
GET
GET
LISTING ALL SERVICES
LISTING ALL SERVICES
REQUEST
REQUEST
CONTENTS - HTTP 1.1 or 2.0
CONTENTS - HTTP 1.1 or 2.0
HEADER
HEADER
USERNAME
USERNAME
PASSWORD
PASSWORD
BODY
BODY
USERNAME
USERNAME
RESPONSE
RESPONSE
SUCCESS
SUCCESS
BODY
BODY
SERVICE_LIST
SERVICE_LIST
CODE
CODE
200 OK
200 OK
RESPONSE
RESPONSE
FAILURE as USERNAME not provided 
FAILURE as USERNAME not provided 
BODY
BODY
ERROR
ERROR
CODE
CODE
400 Bad Request
400 Bad Request
RESPONSE
RESPONSE
FAILURE as USER is not authorized
FAILURE as USER is not authorized
BODY
BODY
ERROR
ERROR
CODE
CODE
401 Unauthorized
401 Unauthorized
RESPONSE
RESPONSE
FAILURE as USER is not allowed
FAILURE as USER is not allowed
BODY
BODY
ERROR
ERROR
CODE
CODE
403 Forbidden
403 Forbidden
RESPONSE
RESPONSE
FAILURE as USER not found
FAILURE as USER not found
BODY
BODY
ERROR
ERROR
CODE
CODE
404 Not Found
404 Not Found
RESPONSE
RESPONSE
FAILURE as FAILURE
FAILURE as FAILURE
BODY
BODY
ERROR
ERROR
CODE
CODE
500 Internal Server Error
500 Internal Server Error \ No newline at end of file diff --git a/docs/_static/w2fm_apis_service_get_one.svg b/docs/_static/w2fm_apis_service_get_one.svg new file mode 100644 index 0000000..8c63520 --- /dev/null +++ b/docs/_static/w2fm_apis_service_get_one.svg @@ -0,0 +1,3 @@ + + +
GET
GET
LOOKING UP A SERVICE
LOOKING UP A SERVICE
REQUEST
REQUEST
CONTENTS - HTTP 1.1 or 2.0
CONTENTS - HTTP 1.1 or 2.0
HEADER
HEADER
USERNAME
USERNAME
PASSWORD
PASSWORD
BODY
BODY
SERVICE_UUID
SERVICE_UUID
RESPONSE
RESPONSE
SUCCESS
SUCCESS
BODY
BODY
UUID
UUID
NAME
NAME
MESG_TOPIC
MESG_TOPIC
MESG_STORY
MESG_STORY
IS_VALID
IS_VALID
CREATION_DATE
CREATION_DATE
CODE
CODE
200 OK
200 OK
RESPONSE
RESPONSE
FAILURE as UUID not provided 
FAILURE as UUID not provided 
BODY
BODY
ERROR
ERROR
CODE
CODE
400 Bad Request
400 Bad Request
RESPONSE
RESPONSE
FAILURE as USER is not authorized
FAILURE as USER is not authorized
BODY
BODY
ERROR
ERROR
CODE
CODE
401 Unauthorized
401 Unauthorized
RESPONSE
RESPONSE
FAILURE as USER is not allowed
FAILURE as USER is not allowed
BODY
BODY
ERROR
ERROR
CODE
CODE
403 Forbidden
403 Forbidden
RESPONSE
RESPONSE
FAILURE as SERVICE not found
FAILURE as SERVICE not found
BODY
BODY
ERROR
ERROR
CODE
CODE
404 Not Found
404 Not Found
RESPONSE
RESPONSE
FAILURE as FAILURE
FAILURE as FAILURE
BODY
BODY
ERROR
ERROR
CODE
CODE
500 Internal Server Error
500 Internal Server Error \ No newline at end of file diff --git a/docs/_static/w2fm_apis_service_post.svg b/docs/_static/w2fm_apis_service_post.svg new file mode 100644 index 0000000..7431d60 --- /dev/null +++ b/docs/_static/w2fm_apis_service_post.svg @@ -0,0 +1,3 @@ + + +
POST
POST
CREATING NEW SERVICE
CREATING NEW SERVICE
REQUEST
REQUEST
CONTENTS - HTTP 1.1 or 2.0
CONTENTS - HTTP 1.1 or 2.0
HEADER
HEADER
USERNAME
USERNAME
PASSWORD
PASSWORD
BODY
BODY
USERNAME
USERNAME
NAME
NAME
MESG_HEAD
MESG_HEAD
MESG_BODY
MESG_BODY
RESPONSE
RESPONSE
SUCCESS
SUCCESS
BODY
BODY
UUID
UUID
CODE
CODE
201 Created
201 Created
RESPONSE
RESPONSE
FAILURE as USERNAME not found
FAILURE as USERNAME not found
BODY
BODY
ERROR
ERROR
CODE
CODE
400 Bad Request
400 Bad Request
RESPONSE
RESPONSE
FAILURE as USER is not authorized
FAILURE as USER is not authorized
BODY
BODY
ERROR
ERROR
CODE
CODE
401 Unauthorized
401 Unauthorized
RESPONSE
RESPONSE
FAILURE as USER is not allowed
FAILURE as USER is not allowed
BODY
BODY
ERROR
ERROR
CODE
CODE
403 Forbidden
403 Forbidden
RESPONSE
RESPONSE
FAILURE as UUID already exists
FAILURE as UUID already exists
BODY
BODY
ERROR
ERROR
CODE
CODE
409 Conflict
409 Conflict
RESPONSE
RESPONSE
FAILURE as FAILURE
FAILURE as FAILURE
BODY
BODY
ERROR
ERROR
CODE
CODE
500 Internal Server Error
500 Internal Server Error \ No newline at end of file diff --git a/docs/_static/w2fm_apis_service_put_revoke.svg b/docs/_static/w2fm_apis_service_put_revoke.svg new file mode 100644 index 0000000..4c27259 --- /dev/null +++ b/docs/_static/w2fm_apis_service_put_revoke.svg @@ -0,0 +1,3 @@ + + +
PUT
PUT
REVOKING A SERVICE
REVOKING A SERVICE
REQUEST
REQUEST
CONTENTS - HTTP 1.1 or 2.0
CONTENTS - HTTP 1.1 or 2.0
HEADER
HEADER
USERNAME
USERNAME
PASSWORD
PASSWORD
BODY
BODY
USERNAME
USERNAME
APIKEY_UUID
APIKEY_UUID
RESPONSE
RESPONSE
SUCCESS
SUCCESS
BODY
BODY
UUID
UUID
IS_VALID
IS_VALID
CODE
CODE
200 OK
200 OK
RESPONSE
RESPONSE
FAILURE as USERNAME not found
FAILURE as USERNAME not found
BODY
BODY
ERROR
ERROR
CODE
CODE
400 Bad Request
400 Bad Request
RESPONSE
RESPONSE
FAILURE as USER is not authorized
FAILURE as USER is not authorized
BODY
BODY
ERROR
ERROR
CODE
CODE
401 Unauthorized
401 Unauthorized
RESPONSE
RESPONSE
FAILURE as USER is not allowed
FAILURE as USER is not allowed
BODY
BODY
ERROR
ERROR
CODE
CODE
403 Forbidden
403 Forbidden
RESPONSE
RESPONSE
FAILURE as APIKEY not found
FAILURE as APIKEY not found
BODY
BODY
ERROR
ERROR
CODE
CODE
400 Bad Request
400 Bad Request
RESPONSE
RESPONSE
FAILURE as FAILURE
FAILURE as FAILURE
BODY
BODY
ERROR
ERROR
CODE
CODE
500 Internal Server Error
500 Internal Server Error \ No newline at end of file diff --git a/docs/_static/w2fm_apis_service_put_update.svg b/docs/_static/w2fm_apis_service_put_update.svg new file mode 100644 index 0000000..f415118 --- /dev/null +++ b/docs/_static/w2fm_apis_service_put_update.svg @@ -0,0 +1,3 @@ + + +
PUT
PUT
UPDATING A SERVICE
UPDATING A SERVICE
REQUEST
REQUEST
CONTENTS - HTTP 1.1 or 2.0
CONTENTS - HTTP 1.1 or 2.0
HEADER
HEADER
USERNAME
USERNAME
PASSWORD
PASSWORD
BODY
BODY
UUID
UUID
NAME
NAME
MESG_HEAD
MESG_HEAD
MESG_BODY
MESG_BODY
IS_VALID
IS_VALID
RESPONSE
RESPONSE
SUCCESS
SUCCESS
BODY
BODY
UUID
UUID
NAME
NAME
MESG_HEAD
MESG_HEAD
MESG_BODY
MESG_BODY
IS_VALID
IS_VALID
CODE
CODE
200 OK
200 OK
RESPONSE
RESPONSE
FAILURE as USERNAME not found
FAILURE as USERNAME not found
BODY
BODY
ERROR
ERROR
CODE
CODE
400 Bad Request
400 Bad Request
RESPONSE
RESPONSE
FAILURE as USER is not authorized
FAILURE as USER is not authorized
BODY
BODY
ERROR
ERROR
CODE
CODE
401 Unauthorized
401 Unauthorized
RESPONSE
RESPONSE
FAILURE as USER is not allowed
FAILURE as USER is not allowed
BODY
BODY
ERROR
ERROR
CODE
CODE
403 Forbidden
403 Forbidden
RESPONSE
RESPONSE
FAILURE as APIKEY not found
FAILURE as APIKEY not found
BODY
BODY
ERROR
ERROR
CODE
CODE
400 Bad Request
400 Bad Request
RESPONSE
RESPONSE
FAILURE as FAILURE
FAILURE as FAILURE
BODY
BODY
ERROR
ERROR
CODE
CODE
500 Internal Server Error
500 Internal Server Error \ No newline at end of file diff --git a/docs/_static/w2fm_apis_user_get_many.svg b/docs/_static/w2fm_apis_user_get_many.svg new file mode 100644 index 0000000..52256d9 --- /dev/null +++ b/docs/_static/w2fm_apis_user_get_many.svg @@ -0,0 +1,3 @@ + + +
GET
GET
SEARCHING FOR USERNAMES
SEARCHING FOR USERNAMES
REQUEST
REQUEST
CONTENTS - HTTP 1.1 or 2.0
CONTENTS - HTTP 1.1 or 2.0
HEADER
HEADER
USERNAME
USERNAME
PASSWORD
PASSWORD
BODY
BODY
SEARCH_STRING
SEARCH_STRING
RESPONSE
RESPONSE
SUCCESS
SUCCESS
BODY
BODY
USER_LIST
USER_LIST
CODE
CODE
200 OK
200 OK
RESPONSE
RESPONSE
FAILURE as USERNAME not provided 
FAILURE as USERNAME not provided 
BODY
BODY
ERROR
ERROR
CODE
CODE
400 Bad Request
400 Bad Request
RESPONSE
RESPONSE
FAILURE as USER is not authorized
FAILURE as USER is not authorized
BODY
BODY
ERROR
ERROR
CODE
CODE
401 Unauthorized
401 Unauthorized
RESPONSE
RESPONSE
FAILURE as USER is not allowed
FAILURE as USER is not allowed
BODY
BODY
ERROR
ERROR
CODE
CODE
403 Forbidden
403 Forbidden
RESPONSE
RESPONSE
FAILURE as USER not found
FAILURE as USER not found
BODY
BODY
ERROR
ERROR
CODE
CODE
404 Not Found
404 Not Found
RESPONSE
RESPONSE
FAILURE as FAILURE
FAILURE as FAILURE
BODY
BODY
ERROR
ERROR
CODE
CODE
500 Internal Server Error
500 Internal Server Error \ No newline at end of file diff --git a/docs/_static/w2fm_apis_user_get_one.svg b/docs/_static/w2fm_apis_user_get_one.svg new file mode 100644 index 0000000..0298b88 --- /dev/null +++ b/docs/_static/w2fm_apis_user_get_one.svg @@ -0,0 +1,3 @@ + + +
GET
GET
LOOKING FOR A USERNAME
LOOKING FOR A USERNAME
REQUEST
REQUEST
CONTENTS - HTTP 1.1 or 2.0
CONTENTS - HTTP 1.1 or 2.0
HEADER
HEADER
USERNAME
USERNAME
PASSWORD
PASSWORD
BODY
BODY
USERNAME
USERNAME
RESPONSE
RESPONSE
SUCCESS
SUCCESS
BODY
BODY
UUID
UUID
USERNAME
USERNAME
CODE
CODE
200 OK
200 OK
RESPONSE
RESPONSE
FAILURE as USERNAME not provided 
FAILURE as USERNAME not provided 
BODY
BODY
ERROR
ERROR
CODE
CODE
400 Bad Request
400 Bad Request
RESPONSE
RESPONSE
FAILURE as USER is not authorized
FAILURE as USER is not authorized
BODY
BODY
ERROR
ERROR
CODE
CODE
401 Unauthorized
401 Unauthorized
RESPONSE
RESPONSE
FAILURE as USER is not allowed
FAILURE as USER is not allowed
BODY
BODY
ERROR
ERROR
CODE
CODE
403 Forbidden
403 Forbidden
RESPONSE
RESPONSE
FAILURE as USER not found
FAILURE as USER not found
BODY
BODY
ERROR
ERROR
CODE
CODE
404 Not Found
404 Not Found
RESPONSE
RESPONSE
FAILURE as FAILURE
FAILURE as FAILURE
BODY
BODY
ERROR
ERROR
CODE
CODE
500 Internal Server Error
500 Internal Server Error \ No newline at end of file diff --git a/docs/_static/w2fm_apis_user_post.svg b/docs/_static/w2fm_apis_user_post.svg new file mode 100644 index 0000000..5a9e670 --- /dev/null +++ b/docs/_static/w2fm_apis_user_post.svg @@ -0,0 +1,3 @@ + + +
POST
POST
CREATING NEW USER
CREATING NEW USER
REQUEST
REQUEST
CONTENTS - HTTP 1.1 or 2.0
CONTENTS - HTTP 1.1 or 2.0
HEADER
HEADER
USERNAME
USERNAME
PASSWORD
PASSWORD
BODY
BODY
USERNAME
USERNAME
RESPONSE
RESPONSE
SUCCESS
SUCCESS
BODY
BODY
UUID
UUID
CODE
CODE
201 Created
201 Created
RESPONSE
RESPONSE
FAILURE as USERNAME not provided 
FAILURE as USERNAME not provided 
BODY
BODY
ERROR
ERROR
CODE
CODE
400 Bad Request
400 Bad Request
RESPONSE
RESPONSE
FAILURE as USER is not authorized
FAILURE as USER is not authorized
BODY
BODY
ERROR
ERROR
CODE
CODE
401 Unauthorized
401 Unauthorized
RESPONSE
RESPONSE
FAILURE as USER is not allowed
FAILURE as USER is not allowed
BODY
BODY
ERROR
ERROR
CODE
CODE
403 Forbidden
403 Forbidden
RESPONSE
RESPONSE
FAILURE as USER already exists
FAILURE as USER already exists
BODY
BODY
ERROR
ERROR
CODE
CODE
409 Conflict
409 Conflict
RESPONSE
RESPONSE
FAILURE as FAILURE
FAILURE as FAILURE
BODY
BODY
ERROR
ERROR
CODE
CODE
500 Internal Server Error
500 Internal Server Error \ No newline at end of file diff --git a/docs/webhook2fedmsg/apis.rst b/docs/webhook2fedmsg/apis.rst new file mode 100644 index 0000000..b99292a --- /dev/null +++ b/docs/webhook2fedmsg/apis.rst @@ -0,0 +1,228 @@ +.. _apis: + +API service +=========== + +Interactions involved +--------------------- + +Following are the interactions possible with the entities mentioned before +using the API service. + +USER +^^^^ + +Creating new user +""""""""""""""""" + +.. image:: ../_static/w2fm_apis_user_post.svg + :target: ../_images/w2fm_apis_user_post.svg + +**PATH** - ``/user/`` + +**METHOD** - ``POST`` + +**NOTES** + - This can be used to create new user entry by filling in the username + and is auto-triggered when first login is made. + - The ``username`` and ``password`` provided in the header section must + belong to a user entry with elevated privileges. + +Searching for usernames +""""""""""""""""""""""" + +.. image:: ../_static/w2fm_apis_user_get_many.svg + :target: ../_images/w2fm_apis_user_get_many.svg + +**PATH** - ``/user/search`` + +**METHOD** - ``GET`` + +**NOTES** + - This can be used to search for users from the pool of existing users + depending on the the username provided. + - The ``username`` and ``password`` provided in the header section must + belong to an already existing user entry. + +Looking up a username +""""""""""""""""""""" + +.. image:: ../_static/w2fm_apis_user_get_one.svg + :target: ../_images/w2fm_apis_user_get_one.svg + +**PATH** - ``/user/`` + +**METHOD** - ``GET`` + +**NOTES** + - This can be used to view the details associated with a certain existing + user entry depending on the username provided. + - The ``username`` and ``password`` provided in the header section must + belong to an already existing user entry. + +APIKEY +^^^^^^ + +Creating new access token +""""""""""""""""""""""""" + +.. image:: ../_static/w2fm_apis_apikey_post.svg + :target: ../_images/w2fm_apis_apikey_post.svg + +**PATH** - ``/apikey/`` + +**METHOD** - ``POST`` + +**NOTES** + - This can be used to create new access token by filling in the usage + purpose (optional) and the associated expiry date. + - The ``username`` and ``password`` provided in the header section must + belong to the same ``username`` in the body section. + +Listing all access tokens +""""""""""""""""""""""""" + +.. image:: ../_static/w2fm_apis_apikey_get_all.svg + :target: ../_images/w2fm_apis_apikey_get_all.svg + +**PATH** - ``/apikey/search`` + +**METHOD** - ``GET`` + +**NOTES** + - This can be used to list all the existing access tokens associated + with a certain user that those belong to. + - The ``username`` and ``password`` provided in the header section must + belong to the same ``username`` in the body section. + +Looking up an access token +"""""""""""""""""""""""""" + +.. image:: ../_static/w2fm_apis_apikey_get_one.svg + :target: ../_images/w2fm_apis_apikey_get_one.svg + +**PATH** - ``/apikey/`` + +**METHOD** - ``GET`` + +**NOTES** + - This can be used to view the details associated with a certain existing + access token for the user that it belongs to. + - The ``username`` and ``password`` provided in the header section must + belong to the same ``username`` in the body section. + +Revoking an access token +"""""""""""""""""""""""" + +.. image:: ../_static/w2fm_apis_apikey_put.svg + :target: ../_images/w2fm_apis_apikey_put.svg + +**PATH** - ``/apikey/revoke`` + +**METHOD** - ``PUT`` + +**NOTES** + - This can be used to revoke the validity of an existing access token to + ensure that the access token can no longer be used. + - The ``username`` and ``password`` provided in the header section must + belong to the same ``username`` in the body section. + +SERVICE +^^^^^^^ + +Creating new service +"""""""""""""""""""" + +.. image:: ../_static/w2fm_apis_service_post.svg + :target: ../_images/w2fm_apis_service_post.svg + +**PATH** - ``/service/`` + +**METHOD** - ``POST`` + +**NOTES** + - This can be used to create new service by filling in the the message + topic, message body, service validity and service name. + - The ``username`` and ``password`` provided in the header section must + belong to the same ``username`` in the body section. + +Listing all services +"""""""""""""""""""" + +.. image:: ../_static/w2fm_apis_service_get_all.svg + :target: ../_images/w2fm_apis_service_get_all.svg + +**PATH** - ``/service/search`` + +**METHOD** - ``GET`` + +**NOTES** + - This can be used to list all the existing service entries associated + with a certain user that those belong to. + - The ``username`` and ``password`` provided in the header section must + belong to the same ``username`` in the body section. + +Looking up a service +"""""""""""""""""""" + +.. image:: ../_static/w2fm_apis_service_get_one.svg + :target: ../_images/w2fm_apis_service_get_one.svg + +**PATH** - ``/service/`` + +**METHOD** - ``GET`` + +**NOTES** + - This can be used to view the details associated with a certain existing + service for the user that it belongs to. + - The ``username`` and ``password`` provided in the header section must + belong to the same ``username`` in the body section. + +Revoking a service +"""""""""""""""""" + +.. image:: ../_static/w2fm_apis_service_put_revoke.svg + :target: ../_images/w2fm_apis_service_put_revoke.svg + +**PATH** - ``/service/revoke`` + +**METHOD** - ``PUT`` + +**NOTES** + - This can be used to revoke the validity of an existing service to ensure + that the service can no longer be used. + - The ``username`` and ``password`` provided in the header section must + belong to the same ``username`` in the body section. + +Updating a service +"""""""""""""""""" + +.. image:: ../_static/w2fm_apis_service_put_update.svg + :target: ../_images/w2fm_apis_service_put_update.svg + +**PATH** - ``/service/`` + +**METHOD** - ``PUT`` + +**NOTES** + - This can be used to update the message topic, message body, service + validity and service name of an existing service. + - The ``username`` and ``password`` provided in the header section must + belong to the same ``username`` in the body section. + +MESSAGE +^^^^^^^ + +Invoking an event +""""""""""""""""" + +.. image:: ../_static/w2fm_apis_message_post.svg + :target: ../_images/w2fm_apis_message_post.svg + +**PATH** - ``/message/`` + +**METHOD** - ``POST`` + +**NOTES** + - The ``username`` and ``password`` provided in the header section must + belong to the same ``username`` in the body section. diff --git a/docs/webhook2fedmsg/w2fm-dber.drawio b/docs/webhook2fedmsg/diagrams/w2fm-dber.drawio similarity index 100% rename from docs/webhook2fedmsg/w2fm-dber.drawio rename to docs/webhook2fedmsg/diagrams/w2fm-dber.drawio diff --git a/docs/webhook2fedmsg/diagrams/w2fm_apis_apikey_get_all.drawio b/docs/webhook2fedmsg/diagrams/w2fm_apis_apikey_get_all.drawio new file mode 100644 index 0000000..b0b215c --- /dev/null +++ b/docs/webhook2fedmsg/diagrams/w2fm_apis_apikey_get_all.drawio @@ -0,0 +1,186 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/webhook2fedmsg/diagrams/w2fm_apis_apikey_get_one.drawio b/docs/webhook2fedmsg/diagrams/w2fm_apis_apikey_get_one.drawio new file mode 100644 index 0000000..ceaabe8 --- /dev/null +++ b/docs/webhook2fedmsg/diagrams/w2fm_apis_apikey_get_one.drawio @@ -0,0 +1,198 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/webhook2fedmsg/diagrams/w2fm_apis_apikey_post.drawio b/docs/webhook2fedmsg/diagrams/w2fm_apis_apikey_post.drawio new file mode 100644 index 0000000..03215bf --- /dev/null +++ b/docs/webhook2fedmsg/diagrams/w2fm_apis_apikey_post.drawio @@ -0,0 +1,195 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/webhook2fedmsg/diagrams/w2fm_apis_apikey_put.drawio b/docs/webhook2fedmsg/diagrams/w2fm_apis_apikey_put.drawio new file mode 100644 index 0000000..7528d36 --- /dev/null +++ b/docs/webhook2fedmsg/diagrams/w2fm_apis_apikey_put.drawio @@ -0,0 +1,192 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/webhook2fedmsg/diagrams/w2fm_apis_message_post.drawio b/docs/webhook2fedmsg/diagrams/w2fm_apis_message_post.drawio new file mode 100644 index 0000000..d558ff8 --- /dev/null +++ b/docs/webhook2fedmsg/diagrams/w2fm_apis_message_post.drawio @@ -0,0 +1,195 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/webhook2fedmsg/diagrams/w2fm_apis_service_get_all.drawio b/docs/webhook2fedmsg/diagrams/w2fm_apis_service_get_all.drawio new file mode 100644 index 0000000..2fa6dcb --- /dev/null +++ b/docs/webhook2fedmsg/diagrams/w2fm_apis_service_get_all.drawio @@ -0,0 +1,186 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/webhook2fedmsg/diagrams/w2fm_apis_service_get_one.drawio b/docs/webhook2fedmsg/diagrams/w2fm_apis_service_get_one.drawio new file mode 100644 index 0000000..3c52b7f --- /dev/null +++ b/docs/webhook2fedmsg/diagrams/w2fm_apis_service_get_one.drawio @@ -0,0 +1,201 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/webhook2fedmsg/diagrams/w2fm_apis_service_post.drawio b/docs/webhook2fedmsg/diagrams/w2fm_apis_service_post.drawio new file mode 100644 index 0000000..942d355 --- /dev/null +++ b/docs/webhook2fedmsg/diagrams/w2fm_apis_service_post.drawio @@ -0,0 +1,195 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/webhook2fedmsg/diagrams/w2fm_apis_service_put_revoke.drawio b/docs/webhook2fedmsg/diagrams/w2fm_apis_service_put_revoke.drawio new file mode 100644 index 0000000..fd67eec --- /dev/null +++ b/docs/webhook2fedmsg/diagrams/w2fm_apis_service_put_revoke.drawio @@ -0,0 +1,192 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/webhook2fedmsg/diagrams/w2fm_apis_service_put_update.drawio b/docs/webhook2fedmsg/diagrams/w2fm_apis_service_put_update.drawio new file mode 100644 index 0000000..0700e7d --- /dev/null +++ b/docs/webhook2fedmsg/diagrams/w2fm_apis_service_put_update.drawio @@ -0,0 +1,210 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/webhook2fedmsg/diagrams/w2fm_apis_user_get_many.drawio b/docs/webhook2fedmsg/diagrams/w2fm_apis_user_get_many.drawio new file mode 100644 index 0000000..732441a --- /dev/null +++ b/docs/webhook2fedmsg/diagrams/w2fm_apis_user_get_many.drawio @@ -0,0 +1,186 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/webhook2fedmsg/diagrams/w2fm_apis_user_get_one.drawio b/docs/webhook2fedmsg/diagrams/w2fm_apis_user_get_one.drawio new file mode 100644 index 0000000..6cd7aca --- /dev/null +++ b/docs/webhook2fedmsg/diagrams/w2fm_apis_user_get_one.drawio @@ -0,0 +1,189 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/webhook2fedmsg/diagrams/w2fm_apis_user_post.drawio b/docs/webhook2fedmsg/diagrams/w2fm_apis_user_post.drawio new file mode 100644 index 0000000..b233c21 --- /dev/null +++ b/docs/webhook2fedmsg/diagrams/w2fm_apis_user_post.drawio @@ -0,0 +1,186 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +