Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SOLR-16390: Tweak clusterprop APIs to be more REST-ful #1993

Conversation

gerlowskija
Copy link
Contributor

https://issues.apache.org/jira/browse/SOLR-16390

Description

Solr has slowly been modifying its v2 APIs to align around a more REST-ful model. Many APIs have already been through this re-alignment but many more remain, including a handful of "collection-admin" APIs.

Solution

This PR chips away at this gap by tweaking Solr's "clusterprop" APIs to be more REST-ful:

  • single property creation+update is now available at PUT /api/cluster/properties/propName {...}
  • bulk property creation+update is now available at PUT /api/cluster/properties {...}
  • single property deletion is now available at DELETE /api/cluster/properties/propName

Tests

TODO

Checklist

Please review the following and check all that apply:

  • I have reviewed the guidelines for How to Contribute and my code conforms to the standards described there to the best of my ability.
  • I have created a Jira issue and added the issue ID to my pull request title.
  • I have given Solr maintainers access to contribute to my PR branch. (optional but recommended)
  • I have developed this patch against the main branch.
  • I have run ./gradlew check.
  • I have added tests for my changes.
  • I have added documentation for the Reference Guide

Also makes some cosmetic changes to these APIs to bring them a bit more
into line with the REST-ful design we're aiming for going forward.

Still needed for this PR:
  - removal of the old '@endpoint'-based v2 clusterprop APIs
  - tidy, check, test, etc.

It's worth noting that this PR mostly only aims at parity with existing
functionality:  There are a few other improvements that we _don't_
attempt to solve.  Particularly:
  - it's tough to update anything but top-level property names using the
    single-prop-update API
  - Tough to fetch anything other than top-level properties.
  - explicit 'null' for deletion is still allowed (Should be remove in
    favor of the DELETE API this PR adds)
@gerlowskija
Copy link
Contributor Author

gerlowskija commented Oct 9, 2023

Currently still TODO:

  • removal of the old '@endpoint'-based v2 clusterprop APIs
  • tidy, check, test, etc.
  • update ref guide

@gerlowskija gerlowskija added the exempt-stale Prevent a PR from going stale label Sep 30, 2024
@gerlowskija
Copy link
Contributor Author

Superceded by #2788; closing!

@gerlowskija gerlowskija deleted the SOLR-16390-cluster-prop-api-conversion branch October 31, 2024 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
exempt-stale Prevent a PR from going stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant