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.

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

Figure out why parameter descriptions aren't rendering #11

Closed
codefromthecrypt opened this issue Apr 26, 2016 · 4 comments
Closed

Figure out why parameter descriptions aren't rendering #11

codefromthecrypt opened this issue Apr 26, 2016 · 4 comments

Comments

@codefromthecrypt
Copy link
Member

codefromthecrypt commented Apr 26, 2016

parameters like serviceName have a description, but the output doesn't show them

ex. http://zipkin.io/zipkin-api/#/paths/%252Ftraces doesn't render the description for serviceName

@codefromthecrypt
Copy link
Member Author

updated to latest sway and got a warning.. maybe the schema is different than what we are using

$ npm test
> [email protected] test /Users/acole/oss/zipkin-api
> node validate.js

Warnings:
[{"code":"EXTRA_REFERENCE_PROPERTIES","message":"Extra JSON Reference properties will be ignored: description","path":["paths","/trace/{traceId}","get","responses","200","schema"]}]
Validation passed

@mohsen1
Copy link
Contributor

mohsen1 commented Apr 26, 2016

That means a $ref has a sibling somewhere. All of $ref siblings will be overwritten with the result of the pointer by resolver.

@codefromthecrypt
Copy link
Member Author

codefromthecrypt commented Apr 26, 2016

Thanks for the tip. maybe an upgrade fixes the parameter description thing.. we'll see #12

@codefromthecrypt codefromthecrypt changed the title Figure out why field descriptions aren't rendering Figure out why parameter descriptions aren't rendering Apr 26, 2016
@codefromthecrypt
Copy link
Member Author

Fixed by #12

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants