Skip to content

Commit

Permalink
extend documentation of newly added features
Browse files Browse the repository at this point in the history
  • Loading branch information
Madmat8 committed Jan 28, 2025
1 parent b55188b commit 88d5627
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,9 @@ The `generateOpenApiAnnotations` template parameter determines whether the annot

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 `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.

If the `generateOpenApiAnnotations` parameter is set to false or not specified, the `baseUrl` and `authenticationUrl` parameters will not be considered.

The `judo-psm-generator-maven-plugin` documentation is placed inside
the plugin documentation itself. https://github.com/BlackBeltTechnology/judo-meta-psm
Expand Down

0 comments on commit 88d5627

Please sign in to comment.