[FEATURE] Add API docs and swagger-ui #1544
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
ArtifactsThese changes are published for testing on Buildkite and DockerHub. Docker Container
|
nightah
force-pushed
the
feature-swagger-api-documentation
branch
4 times, most recently
from
ccfc7ae
to
2e3e484
Compare
Codecov Report
@@ Coverage Diff @@
## master #1544 +/- ##
==========================================
+ Coverage 66.07% 66.08% +0.01%
==========================================
Files 144 144
Lines 4015 4028 +13
Branches 168 168
==========================================
+ Hits 2653 2662 +9
- Misses 1143 1148 +5
+ Partials 219 218 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
|
nightah
force-pushed
the
feature-swagger-api-documentation
branch
3 times, most recently
from
99a77e6
to
5825019
Compare
nightah
force-pushed
the
feature-swagger-api-documentation
branch
from
fa28652
to
bf12954
Compare
This change will serve out swagger-ui at the `/api/` root path.
This change also factorises and renames index.go into template.go, this can now be generically utilised to template any file.
nightah
force-pushed
the
feature-swagger-api-documentation
branch
from
7475aef
to
977137f
Compare
This change is to more closely conform to the golang-standards project layout.
nightah
force-pushed
the
feature-swagger-api-documentation
branch
from
977137f
to
4aa1408
Compare
james-d-elliott
approved these changes
Jan 3, 2021
james-d-elliott
requested changes
Jan 3, 2021
james-d-elliott
approved these changes
Jan 3, 2021
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 change will serve out swagger-ui at the
/api/path.I have not documented the following endpoints:
/api/secondfactor/u2f/sign_request/api/secondfactor/u2f/sign@clems4ever I'm hoping that you might be able to add these two into the API spec since you understand the flow much better and can actually test inputs/outputs with a u2f key.
Some of the summaries and descriptions probably need some work, happy for a review and any recommendations.
EDIT: I've given all of the summaries and descriptions another review and made some changes.
Closes #450.