Add support for pattern formats for patternProperties
(#1796)
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
parent
26ce3929b4
commit
2edfb21d5d
6 changed files with 80 additions and 8 deletions
33
data/custom-formats.yaml
Normal file
33
data/custom-formats.yaml
Normal file
|
@ -0,0 +1,33 @@
|
|||
# Copyright 2024 Commaille Kévin
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
# This file contains the list of custom formats supported for the `format` key
|
||||
# and the `x-pattern-format` extension (see `openapi_extensions.md` for more
|
||||
# details).
|
||||
#
|
||||
# Each entry must use the `mx-` prefix and have the form:
|
||||
#
|
||||
# mx-custom-key:
|
||||
# title: The title rendered in the specification
|
||||
# url: /url/to#definition
|
||||
|
||||
mx-user-id:
|
||||
title: User ID
|
||||
url: /appendices#user-identifiers
|
||||
# regex: "^@"
|
||||
|
||||
mx-event-id:
|
||||
title: Event ID
|
||||
url: /appendices#event-ids
|
||||
# regex: "^\\$"
|
|
@ -17,7 +17,7 @@ properties:
|
|||
"^@":
|
||||
type: "object"
|
||||
description: "An empty object for future enhancement"
|
||||
x-pattern: "$USER_ID"
|
||||
x-pattern-format: "mx-user-id"
|
||||
required:
|
||||
- ignored_users
|
||||
type:
|
||||
|
|
|
@ -16,7 +16,7 @@ properties:
|
|||
patternProperties:
|
||||
"^\\$":
|
||||
type: object
|
||||
x-pattern: "$EVENT_ID"
|
||||
x-pattern-format: "mx-event-id"
|
||||
title: Event Receipts
|
||||
description: |-
|
||||
The collection of receipts for this event ID.
|
||||
|
@ -34,7 +34,7 @@ properties:
|
|||
description: |-
|
||||
The mapping of user ID to receipt. The user ID is the
|
||||
entity who sent this receipt.
|
||||
x-pattern: "$USER_ID"
|
||||
x-pattern-format: "mx-user-id"
|
||||
properties:
|
||||
ts:
|
||||
type: integer
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue