[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[gnunet-rest-api] branch master updated: update to recent API change in
|
From: |
gnunet |
|
Subject: |
[gnunet-rest-api] branch master updated: update to recent API change in 0.13.3 |
|
Date: |
Wed, 16 Sep 2020 11:37:43 +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 11ca00c update to recent API change in 0.13.3
11ca00c is described below
commit 11ca00cdfc9150d299e600a6787b9bb22c34ee75
Author: Martin Schanzenbach <mschanzenbach@posteo.de>
AuthorDate: Wed Sep 16 11:31:06 2020 +0200
update to recent API change in 0.13.3
---
source/conf.py | 2 +-
source/reclaim.rst | 44 ++++++++++++++++++++++----------------------
2 files changed, 23 insertions(+), 23 deletions(-)
diff --git a/source/conf.py b/source/conf.py
index f8cb651..28b0aad 100644
--- a/source/conf.py
+++ b/source/conf.py
@@ -26,7 +26,7 @@ author = 'Philippe Buschmann, Martin Schanzenbach'
# The short X.Y version
version = '0.13'
# The full version, including alpha/beta/rc tags
-release = '0.13.0'
+release = '0.13.3'
# -- General configuration ---------------------------------------------------
diff --git a/source/reclaim.rst b/source/reclaim.rst
index 70f959f..5288391 100644
--- a/source/reclaim.rst
+++ b/source/reclaim.rst
@@ -8,16 +8,16 @@ Variables in single quotes ``'...'`` can or must be changed
according to your sp
``ego`` is the name of an identity.
-``name`` is the attribute or attestation name.
+``name`` is the attribute or credential name.
-``value`` is the attribute or attestation value.
+``value`` is the attribute or credential value.
-``type`` is the attribute or attestation type.
+``type`` is the attribute or credential type.
-``id`` is the attribute or attestation ID. This ID is the name under which the
attribute can
+``id`` is the attribute or credential ID. This ID is the name under which the
attribute can
be found in the namestore.
-``attestation`` is the attestation id corresponding to an attribute.
+``credential`` is the credential ID corresponding to an attribute.
``flag`` is the attribute flag. It provides insights, whether the attribute is
third-party attested.
@@ -29,11 +29,11 @@ An ``Attribute`` JSON object is defined as follows ::
"name": string,
"type": string,
"value": string,
- "attestation": string,
+ "credential": string,
"flag": string
}
-An ``Attestation`` JSON object is defined as follows ::
+A ``Credential`` JSON object is defined as follows ::
{
"id": string,
@@ -43,7 +43,7 @@ An ``Attestation`` JSON object is defined as follows ::
"attributes": Attribute[]
}
-the ``attributes`` property can be omitted when modifying an attestation.
+the ``attributes`` property can be omitted when modifying a credential.
It will be populated in read requests for convenience only.
A ``Ticket`` JSON object is defined as follows ::
@@ -99,13 +99,13 @@ Requests
Attribute Management
--------------------
-In order to add a self-asserted attribute make sure "attestation" is empty
+In order to add a self-asserted attribute make sure "credential" is empty
and specity the attribute value in the "value" parameter.
-In order to add an attribute which is attested by an attestation, add the id
-of the attestation to the "attestation" field and specify the attribute in the
-attestation as attribute "value".
-The attestation must exist.
+In order to add an attribute which is attested by a credential, add the id
+of the credential to the "credential" field and specify the attribute in the
+credential as attribute "value".
+The credential must exist.
+--------------------+---------------------------------------------------------------+
|**Title** |Returns all attributes for an identity
|
@@ -162,13 +162,13 @@ The attestation must exist.
|**Error Response** | {"error":"*error_desc*"} :sup:`2; 5`
|
+--------------------+---------------------------------------------------------------+
-Attestation Management
+Credential Management
----------------------
+--------------------+---------------------------------------------------------------+
-|**Title** |Returns all attestations for an identity
|
+|**Title** |Returns all credentials for an identity
|
+--------------------+---------------------------------------------------------------+
-|**URL** |:literal:`/reclaim/attestation/'ego'`
|
+|**URL** |:literal:`/reclaim/credential/'ego'`
|
+--------------------+---------------------------------------------------------------+
|**Method** |**GET**
|
+--------------------+---------------------------------------------------------------+
@@ -176,7 +176,7 @@ Attestation Management
+--------------------+---------------------------------------------------------------+
|**Data Params** |none
|
+--------------------+---------------------------------------------------------------+
-|**Success Response**|``Attestation[]``
|
+|**Success Response**|``Credential[]``
|
+--------------------+---------------------------------------------------------------+
|**Error Response** | {"error":"*error_desc*"} :sup:`2`
|
+--------------------+---------------------------------------------------------------+
@@ -186,15 +186,15 @@ Attestation Management
|
+--------------------+----------------------------------------------------------------+
-|**Title** |Add an attestation to an identity
|
+|**Title** |Add a credential to an identity
|
+--------------------+----------------------------------------------------------------+
-|**URL** |:literal:`/reclaim/attestation/'ego'`
|
+|**URL** |:literal:`/reclaim/credential/'ego'`
|
+--------------------+----------------------------------------------------------------+
|**Method** |**POST**
|
+--------------------+----------------------------------------------------------------+
|**URL Params** |none
|
+--------------------+----------------------------------------------------------------+
-|**Data Params** |``Attestation``
|
+|**Data Params** |``Credential``
|
+--------------------+----------------------------------------------------------------+
|**Success Response**|Response Code: :literal:` b) 200 OK`
|
+--------------------+----------------------------------------------------------------+
@@ -204,9 +204,9 @@ Attestation Management
|
+--------------------+---------------------------------------------------------------+
-|**Title** |Delete an attestation from an identity
|
+|**Title** |Delete a credential from an identity
|
+--------------------+---------------------------------------------------------------+
-|**URL** |:literal:`/reclaim/attestation/'ego'/'id'`
|
+|**URL** |:literal:`/reclaim/credential/'ego'/'id'`
|
+--------------------+---------------------------------------------------------------+
|**Method** |**DELETE**
|
+--------------------+---------------------------------------------------------------+
--
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [gnunet-rest-api] branch master updated: update to recent API change in 0.13.3,
gnunet <=