Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-23 03:34:08 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Improve OpenAPI Extensions docs

Browse source 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
Kévin Commaille 2024-04-23 19:30:19 +02:00
parent d099f534d7
commit c0083de076
No known key found for this signature in database
GPG key ID: 29A48C1F03620416
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
openapi_extensions.md
View file

@ -34,9 +34,10 @@ whole example, we use it to compose examples from other examples.
## Custom `x-pattern-format` key and custom formats
In JSON Schema, `format` is a property to convey semantic information about a
schema. We define `x-pattern-format` as a key on the schemas under
`patternProperties` with the same use as `format`, but that applies to the
pattern of the property. We also define custom values for formats with the `mx-`
prefix in `data/custom-formats.yaml`. Those values are recognized in the
rendered specification and link to the definition of the format.
In JSON Schema, [`format`](https://json-schema.org/understanding-json-schema/reference/string#format)
is a property to convey semantic information about a schema. We define
`x-pattern-format` as a key on the schemas under `patternProperties` with the
same use as `format`, but that applies to the pattern of the property. We also
define custom values for formats with the `mx-` prefix in
`data/custom-formats.yaml`. Those values are recognized in the rendered
specification and link to the definition of the format.