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

doc: add note to printSchema about the missing directives #3893

Closed

Conversation

YassinEldeeb
Copy link

This adds jsDoc to the printSchema to raise awareness that it won't include directives like the @oneOf directive.

If the user intended to have those directives then use the printSchemaWithDirectives instead.

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented May 9, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: YassinEldeeb / name: Yassin Eldeeb (28a65fc)

@netlify
Copy link

netlify bot commented May 9, 2023

Deploy Preview for compassionate-pike-271cb3 ready!

Name Link
🔨 Latest commit 28a65fc
🔍 Latest deploy log https://app.netlify.com/sites/compassionate-pike-271cb3/deploys/6459b07b7e4b980008bac6b8
😎 Deploy Preview https://deploy-preview-3893--compassionate-pike-271cb3.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link

github-actions bot commented May 9, 2023

Hi @YassinEldeeb, I'm @github-actions bot happy to help you with this PR 👋

Supported commands

Please post this commands in separate comments and only one per comment:

  • @github-actions run-benchmark - Run benchmark comparing base and merge commits for this PR
  • @github-actions publish-pr-on-npm - Build package from this PR and publish it on NPM

@benjie
Copy link
Member

benjie commented Jun 21, 2024

This adds jsDoc to the printSchema to raise awareness that it won't include directives like the @OneOf directive.

That example is not accurate; the @oneOf directive should be output by printSchema in the same way that a @deprecated directive should. However it is currently true for directives that are not built in.

@yaacovCR
Copy link
Contributor

Fixed by #3969 => closing this PR.

Thanks for pointing this out, glad this is fixed!

@yaacovCR yaacovCR closed this Sep 30, 2024
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.

3 participants