luciano/reitit
1
0
Fork 0
mirror of https://github.com/metosin/reitit.git synced 2025-12-18 00:41:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

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

Browse source
This commit is contained in:
Joel Kaasinen 2024-12-02 07:47:36 +02:00
parent fc132f3a92
commit 059f93aee8
2 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
doc/ring/openapi.md
View file

@ -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 the `"$ref": "#/components/schemas/Foo"` json-schema syntax. This is
useful when you have multiple endpoints that use the same schema. It useful when you have multiple endpoints that use the same schema. It
can also make OpenAPI-based code nicer for consumers of your API. 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 Reusable schema objects are generated for Malli `:ref`s and vars. The
[openapi example](../../examples/openapi) showcases this. [openapi example](../../examples/openapi) showcases this.

5
doc/ring/swagger.md
View file

@ -290,13 +290,14 @@ Example with:
Swagger supports having reusable schema definitions under the Swagger supports having reusable schema definitions under the
`"definitions"` key. These can be reused in different parts of `"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. Reusable schema objects are generated for Malli `:ref`s and vars.
Currently (as of 0.7.2), reusable schema objects are **not** generated Currently (as of 0.7.2), reusable schema objects are **not** generated
for Plumatic Schema or Spec. for Plumatic Schema or Spec.
## TOD ## TODO
* ClojureScript * ClojureScript
* example for [Macchiato](https://github.com/macchiato-framework) * example for [Macchiato](https://github.com/macchiato-framework)