(causeway) branch CAUSEWAY-3676 updated: CAUSEWAY-3676: improves javadoc

[danhaywood]

This is an automated email from the ASF dual-hosted git repository.

danhaywood pushed a commit to branch CAUSEWAY-3676
in repository https://gitbox.apache.org/repos/asf/causeway.git


The following commit(s) were added to refs/heads/CAUSEWAY-3676 by this push:
     new 7f3d1f1e5a CAUSEWAY-3676: improves javadoc
7f3d1f1e5a is described below

commit 7f3d1f1e5a57544e91bf39a16641b69542ff1b44
Author: danhaywood <d...@haywood-associates.co.uk>
AuthorDate: Wed Feb 28 19:40:28 2024 +0000

    CAUSEWAY-3676: improves javadoc
---
 .../schema/PrintSchemaIntegTestAbstract.java           | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

diff --git 
a/viewers/graphql/testsupport/src/main/java/org/apache/causeway/viewer/graphql/viewer/testsupport/schema/PrintSchemaIntegTestAbstract.java
 
b/viewers/graphql/testsupport/src/main/java/org/apache/causeway/viewer/graphql/viewer/testsupport/schema/PrintSchemaIntegTestAbstract.java
index a52a7d6300..1df3802c55 100644
--- 
a/viewers/graphql/testsupport/src/main/java/org/apache/causeway/viewer/graphql/viewer/testsupport/schema/PrintSchemaIntegTestAbstract.java
+++ 
b/viewers/graphql/testsupport/src/main/java/org/apache/causeway/viewer/graphql/viewer/testsupport/schema/PrintSchemaIntegTestAbstract.java
@@ -44,6 +44,19 @@ import static 
org.apache.causeway.commons.internal.assertions._Assert.assertNotN
 
 import lombok.val;
 
+/**
+ * Utility to print out the schema, to <code>src/test/resources</code> of the 
implementing subclass.
+ *
+ * <p>
+ *      IDEs can then detect this and use it to provide 
intellisense/code-completion for GraphQL queries,
+ *      eg used by tests.
+ * </p>
+ *
+ * <p>
+ *     If the {@link 
org.apache.causeway.core.config.CausewayConfiguration.Viewer.Graphql.ApiVariant 
ApiVariant} is to
+ *     be overridden from the framework's default, use for example Spring's 
@{@link DynamicPropertySource} annotation.
+ * </p>
+ */
 @Transactional
 public class PrintSchemaIntegTestAbstract extends 
CausewayViewerGraphqlIntegTestAbstract {
 
@@ -55,11 +68,6 @@ public class PrintSchemaIntegTestAbstract extends 
CausewayViewerGraphqlIntegTest
         super(PrintSchemaIntegTestAbstract.class);
     }
 
-    @DynamicPropertySource
-    static void apiVariant(DynamicPropertyRegistry registry) {
-        registry.add("causeway.viewer.graphql.api-variant", 
CausewayConfiguration.Viewer.Graphql.ApiVariant.QUERY_WITH_MUTATIONS_NON_SPEC_COMPLIANT::name);
-    }
-
     @BeforeEach
     protected void beforeEach() {
         assertNotNull(causewaySystemEnvironment);