Fix bad query example for model.publish

- adds a DocTest
- test is no-result and invisible setup because alpha

Author: Mats-SX

doc/asciidoc/model-catalog/model-catalog-publish.adoc

@@ -1,4 +1,3 @@
-
 [.enterprise-edition]
 [[model-catalog-publish-ops]]
 = Publishing models
@@ -14,22 +13,32 @@ Making a model accessible to other users can be achieved by publishing it.
 [[catalog-model-publish]]
 == Publishing a model
 
+[role=query-example, no-result=true]
+--
 .Publishing trained model:
 [source,cypher]
 ----
 CALL gds.alpha.model.publish('my-model')
 YIELD
   modelInfo,
-  configuration,
+  trainConfig,
+  graphSchema,
+  stored,
+  loaded,
   creationTime,
   shared
 ----
+--
+
+The full set of fields returned from this procedure are:
 
-.Results
 * `modelInfo`: detailed information for the trained model
 ** `modelName: String`: the saved model name.
 ** `modelType: String`: the type of the model, i.e. `GraphSAGE`.
 ** can also contain algorithm specific model details.
-* `configuration`: the configuration used for training the model.
+* `trainConfig`: the configuration used for training the model.
+* `graphSchema`: the schema of the graph on which the model was trained.
+* `stored`: True, if the model is <<catalog-model-store,stored>> on disk.
+* `loaded`: True, if the model is <<catalog-model-load,loaded>> in the in-memory model catalog.
 * `creationTime`: the time at which the model was registered in the catalog.
 * `shared`: a boolean flag indicating if the model is published.

doc/src/test/java/org/neo4j/graphalgo/doc/ModelCatalogPublishDocTest.java

@@ -0,0 +1,81 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Neo4j is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.neo4j.graphalgo.doc;
+
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.io.TempDir;
+import org.neo4j.configuration.Config;
+import org.neo4j.gds.embeddings.graphsage.Layer;
+import org.neo4j.gds.embeddings.graphsage.ModelData;
+import org.neo4j.gds.embeddings.graphsage.SingleLabelFeatureFunction;
+import org.neo4j.gds.embeddings.graphsage.algo.GraphSage;
+import org.neo4j.gds.embeddings.graphsage.algo.ImmutableGraphSageTrainConfig;
+import org.neo4j.graphalgo.api.schema.GraphSchema;
+import org.neo4j.graphalgo.compat.GraphDatabaseApiProxy;
+import org.neo4j.graphalgo.core.GdsEdition;
+import org.neo4j.graphalgo.core.ModelStoreSettings;
+import org.neo4j.graphalgo.core.model.Model;
+import org.neo4j.graphalgo.core.model.ModelCatalog;
+import org.neo4j.graphalgo.model.catalog.ModelPublishProc;
+
+import java.nio.file.Path;
+import java.util.List;
+
+class ModelCatalogPublishDocTest extends DocTestBase {
+
+    @TempDir
+    Path modelStoreLocation;
+
+    @Override
+    @BeforeEach
+    void setUp() throws Exception {
+        super.setUp();
+        GraphDatabaseApiProxy
+            .resolveDependency(db, Config.class)
+            .set(ModelStoreSettings.model_store_location, modelStoreLocation);
+        GdsEdition.instance().setToEnterpriseEdition();
+        ModelCatalog.set(Model.of(
+            getUsername(),
+            "my-model",
+            GraphSage.MODEL_TYPE,
+            GraphSchema.empty(),
+            ModelData.of(new Layer[0], new SingleLabelFeatureFunction()),
+            ImmutableGraphSageTrainConfig.builder().modelName("my-model").degreeAsProperty(true).build(),
+            Model.Mappable.EMPTY
+        ));
+    }
+
+    @AfterEach
+    void tearDown() {
+        ModelCatalog.removeAllLoadedModels();
+        GdsEdition.instance().setToCommunityEdition();
+    }
+
+    @Override
+    List<Class<?>> procedures() {
+        return List.of(ModelPublishProc.class);
+    }
+
+    @Override
+    String adocFile() {
+        return "model-catalog/model-catalog-publish.adoc";
+    }
+}