Migrate Schema Designer to JAX-RS Apis. Fix some bugs.

changelog/unreleased/SOLR-18152-add-configset-download-zip-to-solrj-fix-schema-designer-bug.yml

@@ -0,0 +1,8 @@
+# See https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc
+title: The "analyze" existing documents feature of Schema Designer was fixed.  Added a new ConfigSet.Download and ConfigSet.GetFile capablities to SolrJ.
+type: fixed # added, changed, fixed, deprecated, removed, dependency_update, security, other
+authors:
+  - name: Eric Pugh
+links:
+  - name: SOLR-18152
+    url: https://issues.apache.org/jira/browse/SOLR-18152

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

@@ -16,18 +16,26 @@
  */
 package org.apache.solr.client.api.endpoint;
 
+import static org.apache.solr.client.api.util.Constants.RAW_OUTPUT_PROPERTY;
+
 import io.swagger.v3.oas.annotations.Operation;
+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.DELETE;
 import jakarta.ws.rs.GET;
 import jakarta.ws.rs.POST;
 import jakarta.ws.rs.PUT;
 import jakarta.ws.rs.Path;
 import jakarta.ws.rs.PathParam;
+import jakarta.ws.rs.Produces;
 import jakarta.ws.rs.QueryParam;
+import jakarta.ws.rs.core.MediaType;
+import jakarta.ws.rs.core.Response;
 import java.io.IOException;
 import java.io.InputStream;
 import org.apache.solr.client.api.model.CloneConfigsetRequestBody;
+import org.apache.solr.client.api.model.ConfigSetFileContentsResponse;
 import org.apache.solr.client.api.model.ListConfigsetsResponse;
 import org.apache.solr.client.api.model.SolrJerseyResponse;
 
@@ -71,6 +79,46 @@ SolrJerseyResponse deleteConfigSet(@PathParam("configSetName") String configSetN
         throws Exception;
   }
 
+  /**
+   * V2 API definition for downloading an existing configset as a ZIP archive.
+   *
+   * <p>Equivalent to GET /api/configsets/{configSetName}/download
+   */
+  @Path("/configsets/{configSetName}")
+  interface Download {
+    @GET
+    @Path("/download")
+    @Operation(
+        summary = "Download a configset as a ZIP archive.",
+        tags = {"configsets"},
+        extensions = {
+          @Extension(properties = {@ExtensionProperty(name = RAW_OUTPUT_PROPERTY, value = "true")})
+        })
+    @Produces("application/zip")
+    Response downloadConfigSet(
+        @PathParam("configSetName") String configSetName,
+        @QueryParam("displayName") String displayName)
+        throws Exception;
+  }
+
+  /**
+   * V2 API definition for reading a single file from an existing configset.
+   *
+   * <p>Equivalent to GET /api/configsets/{configSetName}/file?path=...
+   */
+  @Path("/configsets/{configSetName}")
+  interface GetFile {
+    @GET
+    @Path("/file")
+    @Produces(MediaType.TEXT_PLAIN)
+    @Operation(
+        summary = "Get the contents of a file in a configset.",
+        tags = {"configsets"})
+    ConfigSetFileContentsResponse getConfigSetFile(
+        @PathParam("configSetName") String configSetName, @QueryParam("path") String filePath)
+        throws Exception;
+  }
+
   /**
    * V2 API definitions for uploading a configset, in whole or part.
    *

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

@@ -0,0 +1,165 @@
+/*
+ * 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 io.swagger.v3.oas.annotations.Operation;
+import jakarta.ws.rs.DELETE;
+import jakarta.ws.rs.DefaultValue;
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.POST;
+import jakarta.ws.rs.PUT;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import jakarta.ws.rs.QueryParam;
+import java.util.List;
+import org.apache.solr.client.api.model.FlexibleSolrJerseyResponse;
+import org.apache.solr.client.api.model.SchemaDesignerCollectionsResponse;
+import org.apache.solr.client.api.model.SchemaDesignerConfigsResponse;
+import org.apache.solr.client.api.model.SchemaDesignerInfoResponse;
+import org.apache.solr.client.api.model.SchemaDesignerPublishResponse;
+import org.apache.solr.client.api.model.SchemaDesignerResponse;
+import org.apache.solr.client.api.model.SchemaDesignerSchemaDiffResponse;
+import org.apache.solr.client.api.model.SolrJerseyResponse;
+
+/** V2 API definitions for the Solr Schema Designer. */
+@Path("/schema-designer")
+public interface SchemaDesignerApi {
+
+  @GET
+  @Path("/{configSet}/info")
+  @Operation(
+      summary = "Get info about a configSet being designed.",
+      tags = {"schema-designer"})
+  SchemaDesignerInfoResponse getInfo(@PathParam("configSet") String configSet) throws Exception;
+
+  @POST
+  @Path("/{configSet}/prep")
+  @Operation(
+      summary = "Prepare a mutable configSet copy for schema design.",
+      tags = {"schema-designer"})
+  SchemaDesignerResponse prepNewSchema(
+      @PathParam("configSet") String configSet, @QueryParam("copyFrom") String copyFrom)
+      throws Exception;
+
+  @DELETE
+  @Path("/{configSet}")
+  @Operation(
+      summary = "Clean up temporary resources for a schema being designed.",
+      tags = {"schema-designer"})
+  SolrJerseyResponse cleanupTempSchema(@PathParam("configSet") String configSet) throws Exception;
+
+  @PUT
+  @Path("/{configSet}/file")
+  @Operation(
+      summary = "Update the contents of a file in a configSet being designed.",
+      tags = {"schema-designer"})
+  SchemaDesignerResponse updateFileContents(
+      @PathParam("configSet") String configSet, @QueryParam("file") String file) throws Exception;
+
+  @GET
+  @Path("/{configSet}/sample")
+  @Operation(
+      summary = "Get a sample value and analysis for a field.",
+      tags = {"schema-designer"})
+  FlexibleSolrJerseyResponse getSampleValue(
+      @PathParam("configSet") String configSet,
+      @QueryParam("field") String fieldName,
+      @QueryParam("uniqueKeyField") String idField,
+      @QueryParam("docId") String docId)
+      throws Exception;
+
+  @GET
+  @Path("/{configSet}/collectionsForConfig")
+  @Operation(
+      summary = "List collections that use a given configSet.",
+      tags = {"schema-designer"})
+  SchemaDesignerCollectionsResponse listCollectionsForConfig(
+      @PathParam("configSet") String configSet) throws Exception;
+
+  @GET
+  @Path("/configs")
+  @Operation(
+      summary = "List all configSets available for schema design.",
+      tags = {"schema-designer"})
+  SchemaDesignerConfigsResponse listConfigs() throws Exception;
+
+  @POST
+  @Path("/{configSet}/add")
+  @Operation(
+      summary = "Add a new field, field type, or dynamic field to the schema being designed.",
+      tags = {"schema-designer"})
+  SchemaDesignerResponse addSchemaObject(
+      @PathParam("configSet") String configSet, @QueryParam("schemaVersion") Integer schemaVersion)
+      throws Exception;
+
+  @PUT
+  @Path("/{configSet}/update")
+  @Operation(
+      summary = "Update an existing field or field type in the schema being designed.",
+      tags = {"schema-designer"})
+  SchemaDesignerResponse updateSchemaObject(
+      @PathParam("configSet") String configSet, @QueryParam("schemaVersion") Integer schemaVersion)
+      throws Exception;
+
+  @PUT
+  @Path("/{configSet}/publish")
+  @Operation(
+      summary = "Publish the designed schema to a live configSet.",
+      tags = {"schema-designer"})
+  SchemaDesignerPublishResponse publish(
+      @PathParam("configSet") String configSet,
+      @QueryParam("schemaVersion") Integer schemaVersion,
+      @QueryParam("newCollection") String newCollection,
+      @QueryParam("reloadCollections") @DefaultValue("false") Boolean reloadCollections,
+      @QueryParam("numShards") @DefaultValue("1") Integer numShards,
+      @QueryParam("replicationFactor") @DefaultValue("1") Integer replicationFactor,
+      @QueryParam("indexToCollection") @DefaultValue("false") Boolean indexToCollection,
+      @QueryParam("cleanupTemp") @DefaultValue("true") Boolean cleanupTempParam,
+      @QueryParam("disableDesigner") @DefaultValue("false") Boolean disableDesigner)
+      throws Exception;
+
+  @POST
+  @Path("/{configSet}/analyze")
+  @Operation(
+      summary = "Analyze sample documents and suggest a schema.",
+      tags = {"schema-designer"})
+  SchemaDesignerResponse analyze(
+      @PathParam("configSet") String configSet,
+      @QueryParam("schemaVersion") Integer schemaVersion,
+      @QueryParam("copyFrom") String copyFrom,
+      @QueryParam("uniqueKeyField") String uniqueKeyField,
+      @QueryParam("languages") List<String> languages,
+      @QueryParam("enableDynamicFields") Boolean enableDynamicFields,
+      @QueryParam("enableFieldGuessing") Boolean enableFieldGuessing,
+      @QueryParam("enableNestedDocs") Boolean enableNestedDocs)
+      throws Exception;
+
+  @GET
+  @Path("/{configSet}/query")
+  @Operation(
+      summary = "Query the temporary collection used during schema design.",
+      tags = {"schema-designer"})
+  FlexibleSolrJerseyResponse query(@PathParam("configSet") String configSet) throws Exception;
+
+  @GET
+  @Path("/{configSet}/diff")
+  @Operation(
+      summary = "Get the diff between the designed schema and the published schema.",
+      tags = {"schema-designer"})
+  SchemaDesignerSchemaDiffResponse getSchemaDiff(@PathParam("configSet") String configSet)
+      throws Exception;
+}

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

@@ -0,0 +1,31 @@
+/*
+ * 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;
+
+/** Response type for the "get configset file contents" API. */
+public class ConfigSetFileContentsResponse extends SolrJerseyResponse {
+
+  /** The path of the file within the configset (as requested). */
+  @JsonProperty("path")
+  public String path;
+
+  /** The UTF-8 text content of the file. */
+  @JsonProperty("content")
+  public String content;
+}

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

@@ -0,0 +1,27 @@
+/*
+ * 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 java.util.List;
+
+/** Response body for the Schema Designer list-collections-for-config endpoint. */
+public class SchemaDesignerCollectionsResponse extends SolrJerseyResponse {
+
+  @JsonProperty("collections")
+  public List<String> collections;
+}

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

@@ -0,0 +1,31 @@
+/*
+ * 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 java.util.Map;
+
+/** Response body for the Schema Designer list-configs endpoint. */
+public class SchemaDesignerConfigsResponse extends SolrJerseyResponse {
+
+  /**
+   * Map of configSet name to status: 0 = in-progress (temp only), 1 = disabled, 2 = enabled and
+   * published.
+   */
+  @JsonProperty("configSets")
+  public Map<String, Integer> configSets;
+}