[
https://issues.apache.org/jira/browse/SOLR-16392?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17623211#comment-17623211
]
Jason Gerlowski commented on SOLR-16392:
----------------------------------------
To be a little more explicit about the APIs we want this ticket to cover, I
found 3 APIs that need work related to replica/shard/replicaprop CRUD:
* Create Shard
** Current Form: POST /api/collections/collName/shards \{'create": \{...\}\}
** Desired Form: POST /api/collections/collName/shards \{...\}
** Spreadsheet Ref: Tab 1, Line 27
* Create Replica
** Current Form: POST /api/collections/collName/shards \{'add-replica":
\{...\}\}
** Desired Form: POST /api/collections/collName/shards/shardName/replicas
\{...\}
** Spreadsheet Ref: Tab 1, Line 32
* Delete Replica Property
** Current Form: POST /api/collections/collName \{"delete-replica-property":
\{...\}\}
** Desired Form: DELETE
/api/collections/collName/shards/shardName/replicas/replicaName/properties/propName
** Spreadsheet Ref: Tab 1, Line 44
IMO it makes sense to split these up across different PRs, doing some small
number (i.e. 1 or 2) of APIs per-PR, though maybe they could all be tackled in
a single larger PR as well. If anyone wants to help chip away at this, just
call out which APIs from this list you intend to work on and we can parallelize
them.
In terms of the steps required, the JIRA comments
[here|https://issues.apache.org/jira/browse/SOLR-15737?focusedCommentId=17617806&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17617806]
and
[here|https://issues.apache.org/jira/browse/SOLR-15737?focusedCommentId=17617923&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17617923]
give some good background and step-by-step instructions for switching APIs
over to the new JAX-RS framework, which is usually helpful or even required as
the traditional v2 framework doesn't lend itself very readily to RESTful APIs.
(Those comments describe creating a new API "from scratch", but the steps are
still applicable to modifying an existing API.) The PR
[here|https://github.com/apache/solr/pull/1053] also serves as a helpful
example to work from.
Not all API modifications require the new JAX-RS framework, though it is
preferred going forward. Instructions for updating APIs using the older,
traditional v2 framework can be found
[here|https://issues.apache.org/jira/browse/SOLR-15737?focusedCommentId=17565076&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17565076],
and an example PR can be found [here|https://github.com/apache/solr/pull/1061].
> Cosmetic, REST-fulness improvements to v2 shard, replica, and replicaprop
> CRUD APIs
> -----------------------------------------------------------------------------------
>
> Key: SOLR-16392
> URL: https://issues.apache.org/jira/browse/SOLR-16392
> Project: Solr
> Issue Type: Sub-task
> Components: v2 API
> Affects Versions: main (10.0)
> Reporter: Jason Gerlowski
> Assignee: Jason Gerlowski
> Priority: Major
> Time Spent: 2h 50m
> Remaining Estimate: 0h
>
> As mentioned on SOLR-15781, the v2 API currently has an experimental
> designation, and the community has expressed an interest in using this period
> to update our v2 endpoints to be more REST-ful and consistent. The current
> plan is to follow the
> specific changes laid out in [this
> spreadsheet|https://docs.google.com/spreadsheets/d/1HAoBBFPpSiT8mJmgNZKkZAPwfCfPvlc08m5jz3fQBpA/edit?usp=sharing],
> though of course nothing there is set in stone and there are still warts to
> be worked out.
>
> This ticket plans to tackle making the changes required for Solr's shard,
> replica and replica-prop CRUD APIs, as described in that spreadsheet.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
