doc: swagger reusable schema definitions supported only for malli

metosin · Nov 28, 2024 · fc132f3 · fc132f3
1 parent 431242c
commit fc132f3
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/doc/ring/swagger.md b/doc/ring/swagger.md
@@ -286,7 +286,17 @@ Example with:
 ; ("/common/ping" "/one/ping" "/two/ping" "/two/deep/ping")
 ```
 
-### TODO
+## Reusable schema definitions
+
+Swagger supports having reusable schema definitions under the
+`"definitions"` key. These can be reused in different parts of
+swagger.json using the `"$ref": "#/definitions/Foo"` syntax.
+
+Reusable schema objects are generated for Malli `:ref`s and vars.
+Currently (as of 0.7.2), reusable schema objects are **not** generated
+for Plumatic Schema or Spec.
+
+## TOD
 
 * ClojureScript
   * example for [Macchiato](https://github.com/macchiato-framework)