[gnunet-rest-api] branch master updated: reclaim attestation support

[gnunet]

This is an automated email from the git hooks/post-receive script.

markus-voggenreiter 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 68c2792  reclaim attestation support
68c2792 is described below

commit 68c2792a9deb2e53be2c1071468d762323d2bc5d
Author: Markus Voggenreiter <address@hidden>
AuthorDate: Thu Jan 9 11:16:24 2020 +0100

    reclaim attestation support
---
 source/reclaim.rst | 127 ++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 126 insertions(+), 1 deletion(-)

diff --git a/source/reclaim.rst b/source/reclaim.rst
index de60ab1..6af0932 100644
--- a/source/reclaim.rst
+++ b/source/reclaim.rst
@@ -17,6 +17,12 @@ Variables in single quotes ``'...'`` can or must be changed 
according to your sp
 ``id`` is the attribute ID. This ID is the name under which the attribute can
 be found in the namestore.
 
+``flag`` is the attribute flag. It provides insights, whether the attribute is 
+third-party attested.
+
+``ref_value`` is the claim inside the referenced attestation.
+
+``ref_id`` is the ID of the referenced attestation.
 
 
 Error Response
@@ -74,7 +80,7 @@ Attribute Management
 |**Data Params**     |none                                                     
      |
 
+--------------------+---------------------------------------------------------------+
 |**Success Response**|[{"value":"*value*", "name":"*name*",                    
      |
-|                    |  "type": "*type*", "id": "*id*"},...]                   
      |
+|                    |  "type": "*type*", "id": "*id*", "flag": "*flag*"},...] 
      |
 
+--------------------+---------------------------------------------------------------+
 |**Error Response**  | {"error":"*error_desc*"} :sup:`2`                       
      |
 
+--------------------+---------------------------------------------------------------+
@@ -118,6 +124,125 @@ Attribute Management
 |**Error Response**  | {"error":"*error_desc*"} :sup:`2; 5`                    
      |
 
+--------------------+---------------------------------------------------------------+
 
+Attestation Management
+--------------------
+
++--------------------+---------------------------------------------------------------+
+|**Title**           |Returns all attestations for an identity                 
      |
++--------------------+---------------------------------------------------------------+
+|**URL**             |:literal:`/reclaim/attestation/'ego'`                    
      |
++--------------------+---------------------------------------------------------------+
+|**Method**          |**GET**                                                  
      |
++--------------------+---------------------------------------------------------------+
+|**URL Params**      |none                                                     
      |
++--------------------+---------------------------------------------------------------+
+|**Data Params**     |none                                                     
      |
++--------------------+---------------------------------------------------------------+
+|**Success Response**|[{"value":"*value*", "name":"*name*",                    
      |
+|                    |  "type": "*type*", "id": "*id*"},...]                   
      |
++--------------------+---------------------------------------------------------------+
+|**Error Response**  | {"error":"*error_desc*"} :sup:`2`                       
      |
++--------------------+---------------------------------------------------------------+
+|**Attention**       | The response in this request is an array.               
      |
++--------------------+---------------------------------------------------------------+
+
+|
+
++--------------------+----------------------------------------------------------------+
+|**Title**           |Add an attestation to an identity                        
       |
++--------------------+----------------------------------------------------------------+
+|**URL**             |:literal:`/reclaim/attestation/'ego'`                    
       |
++--------------------+----------------------------------------------------------------+
+|**Method**          |**POST**                                                 
       |
++--------------------+----------------------------------------------------------------+
+|**URL Params**      |none                                                     
       |
++--------------------+----------------------------------------------------------------+
+|**Data Params**     |{"value":"*value*", "name":"*name*",                     
       |
+|                    | "type": "*type*", "id": "*id*"}                         
       |
++--------------------+----------------------------------------------------------------+
+|**Success Response**|Response Code: :literal:` b) 200 OK`                     
       |
++--------------------+----------------------------------------------------------------+
+|**Error Response**  | {"error":"*error_desc*"} :sup:`2; 3 or 4`               
       |
++--------------------+----------------------------------------------------------------+
+
+|
+
++--------------------+---------------------------------------------------------------+
+|**Title**           |Delete an attestation from an identity                   
      |
++--------------------+---------------------------------------------------------------+
+|**URL**             |:literal:`/reclaim/attestation/'ego'/'id'`               
      |
++--------------------+---------------------------------------------------------------+
+|**Method**          |**DELETE**                                               
      |
++--------------------+---------------------------------------------------------------+
+|**URL Params**      |none                                                     
      |
++--------------------+---------------------------------------------------------------+
+|**Data Params**     |none                                                     
      |
++--------------------+---------------------------------------------------------------+
+|**Success Response**|Response Code: :literal:` b) 200 OK`                     
      |
++--------------------+---------------------------------------------------------------+
+|**Error Response**  | {"error":"*error_desc*"} :sup:`2; 5`                    
      |
++--------------------+---------------------------------------------------------------+
+
+Attestation Reference Management
+--------------------
+
++--------------------+---------------------------------------------------------------+
+|**Title**           |Returns all attestation references for an identity       
      |
++--------------------+---------------------------------------------------------------+
+|**URL**             |:literal:`/reclaim/attestation/reference/'ego'`          
      |
++--------------------+---------------------------------------------------------------+
+|**Method**          |**GET**                                                  
      |
++--------------------+---------------------------------------------------------------+
+|**URL Params**      |none                                                     
      |
++--------------------+---------------------------------------------------------------+
+|**Data Params**     |none                                                     
      |
++--------------------+---------------------------------------------------------------+
+|**Success Response**|[{"ref_value":"*ref_value*", "name":"*name*",            
      |
+|                    |  "ref_id": "*ref_id*", "id": "*id*"},...]               
      |
++--------------------+---------------------------------------------------------------+
+|**Error Response**  | {"error":"*error_desc*"} :sup:`2`                       
      |
++--------------------+---------------------------------------------------------------+
+|**Attention**       | The response in this request is an array.               
      |
++--------------------+---------------------------------------------------------------+
+
+|
+
++--------------------+----------------------------------------------------------------+
+|**Title**           |Add an attestation reference to an identity              
       |
++--------------------+----------------------------------------------------------------+
+|**URL**             |:literal:`/reclaim/attestation/reference/'ego'`          
       |
++--------------------+----------------------------------------------------------------+
+|**Method**          |**POST**                                                 
       |
++--------------------+----------------------------------------------------------------+
+|**URL Params**      |none                                                     
       |
++--------------------+----------------------------------------------------------------+
+|**Data Params**     |{"ref_value":"*ref_value*", "name":"*name*",             
       |
+|                    | "ref_id": "*ref_id*", "id": "*id*"}                     
       |
++--------------------+----------------------------------------------------------------+
+|**Success Response**|Response Code: :literal:` b) 200 OK`                     
       |
++--------------------+----------------------------------------------------------------+
+|**Error Response**  | {"error":"*error_desc*"} :sup:`2; 3 or 4`               
       |
++--------------------+----------------------------------------------------------------+
+
+|
+
++--------------------+---------------------------------------------------------------+
+|**Title**           |Delete an attestation reference from an identity         
      |
++--------------------+---------------------------------------------------------------+
+|**URL**             |:literal:`/reclaim/attestation/reference/'ego'/'id'`     
      |
++--------------------+---------------------------------------------------------------+
+|**Method**          |**DELETE**                                               
      |
++--------------------+---------------------------------------------------------------+
+|**URL Params**      |none                                                     
      |
++--------------------+---------------------------------------------------------------+
+|**Data Params**     |{"ref_value":"*ref_value*", "name":"*name*",             
      |
+|                    | "ref_id": "*ref_id*", "id": "*id*"}                     
      |
++--------------------+---------------------------------------------------------------+
+|**Success Response**|Response Code: :literal:` b) 200 OK`                     
      |
++--------------------+---------------------------------------------------------------+
+|**Error Response**  | {"error":"*error_desc*"} :sup:`2; 5`                    
      |
++--------------------+---------------------------------------------------------------+
+
 Ticket Management
 -----------------
 

-- 
To stop receiving notification emails like this one, please contact
address@hidden.