feat: Generate docs from JSON schema #50
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
candiduslynx
force-pushed
the
feat/jsonschema/doc
branch
from
d02edf6
to
33799f8
Compare
This reverts commit 33799f8.
candiduslynx
force-pushed
the
feat/jsonschema/doc
branch
from
5561038
to
c1c6569
Compare
candiduslynx
force-pushed
the
feat/jsonschema/doc
branch
from
c3ae226
to
aa0ad21
Compare
hermanschaaf
approved these changes
Oct 17, 2023
There was a problem hiding this comment.
Very cool, and I think we can merge this in as a starting point. Before we can use it though we'll need to incorporate descriptions for the fields as well. In this package it seems relatively straight-forward, we can use the description field if set.
For generating the schemas from Go code though, maybe we can read the comments above each field using reflection, like we used to do in CQ v0 for generating table column descriptions.
candiduslynx
force-pushed
the
feat/jsonschema/doc
branch
from
7aa8816
to
0c06407
Compare
kodiakhq bot
pushed a commit
that referenced
this pull request
Oct 18, 2023
🤖 I have created a release *beep* *boop* --- ## [0.3.9](v0.3.8...v0.3.9) (2023-10-18) ### Features * Add options appicable to `jsonschema.Reflector` prior to generation ([#60](#60)) ([2cace1e](2cace1e)) * Generate docs from JSON schema ([#50](#50)) ([ce84add](ce84add)) ### Bug Fixes * **deps:** Update module github.com/cloudquery/plugin-sdk/v4 to v4.13.0 ([#55](#55)) ([507131a](507131a)) * **deps:** Update module github.com/cloudquery/plugin-sdk/v4 to v4.14.0 ([#57](#57)) ([31ade81](31ade81)) * **deps:** Update module github.com/cloudquery/plugin-sdk/v4 to v4.14.1 ([#58](#58)) ([6002349](6002349)) * **deps:** Update module github.com/cloudquery/plugin-sdk/v4 to v4.15.0 ([#59](#59)) ([2c6f5a8](2c6f5a8)) * **deps:** Update module github.com/cloudquery/plugin-sdk/v4 to v4.15.1 ([#61](#61)) ([dca6592](dca6592)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.