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

Fix wrong jsdoc links #68

Merged
merged 1 commit into from
May 5, 2020
Merged

Fix wrong jsdoc links #68

merged 1 commit into from
May 5, 2020

Conversation

satazor
Copy link
Contributor

@satazor satazor commented May 2, 2020

Fixes #67

Checklist

  • run npm run test and npm run benchmark
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message and code follows Code of conduct

@satazor
Copy link
Contributor Author

satazor commented May 2, 2020

@mcollina I've noticed that the links are still broken as we are pointing to https://json-schema.org/latest/json-schema-validation.html which redirects to https://json-schema.org/draft/2019-09/json-schema-validation.html, making all the hash tags to be lost (#xxxxx).

Can I change all the links to https://json-schema.org/draft/2019-09/json-schema-validation.html?

@mcollina
Copy link
Member

mcollina commented May 2, 2020

ok for me

@Eomm
Copy link
Member

Eomm commented May 2, 2020

Can I change all the links to https://json-schema.org/draft/2019-09/json-schema-validation.html?

No, that version is not supported: it is draft 08 and we (like ajv) support draft 07!

I didn't find the right link, it should be hidden here https://json-schema.org/specification-links.html#draft-7

@aboutlo
Copy link
Collaborator

aboutlo commented May 2, 2020

@satazor this is the draft7 reference page https://tools.ietf.org/id/draft-handrews-json-schema-validation-02.html (not nice URL). However, you can use as base URL.

@satazor
Copy link
Contributor Author

satazor commented May 2, 2020

@aboutlo It seems we are using 01: https://tools.ietf.org/html/draft-handrews-json-schema-01

For instance, in Array schema, fluent-schema uses dependencies from 01 while it was renamed to dependentRequired in 02.

Can I update to use https://tools.ietf.org/html/draft-handrews-json-schema-01?

@aboutlo
Copy link
Collaborator

aboutlo commented May 2, 2020

nice catch @satazor, then yes it's 01

@satazor satazor force-pushed the fix/jsdoc-links branch 12 times, most recently from d3247cc to fae8f7f Compare May 2, 2020 14:44
@satazor
Copy link
Contributor Author

satazor commented May 2, 2020

This should be ready to be merged.

  • I've standardized the position of links since some were at the top while others were in parameters. Now they are all at the top, except for ifThen and ifThenElse.
  • Spotted some wrong hash tags and fixed them.
  • Added doc block for not.
  • Fixed some broken jsdocs due to missing new lines.

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, thanks for all the work!

@satazor
Copy link
Contributor Author

satazor commented May 2, 2020

@mcollina no problem, and thank you and the team for this lib!

@aboutlo aboutlo merged commit 5b9957b into fastify:master May 5, 2020
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

Successfully merging this pull request may close these issues.

Links to https://json-schema.org in the full API docs are broken
4 participants