[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnunet-rest-api] branch master updated: update version
|
From: |
gnunet |
|
Subject: |
[gnunet-rest-api] branch master updated: update version |
|
Date: |
Fri, 14 Feb 2020 11:11:04 +0100 |
This is an automated email from the git hooks/post-receive script.
martin-schanzenbach pushed a commit to branch master
in repository gnunet-rest-api.
The following commit(s) were added to refs/heads/master by this push:
new 890dd25 update version
890dd25 is described below
commit 890dd25d456a6ef6605c7ef63b67447f05a3e4c5
Author: Schanzenbach, Martin <address@hidden>
AuthorDate: Fri Feb 14 11:07:12 2020 +0100
update version
---
source/conf.py | 4 +-
source/identity.rst | 138 +++++++++++++++++++++++++++-------------------------
2 files changed, 73 insertions(+), 69 deletions(-)
diff --git a/source/conf.py b/source/conf.py
index fb03739..8cf2006 100644
--- a/source/conf.py
+++ b/source/conf.py
@@ -24,9 +24,9 @@ copyright = '2019, GNUnet e.V.'
author = 'Philippe Buschmann, Martin Schanzenbach'
# The short X.Y version
-version = '0.11.7'
+version = '0.12.3'
# The full version, including alpha/beta/rc tags
-release = '0.11.7'
+release = '0.12.3'
# -- General configuration ---------------------------------------------------
diff --git a/source/identity.rst b/source/identity.rst
index ebc824a..8474e71 100644
--- a/source/identity.rst
+++ b/source/identity.rst
@@ -17,8 +17,12 @@ Variables in single quotes ``'...'`` can or must be changed
according to your sp
Identity
--------
-An identity consists of a ``public key`` and a ``name``. An identity can be
assigned to a ``subsystem``. Each subsystem can only have one default identity.
+An ``Identity`` consists of a ``public key`` and a ``name``. An identity can
be assigned to a ``subsystem``. Each subsystem can only have one default
identity. ::
+ {
+ "public_key": string,
+ "name": string
+ }
Error Response
--------------
@@ -63,23 +67,23 @@ Requests
Retrieve identities
-------------------
-+--------------------+---------------------------------------------------------------+
-|**Title** |Returns all identities with name and public key
|
-+--------------------+---------------------------------------------------------------+
-|**URL** |:literal:`/identity/all`
|
-+--------------------+---------------------------------------------------------------+
-|**Method** |**GET**
|
-+--------------------+---------------------------------------------------------------+
-|**URL Params** |none
|
-+--------------------+---------------------------------------------------------------+
-|**Data Params** |none
|
-+--------------------+---------------------------------------------------------------+
-|**Success Response**|[{"pubkey":"*public_key*", "name":"*name*"},...]
|
-+--------------------+---------------------------------------------------------------+
-|**Error Response** | {"error":"*error_desc*"} :sup:`2`
|
-+--------------------+---------------------------------------------------------------+
-|**Attention** | The response in this request is an array!
|
-+--------------------+---------------------------------------------------------------+
++--------------------+-----------------------------------------------+
+|**Title** |Returns all identities with name and public key|
++--------------------+-----------------------------------------------+
+|**URL** |:literal:`/identity/` |
++--------------------+-----------------------------------------------+
+|**Method** |**GET** |
++--------------------+-----------------------------------------------+
+|**URL Params** |none |
++--------------------+-----------------------------------------------+
+|**Data Params** |none |
++--------------------+-----------------------------------------------+
+|**Success Response**|``Identity[]`` |
++--------------------+-----------------------------------------------+
+|**Error Response** | {"error":"*error_desc*"} :sup:`2` |
++--------------------+-----------------------------------------------+
+|**Attention** | The response in this request is an array! |
++--------------------+-----------------------------------------------+
|
@@ -94,49 +98,49 @@ Retrieve identities
+--------------------+----------------------------------------------------------------+
|**Data Params** |none
|
+--------------------+----------------------------------------------------------------+
-|**Success Response**|{"pubkey":"*public_key*", "name":"*name*"}
|
+|**Success Response**|``Identity``
|
+--------------------+----------------------------------------------------------------+
|**Error Response** | {"error":"*error_desc*"} :sup:`2; 3 or 4`
|
+--------------------+----------------------------------------------------------------+
|
-+--------------------+---------------------------------------------------------------+
-|**Title** |Returns default identity for specific subsystem
|
-+--------------------+---------------------------------------------------------------+
-|**URL** |:literal:`/identity/subsystem/'subsystem'`
|
-+--------------------+---------------------------------------------------------------+
-|**Method** |**GET**
|
-+--------------------+---------------------------------------------------------------+
-|**URL Params** |none
|
-+--------------------+---------------------------------------------------------------+
-|**Data Params** |none
|
-+--------------------+---------------------------------------------------------------+
-|**Success Response**|{"pubkey":"*public_key*", "name":"*name*"}
|
-+--------------------+---------------------------------------------------------------+
-|**Error Response** | {"error":"*error_desc*"} :sup:`2; 5`
|
-+--------------------+---------------------------------------------------------------+
++--------------------+-----------------------------------------------+
+|**Title** |Returns default identity for specific subsystem|
++--------------------+-----------------------------------------------+
+|**URL** |:literal:`/identity/subsystem/'subsystem'` |
++--------------------+-----------------------------------------------+
+|**Method** |**GET** |
++--------------------+-----------------------------------------------+
+|**URL Params** |none |
++--------------------+-----------------------------------------------+
+|**Data Params** |none |
++--------------------+-----------------------------------------------+
+|**Success Response**|``Identity`` |
++--------------------+-----------------------------------------------+
+|**Error Response** | {"error":"*error_desc*"} :sup:`2; 5` |
++--------------------+-----------------------------------------------+
Create and update identities
----------------------------
-+--------------------+---------------------------------------------------------------+
-|**Title** |Creates an identity
|
-+--------------------+---------------------------------------------------------------+
-|**URL** |:literal:`/identity`
|
-+--------------------+---------------------------------------------------------------+
-|**Method** |**POST**
|
-+--------------------+---------------------------------------------------------------+
-|**URL Params** |none
|
-+--------------------+---------------------------------------------------------------+
-|**Data Params** | {"name":'*name*'}
|
-+--------------------+---------------------------------------------------------------+
-|**Success Response**| Response Code: :literal:` b) 201 Created`
|
-+--------------------+---------------------------------------------------------------+
-|**Error Response** | | {"error":"*error_desc*"} :sup:`6; 7`
|
-| | | *or*
|
-| | | Response Code: ``e) 409 Conflict`` if name in use
|
-+--------------------+---------------------------------------------------------------+
++--------------------+----------------------------------------------------+
+|**Title** |Creates an identity |
++--------------------+----------------------------------------------------+
+|**URL** |:literal:`/identity` |
++--------------------+----------------------------------------------------+
+|**Method** |**POST** |
++--------------------+----------------------------------------------------+
+|**URL Params** |none |
++--------------------+----------------------------------------------------+
+|**Data Params** | {"name": string} |
++--------------------+----------------------------------------------------+
+|**Success Response**| Response Code: :literal:` b) 201 Created` |
++--------------------+----------------------------------------------------+
+|**Error Response** | | {"error":"*error_desc*"} :sup:`6; 7` |
+| | | *or* |
+| | | Response Code: ``e) 409 Conflict`` if name in use|
++--------------------+----------------------------------------------------+
|
@@ -149,7 +153,7 @@ Create and update identities
+--------------------+----------------------------------------------------------------+
|**URL Params** |none
|
+--------------------+----------------------------------------------------------------+
-|**Data Params** | {"newname":'*newname*'}
|
+|**Data Params** | {"newname": string}
|
+--------------------+----------------------------------------------------------------+
|**Success Response**| Response Code: :literal:`c) 204 No Content`
|
+--------------------+----------------------------------------------------------------+
@@ -160,21 +164,21 @@ Create and update identities
|
-+--------------------+----------------------------------------------------------------+
-|**Title** |Sets identity as default for a subsystem
|
-+--------------------+----------------------------------------------------------------+
-|**URL** | ``/identity/subsystem/'name'``
|
-+--------------------+----------------------------------------------------------------+
-|**Method** |**PUT**
|
-+--------------------+----------------------------------------------------------------+
-|**URL Params** |none
|
-+--------------------+----------------------------------------------------------------+
-|**Data Params** | {"subsystem":'*subsystem*'}
|
-+--------------------+----------------------------------------------------------------+
-|**Success Response**| Response Code: :literal:`c) 204 No Content`
|
-+--------------------+----------------------------------------------------------------+
-|**Error Response** | {"error":"*error_desc*"} :sup:`2; 4; 6; 7; 9`
|
-+--------------------+----------------------------------------------------------------+
++--------------------+----------------------------------------------+
+|**Title** |Sets identity as default for a subsystem |
++--------------------+----------------------------------------------+
+|**URL** | ``/identity/subsystem/'name'`` |
++--------------------+----------------------------------------------+
+|**Method** |**PUT** |
++--------------------+----------------------------------------------+
+|**URL Params** |none |
++--------------------+----------------------------------------------+
+|**Data Params** | {"subsystem": string} |
++--------------------+----------------------------------------------+
+|**Success Response**| Response Code: :literal:`c) 204 No Content` |
++--------------------+----------------------------------------------+
+|**Error Response** | {"error":"*error_desc*"} :sup:`2; 4; 6; 7; 9`|
++--------------------+----------------------------------------------+
Delete identities
-----------------
--
To stop receiving notification emails like this one, please contact
address@hidden.
- [gnunet-rest-api] branch master updated: update version,
gnunet <=