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

Relax the configuration file format #90

Open
ralienpp opened this issue Feb 15, 2024 · 1 comment
Open

Relax the configuration file format #90

ralienpp opened this issue Feb 15, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@ralienpp
Copy link
Collaborator

When getting started with CmpRaComponent, even a basic "hello world" example can be a challenge, because it requires the user to fill out some boilerplate structures in the configuration file. This is especially problematic if the user is not yet familiar with the meaning of every option.

An example is when empty structures need to be created:

DownstreamConfiguration:
  - VerificationContext:

A simpler and more compact config could let the user omit such entries altogether. In the current situation, these lines are only here to help the parser (at the expense of extra work for the user).

Another example is to consider a more compact notation like ForceRaVerifyOnUpstream: true instead of the current:

ForceRaVerifyOnUpstream:
  - value: true

My understanding is that these are effects of using https://github.com/eclipse-ee4j/jaxb-ri for automatically processing YAML files into Java objects. Perhaps some improvement can be made by adjusting parameters of jaxbi, or maybe there are other types of low-hanging fruits.

@ralienpp ralienpp added the enhancement New feature or request label Feb 15, 2024
@Akretsch
Copy link
Collaborator

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants