Fix #167: REST API documentation #179
Merged
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
romanstrobl
temporarily deployed
to
docker-publish
GitHub Actions
Inactive
banterCZ
approved these changes
Jun 21, 2024
|
|
||
| ### User Claims API (Deprecated) | ||
|
|
||
| This REST API is deprecated, see Swagger for usage information. |
There was a problem hiding this comment.
What about using a warning box?
Suggested change
| This REST API is deprecated, see Swagger for usage information. | |
| <!-- begin box warning --> | |
| This REST API is deprecated, see Swagger for usage information. | |
| <!-- end --> |
docs/User-Data-Store-API.md
Outdated
|
|
||
| The following paths require a ROLE_WRITE authority: | ||
| - `/admin/**` - supported REST API for User Data Store | ||
| - `/public/**` - deprecated REST API for user claims |
There was a problem hiding this comment.
Suggested change
| - `/public/**` - deprecated REST API for user claims | |
| - `/public/**` - **deprecated** REST API for user claims |
docs/User-Data-Store-API.md
Outdated
Comment on lines
89
to
91
| Authorization: Basic YWRtaW46YWRtaW4= | ||
|
|
||
| The username and password is a Base-64 encoded string in format username:password. |
There was a problem hiding this comment.
Suggested change
| Authorization: Basic YWRtaW46YWRtaW4= | |
| The username and password is a Base-64 encoded string in format username:password. | |
| `Authorization: Basic YWRtaW46YWRtaW4=` | |
| The username and password is a Base-64 encoded string in the format `username:password`. |
jnpsk
approved these changes
Jun 21, 2024
There was a problem hiding this comment.
Nice!
I found only a few minor problems. Those that should be fixed:
- There is inconsistency in the placing of the asterisk. We should keep the symbol in the param column.
- You use
photoinstead ofattachmentin some description.
The others are just nitpicking.
Comment on lines
+120
to
+123
| - Headers: | ||
| - `Authorization: Basic ...` | ||
|
|
||
| ##### Query Params |
There was a problem hiding this comment.
Header is a bullet list while query params is a heading. Is this the usual formatting of our API documentation?
docs/User-Data-Store-API.md
Outdated
| |--------------------------------------------------------------|----------|----------------------------------------------------------------------------------------------------| | ||
| | `userId`<span class="required" title="Required">*</span> | `String` | User identifier of document owner. | | ||
| | `documentId`<span class="required" title="Required">*</span> | `String` | Identifier of the related document. | | ||
| | `photoType`<span class="required" title="Required">*</span> | `String` | One of `photoType`: `person`, `document_front_side`, `document_back_side`, `person_with_document`. | |
There was a problem hiding this comment.
A small detail, just for consistency with other lists of expected values.
Suggested change
| | `photoType`<span class="required" title="Required">*</span> | `String` | One of `photoType`: `person`, `document_front_side`, `document_back_side`, `person_with_document`. | | |
| | `photoType`<span class="required" title="Required">*</span> | `String` | One of: `person`, `document_front_side`, `document_back_side`, `person_with_document`. | |
docs/User-Data-Store-API.md
Outdated
|
|
||
| | Parameter | Type | Description | | ||
| |--------------------------------------------------------------|----------|----------------------------------------------------------------------------------------------------| | ||
| | `photoType`<span class="required" title="Required">*</span> | `String` | One of `photoType`: `person`, `document_front_side`, `document_back_side`, `person_with_document`. | |
docs/User-Data-Store-API.md
Outdated
|
|
||
| | Param | Type | Description | | ||
| |--------------|----------------------------------------------------------|---------------------------------------------------------------------| | ||
| | `userId` | `String`<span class="required" title="Required">*</span> | User identifier of the owner of fetched documents. | |
There was a problem hiding this comment.
There is inconsistency in the placing of the asterisk. We should keep the symbol in the param column.
docs/User-Data-Store-API.md
Outdated
|
|
||
| | Param | Type | Description | | ||
| |--------------|----------------------------------------------------------|---------------------------------------------------------------------| | ||
| | `userId` | `String`<span class="required" title="Required">*</span> | User identifier of the owner of deleted documents. | |
There was a problem hiding this comment.
As it is in the request, the documents are yet to be deleted. This past tense is used in more places.
Suggested change
| | `userId` | `String`<span class="required" title="Required">*</span> | User identifier of the owner of deleted documents. | | |
| | `userId` | `String`<span class="required" title="Required">*</span> | User identifier of the owner of documents to be deleted. | |
docs/User-Data-Store-API.md
Outdated
| | `documentId`<span class="required" title="Required">*</span> | `String` | Identifier of the related document. | | ||
| | `attachmentType`<span class="required" title="Required">*</span> | `String` | One of `text`, `image_base64`, `binary_base64`. | | ||
| | `attachmentData`<span class="required" title="Required">*</span> | `String` | Base-64 encoded attachment data. | | ||
| | `externalId` | `String` | Optional external identifier of the photo (e.g. identifier used in the bank system). | |
There was a problem hiding this comment.
Suggested change
| | `externalId` | `String` | Optional external identifier of the photo (e.g. identifier used in the bank system). | | |
| | `externalId` | `String` | Optional external identifier of the attachment (e.g. identifier used in the bank system). | |
docs/User-Data-Store-API.md
Outdated
| |------------------------------------------------------------------|----------|--------------------------------------------------------------------------------------| | ||
| | `attachmentType`<span class="required" title="Required">*</span> | `String` | One of `text`, `image_base64`, `binary_base64`. | | ||
| | `attachmentData`<span class="required" title="Required">*</span> | `String` | Base-64 encoded attachment data. | | ||
| | `externalId` | `String` | Optional external identifier of the photo (e.g. identifier used in the bank system). | |
There was a problem hiding this comment.
Suggested change
| | `externalId` | `String` | Optional external identifier of the photo (e.g. identifier used in the bank system). | | |
| | `externalId` | `String` | Optional external identifier of the attachment (e.g. identifier used in the bank system). | |
romanstrobl
temporarily deployed
to
docker-publish
GitHub Actions
Inactive
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.