doc: fix typo, mention swagger ui handling of names schemas

metosin · Dec 2, 2024 · 059f93a · 059f93a
1 parent fc132f3
commit 059f93a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/doc/ring/openapi.md b/doc/ring/openapi.md
@@ -202,6 +202,7 @@ OpenAPI supports reusable schema objects that can be referred to with
 the `"$ref": "#/components/schemas/Foo"` json-schema syntax. This is
 useful when you have multiple endpoints that use the same schema. It
 can also make OpenAPI-based code nicer for consumers of your API.
+These schemas are also rendered in their own section in Swagger UI.
 
 Reusable schema objects are generated for Malli `:ref`s and vars. The
 [openapi example](../../examples/openapi) showcases this.

diff --git a/doc/ring/swagger.md b/doc/ring/swagger.md
@@ -290,13 +290,14 @@ Example with:
 
 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.
+swagger.json using the `"$ref": "#/definitions/Foo"` syntax. These
+definitions are also rendered in their own section in Swagger UI.
 
 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
+## TODO
 
 * ClojureScript
   * example for [Macchiato](https://github.com/macchiato-framework)