SOLR-18457: Migrate V2 /update endpoints to using JAX-RS

changelog/unreleased/SOLR-18457-migrate-update-api-to-jax-rs.yml

@@ -0,0 +1,7 @@
+title: Migrate v2 update endpoints to JAX-RS and rename the Javabin endpoint to /update/javabin.  Migrate Admin UI to using v2 endpoints, fixing UI issues in the document upload screen.  Document screen only works with /upload endpoint, no longer can specify a custom endpoint.
+type: changed
+authors:
+  - name: Eric Pugh
+links:
+  - name: SOLR-18457
+    url: https://issues.apache.org/jira/browse/SOLR-18457

solr/api/src/java/org/apache/solr/client/api/endpoint/UpdateApi.java

@@ -0,0 +1,211 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.solr.client.api.endpoint;
+
+import static org.apache.solr.client.api.util.Constants.GENERIC_ENTITY_PROPERTY;
+import static org.apache.solr.client.api.util.Constants.INDEX_PATH_PREFIX;
+
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.extensions.Extension;
+import io.swagger.v3.oas.annotations.extensions.ExtensionProperty;
+import io.swagger.v3.oas.annotations.parameters.RequestBody;
+import jakarta.ws.rs.Consumes;
+import jakarta.ws.rs.POST;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.QueryParam;
+import java.io.InputStream;
+import org.apache.solr.client.api.model.UpdateResponse;
+import org.apache.solr.client.api.util.StoreApiParameters;
+
+/** V2 API definitions for indexing documents via the update handler. */
+@Path(INDEX_PATH_PREFIX + "/update")
+public interface UpdateApi {
+
+  @POST
+  @Consumes({
+    "application/json",
+    "text/json",
+    "application/xml",
+    "text/xml",
+    "application/csv",
+    "text/csv",
+    "application/javabin",
+    "application/cbor"
+  })
+  @StoreApiParameters
+  @Operation(
+      summary = "Send updates using any supported content type",
+      tags = {"update"})
+  UpdateResponse update(
+      @Parameter(description = "Commit the update immediately") @QueryParam("commit")
+          Boolean commit,
+      @Parameter(description = "Commit the update within this many milliseconds")
+          @QueryParam("commitWithin")
+          Integer commitWithin,
+      @Parameter(description = "Overwrite documents with the same unique key")
+          @QueryParam("overwrite")
+          Boolean overwrite,
+      @Parameter(description = "Perform a soft commit") @QueryParam("softCommit")
+          Boolean softCommit,
+      @Parameter(description = "Include assigned document versions in the response")
+          @QueryParam("versions")
+          Boolean versions,
+      @Parameter(required = true)
+          @RequestBody(
+              required = true,
+              description = "Update content in the format selected by the Content-Type header.",
+              extensions =
+                  @Extension(
+                      properties = {
+                        @ExtensionProperty(name = GENERIC_ENTITY_PROPERTY, value = "true")
+                      }))
+          InputStream requestBody)
+      throws Exception;
+
+  @POST
+  @Path("/json")
+  @Consumes({"application/json", "text/json"})
+  @StoreApiParameters
+  @Operation(
+      summary = "Index documents in JSON format",
+      tags = {"update"})
+  UpdateResponse updateJson(
+      @Parameter(description = "Commit the update immediately") @QueryParam("commit")
+          Boolean commit,
+      @Parameter(description = "Commit the update within this many milliseconds")
+          @QueryParam("commitWithin")
+          Integer commitWithin,
+      @Parameter(description = "Overwrite documents with the same unique key")
+          @QueryParam("overwrite")
+          Boolean overwrite,
+      @Parameter(description = "Perform a soft commit") @QueryParam("softCommit")
+          Boolean softCommit,
+      @Parameter(description = "Include assigned document versions in the response")
+          @QueryParam("versions")
+          Boolean versions,
+      @Parameter(required = true)
+          @RequestBody(
+              required = true,
+              description = "JSON update content.",
+              extensions =
+                  @Extension(
+                      properties = {
+                        @ExtensionProperty(name = GENERIC_ENTITY_PROPERTY, value = "true")
+                      }))
+          InputStream requestBody)
+      throws Exception;
+
+  @POST
+  @Path("/xml")
+  @Consumes({"application/xml", "text/xml"})
+  @StoreApiParameters
+  @Operation(
+      summary = "Index documents in XML format",
+      tags = {"update"})
+  UpdateResponse updateXml(
+      @Parameter(description = "Commit the update immediately") @QueryParam("commit")
+          Boolean commit,
+      @Parameter(description = "Commit the update within this many milliseconds")
+          @QueryParam("commitWithin")
+          Integer commitWithin,
+      @Parameter(description = "Overwrite documents with the same unique key")
+          @QueryParam("overwrite")
+          Boolean overwrite,
+      @Parameter(description = "Perform a soft commit") @QueryParam("softCommit")
+          Boolean softCommit,
+      @Parameter(description = "Include assigned document versions in the response")
+          @QueryParam("versions")
+          Boolean versions,
+      @Parameter(required = true)
+          @RequestBody(
+              required = true,
+              description = "XML update content.",
+              extensions =
+                  @Extension(
+                      properties = {
+                        @ExtensionProperty(name = GENERIC_ENTITY_PROPERTY, value = "true")
+                      }))
+          InputStream requestBody)
+      throws Exception;
+
+  @POST
+  @Path("/csv")
+  @Consumes({"application/csv", "text/csv"})
+  @StoreApiParameters
+  @Operation(
+      summary = "Index documents in CSV format",
+      tags = {"update"})
+  UpdateResponse updateCsv(
+      @Parameter(description = "Commit the update immediately") @QueryParam("commit")
+          Boolean commit,
+      @Parameter(description = "Commit the update within this many milliseconds")
+          @QueryParam("commitWithin")
+          Integer commitWithin,
+      @Parameter(description = "Overwrite documents with the same unique key")
+          @QueryParam("overwrite")
+          Boolean overwrite,
+      @Parameter(description = "Perform a soft commit") @QueryParam("softCommit")
+          Boolean softCommit,
+      @Parameter(description = "Include assigned document versions in the response")
+          @QueryParam("versions")
+          Boolean versions,
+      @Parameter(required = true)
+          @RequestBody(
+              required = true,
+              description = "CSV update content.",
+              extensions =
+                  @Extension(
+                      properties = {
+                        @ExtensionProperty(name = GENERIC_ENTITY_PROPERTY, value = "true")
+                      }))
+          InputStream requestBody)
+      throws Exception;
+
+  @POST
+  @Path("/javabin")
+  @Consumes("application/javabin")
+  @StoreApiParameters
+  @Operation(
+      summary = "Index documents in Javabin format",
+      tags = {"update"})
+  UpdateResponse updateJavabin(
+      @Parameter(description = "Commit the update immediately") @QueryParam("commit")
+          Boolean commit,
+      @Parameter(description = "Commit the update within this many milliseconds")
+          @QueryParam("commitWithin")
+          Integer commitWithin,
+      @Parameter(description = "Overwrite documents with the same unique key")
+          @QueryParam("overwrite")
+          Boolean overwrite,
+      @Parameter(description = "Perform a soft commit") @QueryParam("softCommit")
+          Boolean softCommit,
+      @Parameter(description = "Include assigned document versions in the response")
+          @QueryParam("versions")
+          Boolean versions,
+      @Parameter(required = true)
+          @RequestBody(
+              required = true,
+              description = "Javabin update content.",
+              extensions =
+                  @Extension(
+                      properties = {
+                        @ExtensionProperty(name = GENERIC_ENTITY_PROPERTY, value = "true")
+                      }))
+          InputStream requestBody)
+      throws Exception;
+}

solr/api/src/java/org/apache/solr/client/api/model/UpdateResponse.java

@@ -0,0 +1,37 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.solr.client.api.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
+import java.util.List;
+
+/** Version information returned by an update request with {@code versions=true}. */
+public class UpdateResponse extends SolrJerseyResponse {
+
+  @JsonProperty("adds")
+  @Schema(description = "Documents added and the versions assigned to them.")
+  public List<VersionedDocument> adds;
+
+  @JsonProperty("deletes")
+  @Schema(description = "Documents deleted and the versions assigned to their delete operations.")
+  public List<VersionedDocument> deletes;
+
+  @JsonProperty("deleteByQuery")
+  @Schema(description = "Delete-by-query operations and the versions assigned to them.")
+  public List<VersionedQuery> deleteByQuery;
+}

solr/api/src/java/org/apache/solr/client/api/model/VersionedDocument.java

@@ -0,0 +1,32 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.solr.client.api.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
+
+/** A document identifier and the version assigned to an update operation. */
+public class VersionedDocument {
+
+  @JsonProperty("id")
+  @Schema(description = "The document's unique identifier.")
+  public String id;
+
+  @JsonProperty("version")
+  @Schema(description = "The version assigned to the operation.")
+  public long version;
+}

solr/api/src/java/org/apache/solr/client/api/model/VersionedQuery.java

@@ -0,0 +1,32 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.solr.client.api.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import io.swagger.v3.oas.annotations.media.Schema;
+
+/** A delete-by-query expression and the version assigned to the operation. */
+public class VersionedQuery {
+
+  @JsonProperty("query")
+  @Schema(description = "The delete-by-query expression.")
+  public String query;
+
+  @JsonProperty("version")
+  @Schema(description = "The version assigned to the operation.")
+  public long version;
+}

solr/core/src/java/org/apache/solr/handler/V2UpdateRequestHandler.java

@@ -18,26 +18,34 @@
 package org.apache.solr.handler;
 
 import java.util.Collection;
-import org.apache.solr.api.AnnotatedApi;
+import java.util.List;
 import org.apache.solr.api.Api;
+import org.apache.solr.api.JerseyResource;
 import org.apache.solr.handler.admin.api.UpdateAPI;
+import org.apache.solr.jersey.APIConfigProvider;
 
 /**
- * An extension of {@link UpdateRequestHandler} used solely to register the v2 /update APIs
+ * An extension of {@link UpdateRequestHandler} used solely to register the v2 /update APIs.
  *
  * <p>At core-load time, Solr looks at each 'plugin' in ImplicitPlugins.json, fetches the v2 {@link
- * Api} implementations associated with each RequestHandler, and registers them in an {@link
- * org.apache.solr.api.ApiBag}. Since UpdateRequestHandler is mentioned multiple times in
- * ImplicitPlugins.json (once for each update API: /update, /update/json, etc.), this would cause
+ * org.apache.solr.api.Api} implementations associated with each RequestHandler, and registers them
+ * in an {@link org.apache.solr.api.ApiBag}. Since UpdateRequestHandler is mentioned multiple times
+ * in ImplicitPlugins.json (once for each update API: /update, /update/json, etc.), this would cause
  * the v2 APIs to be registered in duplicate. To avoid this, Solr has this RequestHandler, whose
  * only purpose is to register the v2 APIs that conceptually should be associated with
  * UpdateRequestHandler.
  */
-public class V2UpdateRequestHandler extends UpdateRequestHandler {
+public class V2UpdateRequestHandler extends UpdateRequestHandler
+    implements APIConfigProvider<UpdateAPI.UpdateRequestHandlerConfig> {
 
   @Override
   public Collection<Api> getApis() {
-    return AnnotatedApi.getApis(new UpdateAPI(this));
+    return List.of();
+  }
+
+  @Override
+  public Collection<Class<? extends JerseyResource>> getJerseyResources() {
+    return List.of(UpdateAPI.class);
   }
 
   @Override
@@ -49,4 +57,14 @@ public Boolean registerV1() {
   public Boolean registerV2() {
     return Boolean.TRUE;
   }
+
+  @Override
+  public UpdateAPI.UpdateRequestHandlerConfig provide() {
+    return new UpdateAPI.UpdateRequestHandlerConfig(this);
+  }
+
+  @Override
+  public Class<UpdateAPI.UpdateRequestHandlerConfig> getConfigClass() {
+    return UpdateAPI.UpdateRequestHandlerConfig.class;
+  }
 }