Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-14907

Support single file upload/overwrite in configSet API

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 8.7, 8.8
    • Component/s: configset-api
    • Labels:
      None

      Description

      After SOLR-10391 was implemented, users are now able to overwrite existing configSets using the configSet API. However the files uploaded are still required to be zipped and indexed from the base configSet path in ZK. Users might want to just update a single file, such as a synonyms list, and not have to tar it up first.

      The proposed solution is to add parameters to the UPLOAD configSet action, to allow this single-file use case. This would utilize the protections already provided by the API, such as maintaining the trustiness of configSets being modified.

      This feature is part of the solution to replace managed resources, which is planned to be deprecated and removed by 9.0 (SOLR-14766).

      The following APIs are being proposed:

      V1:

      Adding to the configSet upload one urlParam, filePath:

       "http://localhost:8983/solr/admin/configs?action=UPLOAD&name=myConfigSet&filePath=solrconfig.xml&overwrite=true"
      

      V2:

      • Uploading a configSet:
         PUT - /api/cluster/configs/{name}
      • Uploading a file in a configSet:
         PUT - /api/cluster/configs/{name}/{filename}

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                houston Houston Putman
                Reporter:
                houston Houston Putman
              • Votes:
                0 Vote for this issue
                Watchers:
                6 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 4.5h
                  4.5h