spring-projects / spring-projects/spring-boot

Improve support for configuration metadata clients without classpath access

Open
#33,621 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

theme: config-data type: enhancement
Dominant language
Java
Stars
81.5k
Forks
42.7k
Avg merge
2d 4h
Merged PRs (30d)
65

Description

In our Spring Boot application we have serveral custom configuration properties. As some configuration properties are mantained by domain experts, it's not feasible to give them a text file (properties or yaml) to configure the application.

Therefore we plan to provide a graphical configuration tool which contains uses the Configuration metadata to render certain controls, so users are able to configure the application using a graphical user interface.

The Configuration Metadata Spring Boot provides is a very good starting point, but unfortunately there is certain information missing due to the fact that you don't consider them to be needed in the metadata file. As stated in https://github.com/spring-projects/spring-boot/issues/7562#issuecomment-264687830 by @snicoll the list of enum literals is not included as this can be extracted by the IDE. Unfortunately, in our scenario we don't have an IDE or access to the classpath.

Therefore it would be very helpful to have as many information available in the metadata file as possible to provide the best user experience in our configuration client.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with Spring Boot's configuration metadata generation and the discussion linked in issue 7562. Determine which information a classpath-free graphical client needs; done means the generated metadata exposes that information without IDE or classpath access.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring-boot
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.