Improve/documentation #1359
Merged
Improve/documentation #1359
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1359 +/- ##
==========================================
- Coverage 75.12% 75.02% -0.10%
==========================================
Files 157 157
Lines 18172 18146 -26
==========================================
- Hits 13651 13614 -37
- Misses 3404 3409 +5
- Partials 1117 1123 +6 ☔ View full report in Codecov by Sentry. |
neolynx
force-pushed
the
improve/documentation
branch
from
80c1b51 to
5156aa0
Compare
neolynx
force-pushed
the
improve/documentation
branch
from
df8a358 to
236e0d6
Compare
neolynx
force-pushed
the
improve/documentation
branch
from
236e0d6 to
092e088
Compare
cfiehe
approved these changes
Oct 5, 2024
neolynx
force-pushed
the
improve/documentation
branch
5 times, most recently
from
f7903cb to
af56e15
Compare
neolynx
force-pushed
the
improve/documentation
branch
from
af56e15 to
e673378
Compare
neolynx
force-pushed
the
improve/documentation
branch
from
e673378 to
cafd7d0
Compare
neolynx
force-pushed
the
improve/documentation
branch
3 times, most recently
from
70e13f6 to
2567dba
Compare
|
Working on filling in TODO stubs, starting with api/task |
neolynx
force-pushed
the
improve/documentation
branch
from
2567dba to
c8cf59c
Compare
thank you so much in advance ! |
|
I pushed a fix for lint, please |
iofq
force-pushed
the
improve/documentation
branch
from
85a9d73 to
c7b7567
Compare
|
Believe I took care of all the API stubs |
neolynx
force-pushed
the
improve/documentation
branch
from
ac76097 to
1f3c9a8
Compare
neolynx
added
needs review
neolynx
force-pushed
the
improve/documentation
branch
from
1f3c9a8 to
4052973
Compare
and make sure make lint has the VERSION generated
and fix lint
and fix etcd data dir
make descrptions consistent
neolynx
force-pushed
the
improve/documentation
branch
from
067e2a1 to
e319f3c
Compare
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.
Fixes: #181
Description of the Change
Document all APIs with swagger
Replace and automate the API documentation on https://www.aptly.info/doc/api document API calls with swagger.
Run swagger
See Swagger doc: http://localhost:3142/docs
Note: as the dev server has live reload, changes to the code will be recompiled, then the page can be reloaded.
Document aptly.conf
Found that aptly uses
github.com/DisposaBoy/JsonConfigReaderalready, turns out it supports comments in json,so we can have a inline documented config file :)
Checklist