docs: add swagger spec #6
Conversation
Signed-off-by: Nam Hoang <[email protected]>
Coverage report
Test suite run success37 tests passing in 9 suites. Report generated by 🧪jest coverage report action from 217cf34 |
Signed-off-by: Nam Hoang <[email protected]>
namhoang1604
requested review from
huynguyen-hl,
ldhyen99 and
ashleythedeveloper
There was a problem hiding this comment.
Hi @namhoang1604, if I change the accepted payloads in the request/response of the API, how is this change reflected in the API spec generated? Are we relying on the contributor to know to change the version of the API spec?
| "uri": { | ||
| "type": "string", | ||
| "example": "http://localhost:3333/v1/verifiable-credentials/123e4567-e89b-12d3-a456-426614174000.json" | ||
| }, |
There was a problem hiding this comment.
I noticed that the API_VERSION in the config is hardcoded as 'v1.0.0'. I think the uri example here should be updated to reflect this accordingly.
| "uri": { | ||
| "type": "string", | ||
| "example": "http://localhost:3333/v1/verifiable-credentials/123e4567-e89b-12d3-a456-426614174000.json" | ||
| }, |
There was a problem hiding this comment.
I noticed that the API_VERSION in the config is hardcoded as 'v1.0.0'. I think the uri example here should be updated to reflect this accordingly.
| @@ -104,6 +106,8 @@ yarn build | |||
| yarn start | |||
| ``` | |||
|
|
|||
| The Swagger UI is available at `http://localhost:3333/api-docs`. | |||
There was a problem hiding this comment.
I noticed that this line is duplicated in the README.md. Could you consolidate it into a single, common sentence for the Swagger UI endpoint instead of duplicating it?
Description
This PR adds Swagger API spec
What type of PR is this? (check all applicable)
Related Tickets & Documents
https://github.com/gs-gs/fa-ag-trace/issues/681
Mobile & Desktop Screenshots/Recordings
Added tests?
Added to documentation?
[optional] Are there any post-deployment tasks we need to perform?
[optional] What gif best describes this PR or how it makes you feel?