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

create a json validation schema for the project. #1268

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Motouom
Copy link
Collaborator

@Motouom Motouom commented Feb 4, 2025

What this PR does / why we need it:

Which issue this PR fixes (optional, in `fixes #1122. will close that issue when PR gets merged): fixes #1122

Special notes for your reviewer:

PR Readiness Checklist:

Complete these before marking the PR as ready to review:

  • the CHANGELOG.md release notes have been updated to reflect any significant (and particularly user-facing) changes introduced by this PR

@Motouom Motouom self-assigned this Feb 4, 2025
@Motouom
Copy link
Collaborator Author

Motouom commented Feb 5, 2025

CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
Contributor

@thomasdarimont thomasdarimont left a comment

Choose a reason for hiding this comment

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

This looks helpful. Is this schema written by hand or generated somehow?
If the schema can be generated, we should add a script and document the generation process.

Also we should update the examples (or add a new one) yaml files that shows how to use the json schema reference with intellij / vscode, e.g. as discussed here:
https://github.com/orgs/adorsys/projects/5/views/1?pane=issue&itemId=91205605&issue=adorsys%7Ckeycloak-config-cli%7C1122

@@ -0,0 +1,14654 @@
{
"$schema": "http://json-schema.org/draft-06/schema#",
"$ref": "#/definitions/Welcome6",
Copy link
Contributor

Choose a reason for hiding this comment

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

What is the meaning of the Welcome reference? Shouldn't it be named differently, e.g. realmConfig?

Co-authored-by: Thomas Darimont <[email protected]>
CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
Contributor

@thomasdarimont thomasdarimont left a comment

Choose a reason for hiding this comment

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

Please fix the small typo

Co-authored-by: Thomas Darimont <[email protected]>
Copy link

sonarqubecloud bot commented Feb 6, 2025

@Motouom
Copy link
Collaborator Author

Motouom commented Feb 6, 2025

Okay @thomasdarimont. I will work on that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

Improve config validation and editing
2 participants