[SOLR-15117] Support for "description" metadata in annotation-based v2 APIs

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Affects Version/s: 8.7
• Component/s: v2 API
• Assignee: Unassigned
• Reporter: Jason Gerlowski
• Created: 28/Jan/21 17:36
• Updated: 13/Feb/21 00:08

Description

Solr's v2 APIs are implemented in two different ways: some are declared in a JSON spec file while others are defined by annotated Java classes (similar to JAX-RS, etc.).

The annotation-based approach has several advantages and is the preferred one going forward. But it lacks any equivalent of the "description" property used by the JSON-based APIs. This property is used to document the APIs and their parameters in /_introspect output.

We should find a way to support this "description" information for the annotation-based v2 APIs, as /_introspect is much less useful without it.