epugh commented on code in PR #1876: URL: https://github.com/apache/solr/pull/1876#discussion_r1311845624
########## dev-docs/apis.adoc: ########## @@ -0,0 +1,81 @@ += APIs in Solr +:toc: left + +Solr's codebase currently has a handful of ways of defining APIs. +This complexity stems largely from two ongoing transitions: +1. Away from our "v1" APIs and towards the new "v2" API. +2. Away from a legacy API framework towards the off-the-shelf JAX-RS library for implementing our v2 APIs + +As these transitions complete, this complexity should simplify considerably. +But in the interim, this document can help guide developers who need to understand or modify APIs in Solr. + +== API Types + +APIs in Solr (regardless of whether v1 or v2) can typically be classified as either a "per-core" or an "admin" API. + +Per-core APIs, as the name suggests, typically affect only a single core or collection, usually used to search or analyze that core's contents in some way. +Implementation-wise, they're registered on the `SolrCore` object itself. +They are configured in solrconfig.xml, which also means they can differ from one core to another based on the configset being used. + +Alternatively "admin" APIs potentially affect the entire Solr instance or cluster. Review Comment: Should we use the term "cluster" instead of Admin? In the packages world, you deploy a core or a cluster package.... Admin makes me feel like it's super specific to the Admin UI too! Whereas plenty of apis don't tie to the Admin UI -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org For additional commands, e-mail: issues-h...@solr.apache.org
