Improve swagger docs #449
Merged
Improve swagger docs #449
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
frenchy64
requested review from
gbuisson,
yogsototh,
msprunck,
ereteog,
turbodog99,
rplevy,
wandersoncferreira,
safi,
michaels-den,
samwagg,
marioaquino and
t2sw
as code owners
|
For the build perhaps you could deploy a SNAPSHOT version in clojars and use this one? Perhaps lein-git-down does not work in the CI as one would expect. |
yogsototh
approved these changes
Jul 10, 2024
test/ctim/test_helpers/core.cljc
Outdated
Comment on lines
6
to
7
| [flanders.schema :as fschema] | ||
| ) |
There was a problem hiding this comment.
Suggested change
| [flanders.schema :as fschema] | |
| ) | |
| [flanders.schema :as fschema]) |
ereteog
approved these changes
Jul 17, 2024
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.
https://github.com/advthreat/iroh/issues/8946
Via flanders changes, adds examples to the json docs and swagger metadata.
We reuse
:defaultto populate examples here. This has undesirable effects on the documentation. I reviewed the existing documentation around defaults, and many were not appropriate for user-facing docs. The closest to useful was that tlp defaults to green, but this is configurable in CTIA so that is debatable.Instead of developing another flanders feature, I disabled default values from printing in the docs. We might want to revisit this if we actually use defaults in a user-facing way (not just generating examples).