[jira] [Created] (SOLR-15117) Support for "description" metadata in annotation-based v2 APIs

["Jason Gerlowski (Jira)" <ji...@apache.org>]

Jason Gerlowski created SOLR-15117:
--------------------------------------

             Summary: Support for "description" metadata in annotation-based v2 APIs
                 Key: SOLR-15117
                 URL: https://issues.apache.org/jira/browse/SOLR-15117
             Project: Solr
          Issue Type: Improvement
      Security Level: Public (Default Security Level. Issues are Public)
          Components: v2 API
    Affects Versions: 8.7
            Reporter: Jason Gerlowski


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.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org