diff options
author | Katharina Fey <kookie@spacekookie.de> | 2018-06-10 01:47:06 +0200 |
---|---|---|
committer | Katharina Fey <kookie@spacekookie.de> | 2018-06-10 01:47:06 +0200 |
commit | 9a30f0d6036dd8c15cffce11830180fb02529887 (patch) | |
tree | afaba63b48fe55d532d3a4020099caab17eb37cf | |
parent | 6e3f7ece883331ee68a9e24865e59b5b9848627c (diff) |
Adding a version prefix to all API routes
-rw-r--r-- | lockchain-http/README.md | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/lockchain-http/README.md b/lockchain-http/README.md index 2794492..1dc9d0b 100644 --- a/lockchain-http/README.md +++ b/lockchain-http/README.md @@ -25,66 +25,67 @@ Get information about this API endpoint. Information is received in JSON format - `verison`: The API version - `providers`: An array with type providers. This includes the Vault and Body implementation specifics. - `hostname`: Optional value which specifies the server name +- `supported`: A list of supported client/ API combinations, writtin in tuple form. These are auto-generated by the API provider -#### GET /vault +#### GET /{api version}/vault Get a list of vaults known to this system, possibly only returning a single value - `vaults`: List of vault names that are available to work with - `count`: The number of vaults available -#### PUT /vault +#### PUT /{api version}/vault Create a new vault. Payloads - `name`: The name of the vault - `location`: The location of a vault, left to the implementation specifics -#### POST /vault/{id} +#### POST /{api version}/vault/{id} Update metadata about a vault that already exists. Will return an error if it doesn't -#### DELETE /vault/{id} +#### DELETE /{api version}/vault/{id} Delete a vault; a second transaction is required to confirm, after all users were logged-out -#### GET /vault/{vault id}/records/{record id} +#### GET /{api version}/vault/{vault id}/records/{record id} Get a specific record from a vault. Only available if authenticated -#### PUT /vault/{vault id}/records +#### PUT /{api version}/vault/{vault id}/records Add a new record to a vault. Only available if authenticated -#### POST /vault/{vault id}/records/{record id} +#### POST /{api version}/vault/{vault id}/records/{record id} Update data inside an existing record. Only available if authenticated -#### DELETE /vault/{vault id}/records/{record id} +#### DELETE /{api version}/vault/{vault id}/records/{record id} Delete a record. Only available if authenticated -#### GET /users +#### GET /{api version}/users Get a list of available users -#### PUT /users +#### PUT /{api version}/users Create a new user -#### DELETE /users/{id} +#### DELETE /{api version}/users/{id} Delete a user. Only available if authenticated as THAT user. In the future, admin users (and priviledge hirarchies might be added) -#### PUT /authenticate +#### PUT /{api version}/authenticate Authenticate as a specific user - `username`: The user to authenticate as - `password`: The user passphrase to use for authentication (different from the encryption passphrase) -#### PUT /de-authenticate +#### PUT /{api version}/de-authenticate Called to end an active session.
\ No newline at end of file |