Factor out common definition of Tag
type (#1793)
... and remove spurious `additionalProperties: true`
This commit is contained in:
parent
e82829d4a2
commit
2b5f990f60
4 changed files with 28 additions and 32 deletions
1
changelogs/internal/newsfragments/1793.misc
Normal file
1
changelogs/internal/newsfragments/1793.misc
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Factor out common definition of `Tag` type.
|
24
data/api/client-server/definitions/tag.yaml
Normal file
24
data/api/client-server/definitions/tag.yaml
Normal file
|
@ -0,0 +1,24 @@
|
||||||
|
# Copyright 2020-2024 The Matrix.org Foundation C.I.C.
|
||||||
|
#
|
||||||
|
# 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.
|
||||||
|
|
||||||
|
title: Tag
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
order:
|
||||||
|
type: number
|
||||||
|
format: float
|
||||||
|
description: |-
|
||||||
|
A number in a range `[0,1]` describing a relative
|
||||||
|
position of the room under the given tag.
|
||||||
|
example: 0.25
|
|
@ -53,16 +53,7 @@ paths:
|
||||||
tags:
|
tags:
|
||||||
type: object
|
type: object
|
||||||
additionalProperties:
|
additionalProperties:
|
||||||
title: Tag
|
$ref: definitions/tag.yaml
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
order:
|
|
||||||
type: number
|
|
||||||
format: float
|
|
||||||
description: |-
|
|
||||||
A number in a range `[0,1]` describing a relative
|
|
||||||
position of the room under the given tag.
|
|
||||||
additionalProperties: true
|
|
||||||
examples:
|
examples:
|
||||||
response:
|
response:
|
||||||
value: {
|
value: {
|
||||||
|
@ -114,18 +105,7 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
$ref: definitions/tag.yaml
|
||||||
properties:
|
|
||||||
order:
|
|
||||||
type: number
|
|
||||||
format: float
|
|
||||||
description: |-
|
|
||||||
A number in a range `[0,1]` describing a relative
|
|
||||||
position of the room under the given tag.
|
|
||||||
additionalProperties: true
|
|
||||||
example: {
|
|
||||||
"order": 0.25
|
|
||||||
}
|
|
||||||
description: Extra data for the tag, e.g. ordering.
|
description: Extra data for the tag, e.g. ordering.
|
||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
|
|
|
@ -17,16 +17,7 @@
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"description": "The tags on the room and their contents.",
|
"description": "The tags on the room and their contents.",
|
||||||
"additionalProperties": {
|
"additionalProperties": {
|
||||||
"title": "Tag",
|
"$ref": "../../api/client-server/definitions/tag.yaml"
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"order": {
|
|
||||||
"type": "number",
|
|
||||||
"format": "float",
|
|
||||||
"description":
|
|
||||||
"A number in a range `[0,1]` describing a relative position of the room under the given tag."
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue