Good idea! One thing that'd make this a bit awkward is the way individual v1 RequestHandlers often map to many many v2 APIs. (e.g. CollectionsHandler covers > 40 "operation" types, for instance!). Maybe using Javadoc's '@see' directive would scale a little better for these cases?
In any case, +1 to the idea. Did you have a JIRA? (Or will you create one following this thread?) Best, Jason On Fri, Aug 9, 2024 at 5:07 PM David Smiley <dsmi...@apache.org> wrote: > > Recently, a colleague and I enhanced a V1 API and it wasn't obvious > how to even find the V2 equivalent. It was a face-palm moment for me > after the work was done & merged: > > https://issues.apache.org/jira/browse/SOLR-17381?focusedCommentId=17872457&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-17872457 > > I'd like to propose that our V1 APIs link to the corresponding V2 APIs > in Javadocs in a consistent fashion. I'm thinking of something like: > Superceded by V2: {@link ClusterAPI} and {@link ListAliasesApi} > and {@link CollectionStatusAPI}. > > Not sure if "original V2" vs "JAX-RS V2" should make a difference. > > ~ David Smiley > Apache Lucene/Solr Search Developer > http://www.linkedin.com/in/davidwsmiley > > --------------------------------------------------------------------- > To unsubscribe, e-mail: dev-unsubscr...@solr.apache.org > For additional commands, e-mail: dev-h...@solr.apache.org > --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@solr.apache.org For additional commands, e-mail: dev-h...@solr.apache.org
