This is an automated email from the ASF dual-hosted git repository. danhaywood pushed a commit to branch CAUSEWAY-3866 in repository https://gitbox.apache.org/repos/asf/causeway.git
commit b6678969b06f6696213715f57188d3abfcee784f Author: Dan Haywood <[email protected]> AuthorDate: Wed Oct 15 22:54:40 2025 +0100 CAUSEWAY-3866: updating docs is all for v4 --- .../SwaggerService_020-examples-and-usage.adoc | 2 +- .../src/main/adoc/modules/config/pages/about.adoc | 14 ++++---- .../adoc/modules/starters/pages/simpleapp.adoc | 42 +++++++++------------- .../adoc/modules/integtestsupport/pages/about.adoc | 14 ++++---- .../integtestsupport/pages/swagger-exporter.adoc | 16 ++++----- 5 files changed, 39 insertions(+), 49 deletions(-) diff --git a/antora/components/refguide-index/modules/applib/pages/index/services/swagger/hooks/SwaggerService_020-examples-and-usage.adoc b/antora/components/refguide-index/modules/applib/pages/index/services/swagger/hooks/SwaggerService_020-examples-and-usage.adoc index 54ac34a00b8..79baca16bd9 100644 --- a/antora/components/refguide-index/modules/applib/pages/index/services/swagger/hooks/SwaggerService_020-examples-and-usage.adoc +++ b/antora/components/refguide-index/modules/applib/pages/index/services/swagger/hooks/SwaggerService_020-examples-and-usage.adoc @@ -28,7 +28,7 @@ An example of its use can be found in the xref:docs:referenceapp:about.adoc[refe .SwaggerExport_IntegTest.java ---- @Import({ - CausewayModuleViewerRestfulObjectsJaxrsResteasy4.class + CausewayModuleViewerRestfulObjectsViewer.class }) class SwaggerExport_IntegTest extends ApplicationIntegTestAbstract { diff --git a/core/config/src/main/adoc/modules/config/pages/about.adoc b/core/config/src/main/adoc/modules/config/pages/about.adoc index 53ac05af0f8..91d8b8a5eb2 100644 --- a/core/config/src/main/adoc/modules/config/pages/about.adoc +++ b/core/config/src/main/adoc/modules/config/pages/about.adoc @@ -130,13 +130,14 @@ It looks like this: ---- @Configuration @Import({ - CausewayModuleCoreRuntimeServices.class, // <.> - CausewayModuleSecurityShiro.class, // <.> - CausewayModuleJpaEclipselink.class, // <.> - CausewayModuleViewerRestfulObjectsJaxrsResteasy4.class, // <.> - CausewayModuleViewerWicketViewer.class, // <.> + CausewayModuleCoreRuntimeServices.class, // <.> + CausewayModuleSecurityShiro.class, // <.> + CausewayModuleJpaEclipselink.class, // <.> + CausewayModuleViewerRestfulObjectsViewer.class, // <.> + CausewayModuleViewerGraphqlViewer.class, // <.> + CausewayModuleViewerWicketViewer.class, // <.> ... - ApplicationModule.class, // <.> + ApplicationModule.class, // <.> ... }) public class AppManifest { @@ -151,6 +152,7 @@ There are several security implementations, precisely one must be selected Optional (though if omitted then only xref:userguide:ROOT:view-models.adoc[view models] may be used, with hand-rolled persistence). <.> Enables the xref:vro:ROOT:about.adoc[REST API (Restful Objects viewer)]. +<.> Enables the xref:gqlv:ROOT:about.adoc[GraphQL API (GraphQL viewer)]. <.> Enables the xref:vw:ROOT:about.adoc[Web UI (Wicket viewer)] <.> References the application's module(s), in this case just the one, `ApplicationModule`. + diff --git a/starters/adoc/modules/starters/pages/simpleapp.adoc b/starters/adoc/modules/starters/pages/simpleapp.adoc index b3743e98e5d..34969fa272b 100644 --- a/starters/adoc/modules/starters/pages/simpleapp.adoc +++ b/starters/adoc/modules/starters/pages/simpleapp.adoc @@ -699,57 +699,47 @@ It looks like this: ---- @Configuration @Import({ - CausewayModuleCoreRuntimeServices.class, // <.> - CausewayModuleSecurityShiro.class, // <.> - CausewayModuleJpaEclipseLink.class, // <.> - CausewayModuleViewerRestfulObjectsJaxrsResteasy4.class, // <.> - CausewayModuleViewerWicketViewer.class, // <.> + CausewayModuleCoreRuntimeServices.class, // <.> + CausewayModuleSecurityShiro.class, // <.> + CausewayModuleJpaEclipseLink.class, // <.> + CausewayModuleViewerRestfulObjectsViewer.class, // <.> + CausewayModuleViewerGraphqlViewer.class, // <.> + CausewayModuleViewerWicketViewer.class, // <.> - CausewayModuleTestingH2ConsoleUi.class, // <.> - CausewayModuleTestingFixturesApplib.class, // <.> + CausewayModuleTestingH2ConsoleUi.class, // <.> + CausewayModuleTestingFixturesApplib.class, // <.> - CausewayModuleExtFlywayImpl.class, // <.> + CausewayModuleExtFlywayImpl.class, // <.> - ApplicationModule.class, // <.> - CustomModule.class, // <9> - QuartzModule.class, // <9> + ApplicationModule.class, // <.> + CustomModule.class, // <9> + QuartzModule.class, // <9> - DomainAppDemo.class // <.> + DomainAppDemo.class // <.> }) @PropertySources({ - @PropertySource(CausewayPresets.DebugDiscovery), // <.> + @PropertySource(CausewayPresets.DebugDiscovery), // <.> }) public class AppManifest { } ---- <.> Mandatory - specifies the core of the Apache Causeway framework - <.> Enables the Shiro security mechanism. There are several security implementations, precisely one must be selected - <.> Enables JPA/Eclipselink for persistence. -+ -If using JDO as the ORM, replace with `CausewayModuleJdoDataNucleus5`. - <.> Enables the xref:vro:ROOT:about.adoc[REST API (Restful Objects viewer)] (ie REST API). - +<.> Enables the xref:gqlv:ROOT:about.adoc[GraphQL API (GraphQL viewer)]. <.> Enables the xref:vw:ROOT:about.adoc[Web UI (Wicket viewer)] - <.> Enables the H2 Console (menu from the "Prototyping" menu), applicable only if running against h2 in-memory database. - <.> Brings in support to run xref:testing:fixtures:about.adoc[fixtures] within the application, eg for prototyping. - <.> Enables the xref:userguide:flyway:about.adoc[Flyway] integration. - <.> References the application's module(s), in this case `ApplicationModule` , `CustomModule` and `QuartzModule`. + `ApplicationModule` is discussed below. <.> Makes the fixture scenario classes available for discovery. - -<.> Normally configuration properties are picked up from Spring Boot's `application.properties` or `application.yml` files, but additional properties can be overridden directly. -These two both use the `CausewayPresets` convenience class, to disable i18n support and for additional debugging log statements. +<.> Normally configuration properties are picked up from Spring Boot's `application.properties` or `application.yml` files, but additional properties can be overridden directly, for example using the `CausewayPresets` convenience class. ==== SimpleApp diff --git a/testing/integtestsupport/adoc/modules/integtestsupport/pages/about.adoc b/testing/integtestsupport/adoc/modules/integtestsupport/pages/about.adoc index 9583e25310c..7af8e8e069c 100644 --- a/testing/integtestsupport/adoc/modules/integtestsupport/pages/about.adoc +++ b/testing/integtestsupport/adoc/modules/integtestsupport/pages/about.adoc @@ -116,15 +116,15 @@ public abstract class SimpleModuleIntegTestAbstract extends CausewayIntegrationT @Import({ CausewayModuleCoreRuntimeServices.class, CausewayModuleSecurityBypass.class, - CausewayModuleJdoDataNucleus5.class, + CausewayModuleJpaEclipseLink.class, CausewayModuleTestingFixturesApplib.class, - SimpleModule.class //<1> + SimpleModule.class // <.> }) public static class AppManifest { } } ---- -<1> references just the `SimpleModule` +<.> references just the `SimpleModule` while in the `webapp` module we have: @@ -136,8 +136,6 @@ while in the `webapp` module we have: ) @TestPropertySource({ CausewayPresets.H2InMemory_withUniqueSchema, - CausewayPresets.DataNucleusAutoCreate, - CausewayPresets.UseLog4j2Test, }) @ContextConfiguration public abstract class ApplicationIntegTestAbstract extends CausewayIntegrationTestAbstract { @@ -145,16 +143,16 @@ public abstract class ApplicationIntegTestAbstract extends CausewayIntegrationTe @Configuration @Import({ CausewayModuleCoreRuntimeServices.class, - CausewayModuleJpaEclipseLink.class, CausewayModuleSecurityBypass.class, + CausewayModuleJpaEclipseLink.class, CausewayModuleTestingFixturesApplib.class, - ApplicationModule.class //<1> + ApplicationModule.class // <.> }) public static class AppManifest { } } ---- -<1> references the top-level `ApplicationModule` +<.> references the top-level `ApplicationModule` You can see that these are very similar, what's different is the module referenced. diff --git a/testing/integtestsupport/adoc/modules/integtestsupport/pages/swagger-exporter.adoc b/testing/integtestsupport/adoc/modules/integtestsupport/pages/swagger-exporter.adoc index fed88c85554..069d1e0d56d 100644 --- a/testing/integtestsupport/adoc/modules/integtestsupport/pages/swagger-exporter.adoc +++ b/testing/integtestsupport/adoc/modules/integtestsupport/pages/swagger-exporter.adoc @@ -15,8 +15,8 @@ The example below is taken from the xref:docs:starters:simpleapp.adoc[simpleapp] ---- @SpringBootTest( classes = { - ApplicationIntegTestAbstract.AppManifest.class, // <1> - CausewayModuleViewerRestfulObjectsJaxrsResteasy4.class // <2> + ApplicationIntegTestAbstract.AppManifest.class, // <.> + CausewayModuleViewerRestfulObjectsViewer.class // <.> } ) class SwaggerExport_IntegTest extends ApplicationIntegTestAbstract { @@ -25,17 +25,17 @@ class SwaggerExport_IntegTest extends ApplicationIntegTestAbstract { @Test void export() throws IOException { - val swaggerExporter = new SwaggerExporter(serviceRegistry); // <3> + val swaggerExporter = new SwaggerExporter(serviceRegistry); // <.> swaggerExporter.export( - SwaggerService.Visibility.PRIVATE, // <4> + SwaggerService.Visibility.PRIVATE, // <.> SwaggerService.Format.JSON); // <4> } } ---- -<1> bootstrap using the usual `AppManifest` for integration tests ... -<2> \... and _also_ include the xref:vro:ROOT:about.adoc[Restful Objects] viewer because this contains the implementation of xref:refguide:applib:index/services/swagger/SwaggerService.adoc[SwaggerService]. -<3> instantiate the `SwaggerExporter` utility class -<4> Export specifies the required visibility and format. +<.> bootstrap using the usual `AppManifest` for integration tests ... +<.> \... and _also_ include the xref:vro:ROOT:about.adoc[Restful Objects] viewer because this contains the implementation of xref:refguide:applib:index/services/swagger/SwaggerService.adoc[SwaggerService]. +<.> instantiate the `SwaggerExporter` utility class +<.> Export specifies the required visibility and format. By default the file will be written to `target/generated-resources/swagger-export`. Overloads of the `export(...)` method allow this to be changed as required.
