feat: add documentation endpoint #187
Draft
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
this endpoint is to be queried by our swagger instance
Codecov Report
@@ Coverage Diff @@
## master #187 +/- ##
===========================================
- Coverage 100.00% 99.70% -0.30%
===========================================
Files 42 44 +2
Lines 1321 1340 +19
Branches 202 204 +2
===========================================
+ Hits 1321 1336 +15
- Misses 0 4 +4
Continue to review full report at Codecov.
|
| // NODE_ENV is specified. | ||
| exports.env = process.env.NODE_ENV || 'development'; | ||
| exports.host = process.env.X_HOST || os.hostname(); | ||
| exports.name = process.env.npm_package_name; |
There was a problem hiding this comment.
can we take it from ../package.json the same way as in /healthcheck?
| // Endpoints not requiring authorization. | ||
| GeneralRouter.get('/api-docs.json', (req, res) => { // mini-route to retrieve the docs |
There was a problem hiding this comment.
can we move it to middlewares/ ? either to /middlewares/generic.js or create other file to store it
idea is that lib/server.js contains the routing (e.g. this route is served by these middlewares), and not the middlewares themselves (they are stored in middlewares/*
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.
this endpoint is to be queried by our swagger instance
NB: the docs themselves are NOT complete