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

Website documentation file JsonSchemaHandler.generated.md makes no sense #6858

Open
Woodz opened this issue Apr 17, 2024 · 1 comment
Open

Comments

@Woodz
Copy link

Woodz commented Apr 17, 2024

https://github.com/ardatan/graphql-mesh/blob/master/website/src/generated-markdown/JsonSchemaHandler.generated.md appears to be malformed and confusing:

Specifically:

  1. Parameters exposeResponseMetadata and argTypeMap are indented by 4 spaces which starts a code block, which does not look intentional
  2. The 2 Examples headings do not contain examples as far as I can tell

image

Since this is a generated file, I thought this was a bug in the generation process so therefore raising an MR to try to fix this one file was not sensible

Note: GitHub issue template is not applicable for website documentation so I removed it

@ardatan
Copy link
Owner

ardatan commented Apr 17, 2024

It is generated from this file;
https://github.com/ardatan/graphql-mesh/blob/master/packages/legacy/handlers/json-schema/yaml-config.graphql
by using this command;

"generate-config-schema": "yarn graphql-to-config-schema --schema ./**/yaml-config.graphql --json ./packages/legacy/types/src/config-schema.json --typings ./packages/legacy/types/src/config.ts --markdown ./website/src/generated-markdown && yarn postgenerate-config-schema",

So we need to fix it in this package, otherwise your changes will be gone after the next build;
https://github.com/ardatan/graphql-mesh/blob/master/package.json#L62

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