API doc improvements #51
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
* changed version to 2 * Added example values for span. This makes the example JSON in the spans POST valid. (Fixes openzipkin#46). The spans POST documentation is still a bit misleading. With the parameter named "spans", it seems to imply that it's expecting ```json { "spans": [{<...span...>}, {<....span...>}] } ``` but it actually just wants: ```json [{<...span...>}, {<...span...>}] ``` I couldn't figure out a way to acurately represent this in Swagger 2. It might be possible using [Swagger 3 request body descriptions.](https://swagger.io/docs/specification/describing-request-body/)
|
thanks for the help. follow-ups can be a separate PR |
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.
spans POST valid. (Fixes Fix example json #46).
The spans POST documentation is still a bit misleading. With the parameter named "spans", it seems to imply that it's expecting
{ "spans": [{<...span...>}, {<....span...>}] }but it actually wants:
[{<...span...>}, {<...span...>}]I couldn't figure out a way to acurately represent this in Swagger 2. It might be possible using Swagger 3 request body descriptions.