GH-57: document use-fqn flag (#61)

springwolf · Oct 27, 2023 · 72f16f6 · 72f16f6
1 parent 3043511
commit 72f16f6
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/docs/configuration/configuration.md b/docs/configuration/configuration.md
@@ -65,6 +65,7 @@ The following table contains additional properties that can be specified in the
 | `springwolf.init-mode`                                   | `fail_fast`        | Springwolf initializes during start up with `fail_fast` or in the `background` after the application has started.         |
 | `springwolf.paths.docs`                                  | `/springwolf/docs` | The path of the AsyncAPI document in JSON format. *Note that at the moment the UI will work only with the default value.* |
 | `springwolf.endpoint.actuator.enabled`                   | `false`            | Publish the AsyncAPI document as part of Spring Boot’s actuator feature.                                                  |
+| `springwolf.use-fqn`                                     | `false`            | Use fully qualified names for the schema classes. It's recommended and required for publishing, but deactivated due to backwards compatibility |
 | `springwolf.scanner.consumer-data.enabled`               | `true`             | Enable scanner to find consumers defined in `AsyncApiDocket`.                                                             |
 | `springwolf.scanner.producer-data.enabled`               | `true`             | Enable scanner to find producers defined in `AsyncApiDocket`.                                                             |
 | `springwolf.scanner.async-listener.enabled`              | `true`             | Enable scanner to find methods annotated with `@AsyncListener`.                                                           |