update documantation and document new template parameters

BlackBeltTechnology · Jan 28, 2025 · b55188b · b55188b
1 parent 2cd820f
commit b55188b
Showing 1 changed file with 33 additions and 11 deletions.
diff --git a/README.adoc b/README.adoc
@@ -21,36 +21,52 @@ It can be used as:
         <revision>1.0.0-SNAPSHOT</revision>
         <maven>3.9.4</maven>
 
-        <judo-psm-archetype-version>1.0.0</judo-psm-archetype-version>
         <judo-psm-generator-jaxrs>1.0.0</judo-psm-generator-jaxrs>
         <judo-meta-psm-version>1.1.0</judo-meta-psm-version>
     </properties>
 
     <build>
         <plugins>
             <plugin>
-                <groupId>hu.blackbelt.judo.archetype</groupId>
-                <artifactId>judo-psm-archetype-maven-plugin</artifactId>
-                <version>${judo-psm-archetype-version}</version>
+                <groupId>hu.blackbelt.judo.meta</groupId>
+                <artifactId>judo-psm-generator-maven-plugin</artifactId>
+                <version>${judo-meta-psm-version}</version>
                 <executions>
                     <execution>
-                        <id>execute-psm-test-model-from-artifact</id>
-                        <phase>test</phase>
+                        <id>execute-psm-rest-generation</id>
+                        <phase>generate-sources</phase>
                         <goals>
                             <goal>generate</goal>
                         </goals>
                         <configuration>
                             <uris>
-                                <uri>${basedir}/src/main/resources</uri>
+                                <uri>mvn:hu.blackbelt.judo.generator:judo-psm-generator-jaxrs-common:${judo-psm-generator-jaxrs-version}</uri>
+                                <uri>mvn:hu.blackbelt.judo.generator:judo-psm-generator-jaxrs-api:${judo-psm-generator-jaxrs-version}</uri>
+                                <uri>mvn:hu.blackbelt.judo.generator:judo-psm-generator-jaxrs-impl:${judo-psm-generator-jaxrs-version}</uri>
+                                <uri>mvn:hu.blackbelt.judo.generator:judo-psm-generator-jaxrs-osgi:${judo-psm-generator-jaxrs-version}</uri>
                             </uris>
                             <helpers>
                                 <helper>hu.blackbelt.judo.psm.generator.jaxrs.PsmModelHelper</helper>
                             </helpers>
                             <type>psm-jaxrs</type>
+                            <contextAccessor>hu.blackbelt.judo.psm.generator.jaxrs.api.StoredVariableHelper</contextAccessor>
+                            <scanPackages>
+                                hu.blackbelt.judo.generator.commons,
+                                hu.blackbelt.judo.psm.generator.jaxrs
+                            </scanPackages>
+                            <templateParameters>
+                                <debugPrint>true</debugPrint>
+                                <apiPrefix>${project.groupId}.model-name.api</apiPrefix>
+                                <implPrefix>${project.groupId}.model-name.impl</implPrefix>
+                                <osgiPrefix>${project.groupId}.model-name.osgi</osgiPrefix>
+                                <generateOpenApiAnnotations>true</generateOpenApiAnnotations>
+                                <baseUrl>base-url-of-your-application</baseUrl>
+                                <authenticationUrl>authentication-url</authenticationUrl>
+                            </templateParameters>
                             <psm>
                                 mvn:your.psm.model.group.id:your.psm.model.artifact.id:your.psm.model.version!model-name-in-jar.model
                             </psm>
-                            <destination>${basedir}/target/generated-test-classes/psm/jaxrs</destination>
+                            <destination>${basedir}/target/generated-sources</destination>
                         </configuration>
                     </execution>
                 </executions>
@@ -68,11 +84,17 @@ It can be used as:
 </project>
 ----
 
-This example generates a complete project setup into `target/classes` directory.
+This example generates a complete project setup into `target/generated-sources` directory.
 In a project this generation can be placed in the model project as a
 profile.
 
-The `judo-psm-archetype-maven-plugin` documentation is placed inside
-the plugin documentation itself. https://github.com/BlackBeltTechnology/judo-psm-archetype
+The `generateOpenApiAnnotations` template parameter determines whether the annotations required for OpenAPI documentation generation should be generated or not.
+
+The `baseUrl` template parameter specifies the prefix of the URL of the application in the OpenAPI documentation. In the OpenAPI documentation, the URL is constructed as follows: `{baseUrl}/api/{model-name}/{actor-name}/{actor-name}`.
+
+The `authenticationUrl` template parameter defines the prefix of the openIdConnectUrl in the OpenAPI documentation. In the OpenAPI documentation, the openIdConnectUrl is structured as follows: `{authenticationUrl}/auth/realms/{realm-name}/.well-known/openid-configuration`.
+
+The `judo-psm-generator-maven-plugin` documentation is placed inside
+the plugin documentation itself. https://github.com/BlackBeltTechnology/judo-meta-psm