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 bundle schema documentation generation #1006

Closed
wants to merge 4 commits into from
Closed

Conversation

shreyas-goenka
Copy link
Contributor

@shreyas-goenka shreyas-goenka commented Nov 23, 2023

Changes

This PR makes the following improvements to the bundle schema documentation generation

  1. Fixes enviroment block not being generated.
  2. Improves manual edit SOP making it more crisp.
  3. Regenerates the bundle schema documentatation with the latest openapi spec. Regenerated using commit in .codegen/__openapi_sha (e7b127cb07af8dd4d8c61c7cc045c8910cdbb02a)

Tests

Tested manually.

  1. Now enviroment block descriptions are not being deleted. Before they were being reset to empty strings on a schema documentation generation.
  2. Manually tested the manual edit SOP it works as expected.
  3. Took a look at the new docs. They are loaded into the schema correctly, and the changes to the descriptions in general look good.

@shreyas-goenka shreyas-goenka changed the title Update bundle schema documentation Fix bundle schema documentation generation Nov 23, 2023
@@ -36,7 +51,7 @@
}
}
},
"targets": {
"environments": {
Copy link
Contributor

Choose a reason for hiding this comment

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

This is intentional; we want to nudge folks to using "targets".

Copy link
Contributor Author

@shreyas-goenka shreyas-goenka Nov 24, 2023

Choose a reason for hiding this comment

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

This would mean a small regression for existing users of environments. Should we remove the dsecriptions all together for environments?

FYI, I am fine with either.

Copy link
Contributor

Choose a reason for hiding this comment

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

Removing it or deprecating it is an incentive to update it.

Btw, there is a deprecated property in JSON schema that could be used (if easy to do): https://json-schema.org/draft/2019-09/json-schema-validation#rfc.section.9.3

@shreyas-goenka
Copy link
Contributor Author

Closing in favour of #1012

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.

2 participants