Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix example json #46

Closed
codefromthecrypt opened this issue Apr 10, 2018 · 0 comments · Fixed by #51
Closed

Fix example json #46

codefromthecrypt opened this issue Apr 10, 2018 · 0 comments · Fixed by #51

Comments

@codefromthecrypt
Copy link
Member

from @jsw on openzipkin/zipkin-gcp#73

The JSON generated by swagger has invalid ids. Took me a while to catch that and sort it out. https://zipkin.io/zipkin-api/#/default/post_spans
@codefromthecrypt codefromthecrypt mentioned this issue Apr 10, 2018
Merged
cshoe added a commit to cshoe/zipkin-api that referenced this issue May 2, 2018
@cshoe
API doc improvements
ae050e2 
* 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/)
@cshoe cshoe mentioned this issue May 2, 2018
Merged
@codefromthecrypt codefromthecrypt mentioned this issue Apr 30, 2019
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

API doc improvements cshoe/zipkin-api
1 participant
@codefromthecrypt