spring-projects / spring-projects/spring-boot

Allow metadata hint values to be contributed by multiple components

Open
#18,408 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

status: pending-design-work type: enhancement
Dominant language
Java
Stars
81.5k
Forks
42.7k
Avg merge
2d 4h
Merged PRs (30d)
65

Description

While reviewing #18363 we concluded that endpoint values could be contributed from multiple different components and offering auto-completion only for the core components could be misleading.

We should improve the meta-data format to be able to:

  • Have the same list of values for multiple keys without having to define it multiple times. Endpoint IDs can be used in includes, excludes, web mappings, etc. Right now the full list has to be defined as a metadata hint for every key
  • Offer a way for another component (jar) to contribute additional value (if allowed). This would allow other modules defining Actuator endpoints to provide their own values

Given that the annotation processor has already some logic for actuator endpoint, we could generate the latter automatically but it is an interesting concept for other use cases too.

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 by examining the existing metadata format and the annotation-processor logic for Actuator endpoints mentioned in the issue. Trace how endpoint values are currently defined for metadata hints, then establish how shared values and contributions from other components should be represented and verified.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring-boot
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.