Skip to content

Enhancement: Support the JsonSchema "format" keyword for the KCL schema generation #440

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

Merged
merged 3 commits into from
Feb 4, 2025

Conversation

Siddhi-agg
Copy link
Contributor

1. Does this PR affect any open issues?(Y/N) and add issue references (e.g. "fix #123", "re #123".):

2. What is the scope of this PR (e.g. component or file name):

kcl-go/pkg/tools/gen/genkcl_jsonschema.go

3. Provide a description of the PR(e.g. more details, effects, motivations or doc link):

  • Affects user behaviors
  • Contains syntax changes
  • Contains variable changes
  • Contains experimental features
  • Performance regression: Consumes more CPU
  • Performance regression: Consumes more Memory
  • Other

4. Are there any breaking changes?(Y/N) and describe the breaking changes(e.g. more details, motivations or doc link):

  • N
  • Y

5. Are there test cases for these changes?(Y/N) select and add more details, references or doc links:

  • Unit test
  • Integration test
  • Benchmark (add benchmark stats below)
  • Manual test (add detailed scripts or steps below)
  • Other

@Siddhi-agg
Copy link
Contributor Author

Siddhi-agg commented Jan 29, 2025

PTAL @Peefy @He1pa @zong-zhe.

I am not sure about what to set the Required and Name field for the validation. I think the Name field should be set to the variable name defined in the beginning of the convertSchemaFromJsonSchema function, like Name: name. Please guide me about this.

Edit: I think the new implementation for Name and Required fields should be correct. Please review it.

@coveralls
Copy link

coveralls commented Feb 4, 2025

Pull Request Test Coverage Report for Build 13124948969

Details

  • 26 of 39 (66.67%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.07%) to 36.529%

Changes Missing Coverage Covered Lines Changed/Added Lines %
pkg/tools/gen/genkcl_jsonschema.go 26 39 66.67%
Totals Coverage Status
Change from base Build 12990286791: 0.07%
Covered Lines: 5495
Relevant Lines: 15043

💛 - Coveralls

Copy link
Contributor

@Peefy Peefy left a comment

Choose a reason for hiding this comment

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

Good Job! LGTM!

@Peefy Peefy merged commit a34879f into kcl-lang:main Feb 4, 2025
17 checks passed
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.

[Enhancement] Support the JsonSchema "format" keyword for the KCL schema generation. support Go API for GetSchemaTypeMapping
3 participants