Assess ways thorugh which our authentication strategy (bearer) can be included in the docs (possibly even manually)
Define a standard for restructuring the code so that all code paths in all handlers end in a call to next()
Idea: Extend the default .send() functionality in order to also call next()
Originally created by @stephan418 on GitHub (Sep 17, 2022).
Original GitHub issue: https://github.com/detleph/server/issues/93
Using OpenAPI, a usable API documentation should be created for the most important API routes.
The API routes which should be tackled by this task are:
- Events (CRUD)
- Everything relating to user sign up
- [x] Test different strategies for writing the docs
## Update
https://www.npmjs.com/package/express-oas-generator seems to fit most of our requirement
Todo:
- [x] Assess ways thorugh which our authentication strategy (bearer) can be included in the docs (possibly even manually)
- [x] Define a standard for restructuring the code so that all code paths in all handlers end in a call to next()
- Idea: Extend the default .send() functionality in order to also call next()
The generation of documentation now works without restructuring any server code. I added more granular request handling support in a fork of the express-oas-generator library which fixes the problem for now at least.
New Tasks:
Add support for bearer authorization (basically just prefix bearer to the token)
Update the insomnia design document to include a test which runs all the requests in a meaningful order
Add ability to handle picture uploads and the like (which are not handled by the fix I developed (Optional)
<!-- gh-comment-id:1250023301 -->
@stephan418 commented on GitHub (Sep 17, 2022):
# Task update (2)
The generation of documentation now works without restructuring any server code. I added more granular request handling support in a fork of the express-oas-generator library which fixes the problem for now at least.
New Tasks:
- [ ] Add support for bearer authorization (basically just prefix bearer to the token)
- [ ] Update the insomnia design document to include a test which runs all the requests in a meaningful order
- [ ] _Add ability to handle picture uploads and the like (which are not handled by the fix I developed_ (Optional)
<!-- gh-comment-id:1264314554 -->
@stephan418 commented on GitHub (Oct 1, 2022):
# Waiting for other task
Waiting for https://github.com/detleph/issues/issues/4
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Originally created by @stephan418 on GitHub (Sep 17, 2022).
Original GitHub issue: https://github.com/detleph/server/issues/93
Using OpenAPI, a usable API documentation should be created for the most important API routes.
The API routes which should be tackled by this task are:
Events (CRUD)
Everything relating to user sign up
Test different strategies for writing the docs
Update
https://www.npmjs.com/package/express-oas-generator seems to fit most of our requirement
Todo:
@stephan418 commented on GitHub (Sep 17, 2022):
Task update (2)
The generation of documentation now works without restructuring any server code. I added more granular request handling support in a fork of the express-oas-generator library which fixes the problem for now at least.
New Tasks:
@stephan418 commented on GitHub (Oct 1, 2022):
Waiting for other task
Waiting for https://github.com/detleph/issues/issues/4