Published new version 2.8 of the API Specification #67
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
masv3971
commented
Jun 12, 2024
standards/apiv28.md
Outdated
| # Datastore Rest API | ||
|
|
||
| ## Introduction and reference | ||
| The following document serves as a reference for the implementation of the Issuer System including the so-called Data Store for the EU-funded DC4EU project. The document focuses on the technical description of the relevant backend endpoints without providing detailed business explanations including scenarios. |
There was a problem hiding this comment.
Data Store should be Datastore I think.
standards/apiv28.md
Outdated
| | Object | [identity {}](#identity) | r | Object containing all data for later identity mapping – as defined in the upload endpoint | | ||
| | | | | | | ||
| | Output | | | | | ||
| | Integer | status | r | Returns operation status; 200 OK, else 400 and error body | |
There was a problem hiding this comment.
output is not an integer, output is stated under Response. This is true for other endpoints as well.
standards/apiv28.md
Outdated
| | String | authentic_source | o | globally unambiguous name of the issuing entity (agency or institution) | | ||
| | Object | [identity {}](#identity)| r | as defined in upload | | ||
| | String | document_type | o | Type of Document, initially only “EHIC” or “PDA1” for filter; if empty, all types | | ||
| | int64 unix | valid_from | o | credentials valid from or specific date; if empty current date | |
There was a problem hiding this comment.
unix is not a type, please remove.
standards/apiv28.md
Outdated
| 13. PUT /document/status - set document status to revoked | ||
|
|
||
| ## Backend configurations | ||
| Before the Issuer System and the described API can be used, the Issuer System must be configured. A config file is provided for this purpose, for example to define specific endpoints for each Authentic Source. This makes it possible to define several Authentic Sources. A wide variety of architectures are possible, for example with many data stores per authentic source or one data store at the issuer that contains data for many authentic sources. The endpoint for the signature service and the standard credential profiles should also be defined here for each authentic source. This information is relevant for generating the credential. |
There was a problem hiding this comment.
Perhaps mention that the configuration is presented as json, but can be in other formats, for example yaml.
standards/apiv28.md
Outdated
| 9. POST /document - return a full document entry for credential creation | ||
| 10. POST /consent - optionally store user consent to display `/document/list information` in a portal | ||
| 11. POST /consent/get - return consent status of citizen to display `/document/list information` in a portal | ||
|
|
standards/apiv28.md
Outdated
| # Datastore Rest API | ||
|
|
||
| ## Introduction and reference | ||
| The following document serves as a reference for the implementation of the Issuer System including the so-called Data Store for the EU-funded DC4EU project. The document focuses on the technical description of the relevant backend endpoints without providing detailed business explanations including scenarios. |
There was a problem hiding this comment.
Maybe highlight components for example datastore etc..
masv3971
commented
Jul 9, 2024
standards/apiv28.md
Outdated
| | String | resident_house_number | o | As in current PID namespace | | ||
| | String | nationality | o | As in current PID namespace | | ||
|
|
||
| ### attestation{} |
There was a problem hiding this comment.
remove, not used per this api version
|
|
||
| unspecified json object, used to include any document type from authentic source | ||
|
|
||
| ### document_display{} |
There was a problem hiding this comment.
Should this include long_description, valid_to and valid_from ?
standards/apiv28.md
Outdated
| | Boolean | real_data | r | “true” or “false” – For Pilot, indicating the use of real or test data | | ||
| | Object | collect { | o | This is defining information for general pick-up by QR-Code/link. | | ||
| | String | id | o | If not defined by institution it should be set to document_id value after upload.<br><br>Used to not expose the real document id, thus limiting fraud. | | ||
| | Int64<br><br>unix | collect_until | o | If not defined the collect id can be used indefinitely, otherwise issuer should reject request after this date. | |
There was a problem hiding this comment.
change collect_until to valid_until, less stutter -> collect.collect_until seems bad to me.
masv3971
commented
Jul 11, 2024
standards/apiv28.md
Outdated
|
|
||
| ### Description | ||
|
|
||
| After the upload was successful the authentic source can call the get notification endpoint, to receive `qr_base64_image` and `deep_link` to include them in existing notification means. This is split from the upload endpoint to allow fast mass uploads of documents and to allow openness for different system architectures as this information request may be done by a different authentic source component as the upload. |
There was a problem hiding this comment.
remove qr_ prefix.
standards/apiv28.md
Outdated
| | ---------------------- | -------------------------- | -------------------- | -------------------------------------------------------------------------------------------- | | ||
| | Type | Attribute | (r)eq.<br><br>(o)pt. | Attibute Description | | ||
| | Input | | | | | ||
| | String | authentic_source | t | globally unambiguous name of the issuing entity (agency or institution) | |
There was a problem hiding this comment.
replace t with r.
standards/apiv28.md
Outdated
|
|
||
| ```mermaid | ||
| sequenceDiagram; | ||
| Application (Portal/Wallet)->>Issuer: POST document/collect_id; |
There was a problem hiding this comment.
I think it should be,
- Issuer ->> Datastore (get document) /document/collect_id
- Issuer ->> Wallet (send credential based on document)
standards/apiv28.md
Outdated
|
|
||
| |type| Attribute | required | description | | ||
| | ---------- | ---------------- | --- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | String | revocation_id | o | ID for credential revocation; If not defined by institution it should be set to document_id value after upload. Different value may be used to allow credential coupling – having one revocation status for multiple credentials | |
There was a problem hiding this comment.
revocation_id change to id
masv3971
commented
Jul 11, 2024
standards/apiv28.md
Outdated
|
|
||
| http OK 200, else 400 and error body | ||
|
|
||
| ## POST /id/mapping |
There was a problem hiding this comment.
Change to /identity/mapping to make it more obvious it reference to the identity of a person.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.