[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[GNUnet-SVN] [gnunet-rest-api] branch master updated: update
|
From: |
gnunet |
|
Subject: |
[GNUnet-SVN] [gnunet-rest-api] branch master updated: update |
|
Date: |
Mon, 27 May 2019 17:41:06 +0200 |
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 20d6da3 update
20d6da3 is described below
commit 20d6da35930bd51b7b15a29c458802a2d5db3473
Author: Schanzenbach, Martin <address@hidden>
AuthorDate: Mon May 27 17:40:32 2019 +0200
update
---
source/conf.py | 2 +-
source/gns.rst | 2 +-
source/identity.rst | 15 +++++++--------
source/reclaim.rst | 47 +++++++++++++++++++++++------------------------
4 files changed, 32 insertions(+), 34 deletions(-)
diff --git a/source/conf.py b/source/conf.py
index e4653f1..b378e98 100644
--- a/source/conf.py
+++ b/source/conf.py
@@ -74,7 +74,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
-html_theme = 'nature'
+html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
diff --git a/source/gns.rst b/source/gns.rst
index 53c9872..ea04fb8 100644
--- a/source/gns.rst
+++ b/source/gns.rst
@@ -30,7 +30,7 @@ Error ``1)`` is always possible and is not listed in
following requests.
Requests
~~~~~~~~
-GET Request
+Name lookup
-----------
For this request ``record_type`` is optional. If missing or called with an
invalid record_type, it will automatically be set to ANY.
diff --git a/source/identity.rst b/source/identity.rst
index 63dd2e7..bb9cd36 100644
--- a/source/identity.rst
+++ b/source/identity.rst
@@ -60,8 +60,8 @@ A response of a message has a HTTP response code. Usually,
this code is 200 OK f
Requests
~~~~~~~~
-GET Requests
-------------
+Retrieve identities
+-------------------
+--------------------+---------------------------------------------------------------+
|**Title** |Returns all identities with name and public key
|
@@ -117,8 +117,8 @@ GET Requests
|**Error Response** | {"error":"*error_desc*"} :sup:`2; 5`
|
+--------------------+---------------------------------------------------------------+
-POST Request
-------------
+Create and update identities
+----------------------------
+--------------------+---------------------------------------------------------------+
|**Title** |Creates an identity
|
@@ -138,8 +138,7 @@ POST Request
| | | Response Code: ``e) 409 Conflict`` if name in use
|
+--------------------+---------------------------------------------------------------+
-PUT Request
------------
+|
+--------------------+----------------------------------------------------------------+
|**Title** |Changes name of identity
|
@@ -177,8 +176,8 @@ PUT Request
|**Error Response** | {"error":"*error_desc*"} :sup:`2; 4; 6; 7; 9`
|
+--------------------+----------------------------------------------------------------+
-DELETE Request
---------------
+Delete identities
+-----------------
+--------------------+----------------------------------------------------------------+
|**Title** |Deletes specific identity
|
diff --git a/source/reclaim.rst b/source/reclaim.rst
index 6fc8674..aba7d5b 100644
--- a/source/reclaim.rst
+++ b/source/reclaim.rst
@@ -59,8 +59,8 @@ A response of a message has a HTTP response code. Usually,
this code is 200 OK f
Requests
~~~~~~~~
-GET Requests
-------------
+Attribute Management
+--------------------
+--------------------+---------------------------------------------------------------+
|**Title** |Returns all attributes for an identity
|
@@ -81,8 +81,7 @@ GET Requests
|**Attention** | The response in this request is an array.
|
+--------------------+---------------------------------------------------------------+
-POST Request
-------------
+|
+--------------------+----------------------------------------------------------------+
|**Title** |Add an attribute to an identity
|
@@ -104,27 +103,28 @@ POST Request
|
+--------------------+---------------------------------------------------------------+
-|**Title** |Revoke an issued ticket
|
+|**Title** |Delete an attribute from an identity
|
+--------------------+---------------------------------------------------------------+
-|**URL** |:literal:`/reclaim/revoke`
|
+|**URL** |:literal:`/reclaim/attributes/'ego'/'id'`
|
+--------------------+---------------------------------------------------------------+
-|**Method** |**POST**
|
+|**Method** |**DELETE**
|
+--------------------+---------------------------------------------------------------+
|**URL Params** |none
|
+--------------------+---------------------------------------------------------------+
-|**Data Params** |{"issuer": "*key*", "audience": "*key*", "rnd": "*id*"}
|
+|**Data Params** |none
|
+--------------------+---------------------------------------------------------------+
-|**Success Response**| Response Code: :literal:` b) 200 OK`
|
+|**Success Response**|Response Code: :literal:` b) 200 OK`
|
+--------------------+---------------------------------------------------------------+
-|**Error Response** | | {"error":"*error_desc*"} :sup:`6; 7`
|
+|**Error Response** | {"error":"*error_desc*"} :sup:`2; 5`
|
+--------------------+---------------------------------------------------------------+
-|
+Ticket Management
+-----------------
+--------------------+---------------------------------------------------------------+
-|**Title** |Consume/Exchange a ticket and retrieve attributes
|
+|**Title** |Revoke an issued ticket
|
+--------------------+---------------------------------------------------------------+
-|**URL** |:literal:`/reclaim/consume`
|
+|**URL** |:literal:`/reclaim/tickets/revoke`
|
+--------------------+---------------------------------------------------------------+
|**Method** |**POST**
|
+--------------------+---------------------------------------------------------------+
@@ -132,32 +132,31 @@ POST Request
+--------------------+---------------------------------------------------------------+
|**Data Params** |{"issuer": "*key*", "audience": "*key*", "rnd": "*id*"}
|
+--------------------+---------------------------------------------------------------+
-|**Success Response**|[{"value":"*value*", "name":"*name*",
|
-| | "type": "*type*", "id": "*id*"},...]
|
+|**Success Response**| Response Code: :literal:` b) 200 OK`
|
+--------------------+---------------------------------------------------------------+
|**Error Response** | | {"error":"*error_desc*"} :sup:`6; 7`
|
+--------------------+---------------------------------------------------------------+
-
-DELETE Request
---------------
+|
+--------------------+---------------------------------------------------------------+
-|**Title** |Delete an attribute from an identity
|
+|**Title** |Consume/Exchange a ticket and retrieve attributes
|
+--------------------+---------------------------------------------------------------+
-|**URL** |:literal:`/reclaim/attributes/'ego'/'id'`
|
+|**URL** |:literal:`/reclaim/tickets/consume`
|
+--------------------+---------------------------------------------------------------+
-|**Method** |**DELETE**
|
+|**Method** |**POST**
|
+--------------------+---------------------------------------------------------------+
|**URL Params** |none
|
+--------------------+---------------------------------------------------------------+
-|**Data Params** |none
|
+|**Data Params** |{"issuer": "*key*", "audience": "*key*", "rnd": "*id*"}
|
+--------------------+---------------------------------------------------------------+
-|**Success Response**|Response Code: :literal:` b) 200 OK`
|
+|**Success Response**|[{"value":"*value*", "name":"*name*",
|
+| | "type": "*type*", "id": "*id*"},...]
|
+--------------------+---------------------------------------------------------------+
-|**Error Response** | {"error":"*error_desc*"} :sup:`2; 5`
|
+|**Error Response** | | {"error":"*error_desc*"} :sup:`6; 7`
|
+--------------------+---------------------------------------------------------------+
+
OPTIONS Request
---------------
--
To stop receiving notification emails like this one, please contact
address@hidden
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [GNUnet-SVN] [gnunet-rest-api] branch master updated: update,
gnunet <=