[FS-672] Improve swagger docs for Client fields.#2657
Merged
stephen-smith merged 8 commits intodevelopfrom Sep 1, 2022
Merged
Conversation
Contributor
|
It would be good to also improve the example. Right now it reads: which is not very useful. |
30b2ddc to
346b5eb
Compare
5b05ecc to
773f3b6
Compare
773f3b6 to
0b84d03
Compare
0b84d03 to
b051731
Compare
fisx
reviewed
Sep 1, 2022
Contributor
fisx
left a comment
There was a problem hiding this comment.
when building this, running http://localhost:8080/swagger-ui/, and opening http://localhost:8080/swagger-ui/, I see this:
MLSPublicKeys shouldn't be empty, should it?
Old swagger Client model was unused.
General type modifiers for MLSPublicKeys (like name, description) are applied in one location, but adapter for use as an optional field named "mls_public_keys" are done separately. Also, generalize a HasDescription instance.
Co-authored-by: fisx <mf@zerobuzz.net>
Co-authored-by: fisx <mf@zerobuzz.net>
0944120 to
461c21a
Compare
Contributor
Author
It doesn't have any fields, so yes, I think it is supposed to be empty in that display. As best as I can tell, that's normal for map/dict types in swagger. The example should have the only valid key and an example value, and there should also be a description if you expand the name. |
fisx
approved these changes
Sep 1, 2022
This file contains hidden or 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
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.



FS-672
Checklist