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

Refactor the types to clean up json / jsonschema tags #2786

Closed
AustinAbro321 opened this issue Jul 30, 2024 · 1 comment
Closed

Refactor the types to clean up json / jsonschema tags #2786

AustinAbro321 opened this issue Jul 30, 2024 · 1 comment
Assignees
Milestone

Comments

@AustinAbro321
Copy link
Contributor

Describe what should be investigated or refactored

Currently the types package is messy to read because of all the jsonschema comments. We can utilize features in the invopop/jsonschema to project to auto add go comments as descriptions to the schema, cleaning up the types package. Additionally we can use constants for things like enums, defaults, and patterns which leaves less magic strings in the code.

@AustinAbro321 AustinAbro321 added this to the v0.38.0 milestone Jul 30, 2024
@github-project-automation github-project-automation bot moved this to Backlog in Zarf Jul 30, 2024
@AustinAbro321 AustinAbro321 moved this from Backlog to In progress in Zarf Jul 30, 2024
@AustinAbro321 AustinAbro321 self-assigned this Jul 30, 2024
@AustinAbro321
Copy link
Contributor Author

Partially implemented #2781, and we decided we aren't going to implement the enums or constants through jsonschemaextend

@github-project-automation github-project-automation bot moved this from In progress to Done in Zarf Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant