You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@solr.apache.org by "ASF subversion and git services (Jira)" <ji...@apache.org> on 2023/04/16 17:49:00 UTC

[jira] [Commented] (SOLR-16393) Cosmetic improvements and migration to JAX-RS (alias, alias-prop CRUD APIs)

    [ https://issues.apache.org/jira/browse/SOLR-16393?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17712825#comment-17712825 ] 

ASF subversion and git services commented on SOLR-16393:
--------------------------------------------------------

Commit 5add6bb945cca82ff33b6007ac2307dd00e9a113 in solr's branch refs/heads/main from Jason Gerlowski
[ https://gitbox.apache.org/repos/asf?p=solr.git;h=5add6bb945c ]

SOLR-16393: Tweak paths of remaining 'POST /collections' APIs (#1571)

Prior to this commit the v2 APIs for create-collection, create-alias,
and restore-collection were all made available as separate "commands"
under the "POST /collections" API.

This commit changes these APIs to use more differentiated paths:
  - `POST /api/collections` for create-collection (no change)
  - `POST /api/aliases` for create-alias
  - `POST /api/backups/backupName/restore` for restore-collection

This brings the APIs closer (but not fully) into line with their more
REST-ful v2 forms, and allows us to make further API modifications and
convert to JAX-RS individually.

(V2 API calls are dispatched in such a way that the legacy and JAX-RS
framework can never overlap or "share" any of the URL paths that they
serve.  See #1453 for more context.)

> Cosmetic improvements and migration to JAX-RS (alias, alias-prop CRUD APIs)
> ---------------------------------------------------------------------------
>
>                 Key: SOLR-16393
>                 URL: https://issues.apache.org/jira/browse/SOLR-16393
>             Project: Solr
>          Issue Type: Sub-task
>          Components: v2 API
>            Reporter: Jason Gerlowski
>            Assignee: Jason Gerlowski
>            Priority: Major
>              Labels: newdev
>          Time Spent: 7h 10m
>  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.
> While we're touching the code for these endpoints, we should also convert them to JAX-RS framework definitions.  (This was initially tracked as a separate effort - see SOLR-16370 - but the edit that were required ended up overlapping so significantly with the "cosmetic" improvements here that in practice it almost always makes sense to do the two together.)
> This ticket plans to tackle making the changes required for Solr's alias and alias-prop CRUD APIs.  These are described in detail in the spreadsheet linked above, but are summarized in the table below for convenience and easier tracking.
> ||API Name||Original Form||Desired Form||Status||Volunteer||
> |-List Alias-|-GET /api/cluster/aliases-|-GET /api/aliases-|-Finished-|-Alex-|
> |Create Alias|POST /api/collections \{"create-alias": \{...\}\}|POST /api/aliases \{...\}|Open|Jason|
> |-Delete Alias-|-POST /api/collections \{"delete-alias": \{...\}\}-|-DELETE /api/aliases/aliasName-|-Finished-|-Jason-|
> |-Set Alias Property-|-POST /api/collections \{"set-alias-property": \{...\}\}-|-PUT /api/aliases/aliasName/properties/propName \{"value": "someVal"\}-|-Finished-|-Alex-|
> |-Delete Alias Property-|-POST /api/collections \{"set-alias-property": \{"propName": ""\}\}-|-DELETE /api/aliases/aliasName/properties/propName-|-Finished-|-Alex-|



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

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