From 6202b65c05b185429af4977f0b62a61d091797da Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Sat, 17 Feb 2024 22:28:49 +0100 Subject: [PATCH] Use maxProperties: 0 to indicate object emptiness OpenAPI 3 ftw. --- data/api/client-server/account-data.yaml | 2 ++ data/api/client-server/administrative_contact.yaml | 2 ++ data/api/client-server/appservice_room_directory.yaml | 1 + data/api/client-server/banning.yaml | 2 ++ data/api/client-server/content-repo.yaml | 1 + data/api/client-server/cross_signing.yaml | 1 + data/api/client-server/device_management.yaml | 5 ++++- data/api/client-server/directory.yaml | 2 ++ data/api/client-server/inviting.yaml | 1 + data/api/client-server/key_backup.yaml | 3 ++- data/api/client-server/kicking.yaml | 1 + data/api/client-server/leaving.yaml | 2 ++ data/api/client-server/list_public_rooms.yaml | 1 + data/api/client-server/logout.yaml | 4 ++-- data/api/client-server/presence.yaml | 3 ++- data/api/client-server/profile.yaml | 6 ++++-- data/api/client-server/pusher.yaml | 1 + data/api/client-server/pushrules.yaml | 8 ++++++-- data/api/client-server/read_markers.yaml | 2 +- data/api/client-server/registration.yaml | 1 + data/api/client-server/report_content.yaml | 1 + data/api/client-server/tags.yaml | 2 ++ data/api/client-server/third_party_membership.yaml | 1 + data/api/client-server/to_device.yaml | 1 + data/api/client-server/typing.yaml | 3 ++- 25 files changed, 46 insertions(+), 11 deletions(-) diff --git a/data/api/client-server/account-data.yaml b/data/api/client-server/account-data.yaml index 8fda4c39b..cacc1f9d0 100644 --- a/data/api/client-server/account-data.yaml +++ b/data/api/client-server/account-data.yaml @@ -64,6 +64,7 @@ paths: application/json: schema: type: object + maxProperties: 0 examples: response: value: {} @@ -233,6 +234,7 @@ paths: application/json: schema: type: object + maxProperties: 0 examples: response: value: {} diff --git a/data/api/client-server/administrative_contact.yaml b/data/api/client-server/administrative_contact.yaml index a1f7be9d3..5fbc1be95 100644 --- a/data/api/client-server/administrative_contact.yaml +++ b/data/api/client-server/administrative_contact.yaml @@ -236,6 +236,7 @@ paths: application/json: schema: type: object + maxProperties: 0 examples: response: value: {} @@ -305,6 +306,7 @@ paths: application/json: schema: type: object + maxProperties: 0 examples: response: value: {} diff --git a/data/api/client-server/appservice_room_directory.yaml b/data/api/client-server/appservice_room_directory.yaml index b4ec42f06..6dc52174f 100644 --- a/data/api/client-server/appservice_room_directory.yaml +++ b/data/api/client-server/appservice_room_directory.yaml @@ -76,6 +76,7 @@ paths: application/json: schema: type: object + maxProperties: 0 examples: response: value: {} diff --git a/data/api/client-server/banning.yaml b/data/api/client-server/banning.yaml index 3cb9a5403..b624ab33d 100644 --- a/data/api/client-server/banning.yaml +++ b/data/api/client-server/banning.yaml @@ -66,6 +66,7 @@ paths: application/json: schema: type: object + maxProperties: 0 examples: response: value: {} @@ -137,6 +138,7 @@ paths: application/json: schema: type: object + maxProperties: 0 examples: response: value: {} diff --git a/data/api/client-server/content-repo.yaml b/data/api/client-server/content-repo.yaml index f50850bd5..24b6a1072 100644 --- a/data/api/client-server/content-repo.yaml +++ b/data/api/client-server/content-repo.yaml @@ -102,6 +102,7 @@ paths: application/json: schema: type: object + maxProperties: 0 examples: response: value: {} diff --git a/data/api/client-server/cross_signing.yaml b/data/api/client-server/cross_signing.yaml index 8f499d23b..61146bb74 100644 --- a/data/api/client-server/cross_signing.yaml +++ b/data/api/client-server/cross_signing.yaml @@ -128,6 +128,7 @@ paths: application/json: schema: type: object + maxProperties: 0 example: {} "400": description: |- diff --git a/data/api/client-server/device_management.yaml b/data/api/client-server/device_management.yaml index b2bcb8ce5..f77a243a6 100644 --- a/data/api/client-server/device_management.yaml +++ b/data/api/client-server/device_management.yaml @@ -123,7 +123,8 @@ paths: content: application/json: schema: - type: object # empty json object + type: object + maxProperties: 0 # empty json object examples: response: value: {} @@ -171,6 +172,7 @@ paths: application/json: schema: type: object + maxProperties: 0 examples: response: value: {} @@ -226,6 +228,7 @@ paths: application/json: schema: type: object + maxProperties: 0 examples: response: value: {} diff --git a/data/api/client-server/directory.yaml b/data/api/client-server/directory.yaml index f5c357d92..e74e02484 100644 --- a/data/api/client-server/directory.yaml +++ b/data/api/client-server/directory.yaml @@ -56,6 +56,7 @@ paths: application/json: schema: type: object + maxProperties: 0 examples: response: value: {} @@ -192,6 +193,7 @@ paths: application/json: schema: type: object + maxProperties: 0 examples: response: value: {} diff --git a/data/api/client-server/inviting.yaml b/data/api/client-server/inviting.yaml index 6aa9e08a5..1130c1bef 100644 --- a/data/api/client-server/inviting.yaml +++ b/data/api/client-server/inviting.yaml @@ -78,6 +78,7 @@ paths: application/json: schema: type: object + maxProperties: 0 examples: response: value: {} diff --git a/data/api/client-server/key_backup.yaml b/data/api/client-server/key_backup.yaml index 64833f6e9..b665432f1 100644 --- a/data/api/client-server/key_backup.yaml +++ b/data/api/client-server/key_backup.yaml @@ -302,6 +302,7 @@ paths: application/json: schema: type: object + maxProperties: 0 examples: response: value: {} @@ -371,7 +372,7 @@ paths: application/json: schema: type: object - properties: {} + maxProperties: 0 "404": description: |- The backup specified does not exist. If the backup was previously diff --git a/data/api/client-server/kicking.yaml b/data/api/client-server/kicking.yaml index eb5b02d29..b2b55c1a0 100644 --- a/data/api/client-server/kicking.yaml +++ b/data/api/client-server/kicking.yaml @@ -67,6 +67,7 @@ paths: application/json: schema: type: object + maxProperties: 0 examples: response: value: {} diff --git a/data/api/client-server/leaving.yaml b/data/api/client-server/leaving.yaml index 6bdadb088..58c6c4c1e 100644 --- a/data/api/client-server/leaving.yaml +++ b/data/api/client-server/leaving.yaml @@ -66,6 +66,7 @@ paths: application/json: schema: type: object + maxProperties: 0 examples: response: value: {} @@ -109,6 +110,7 @@ paths: application/json: schema: type: object + maxProperties: 0 examples: response: value: {} diff --git a/data/api/client-server/list_public_rooms.yaml b/data/api/client-server/list_public_rooms.yaml index 497ccb443..8934f7dfa 100644 --- a/data/api/client-server/list_public_rooms.yaml +++ b/data/api/client-server/list_public_rooms.yaml @@ -110,6 +110,7 @@ paths: application/json: schema: type: object + maxProperties: 0 examples: response: value: {} diff --git a/data/api/client-server/logout.yaml b/data/api/client-server/logout.yaml index 60464932b..8a8e152f9 100644 --- a/data/api/client-server/logout.yaml +++ b/data/api/client-server/logout.yaml @@ -34,7 +34,7 @@ paths: application/json: schema: type: object - properties: {} + maxProperties: 0 tags: - Session management /logout/all: @@ -63,7 +63,7 @@ paths: application/json: schema: type: object - properties: {} + maxProperties: 0 tags: - Session management servers: diff --git a/data/api/client-server/presence.yaml b/data/api/client-server/presence.yaml index d31419115..c33033bc8 100644 --- a/data/api/client-server/presence.yaml +++ b/data/api/client-server/presence.yaml @@ -66,7 +66,8 @@ paths: content: application/json: schema: - type: object # empty json object + type: object + maxProperties: 0 # empty json object examples: response: value: {} diff --git a/data/api/client-server/profile.yaml b/data/api/client-server/profile.yaml index d4653b761..434aac2a7 100644 --- a/data/api/client-server/profile.yaml +++ b/data/api/client-server/profile.yaml @@ -55,7 +55,8 @@ paths: content: application/json: schema: - type: object # empty json object + type: object + maxProperties: 0 # empty json object examples: response: value: {} @@ -143,7 +144,8 @@ paths: content: application/json: schema: - type: object # empty json object + type: object + maxProperties: 0 # empty json object examples: response: value: {} diff --git a/data/api/client-server/pusher.yaml b/data/api/client-server/pusher.yaml index b8997308a..854217785 100644 --- a/data/api/client-server/pusher.yaml +++ b/data/api/client-server/pusher.yaml @@ -252,6 +252,7 @@ paths: application/json: schema: type: object + maxProperties: 0 description: An empty object. examples: response: diff --git a/data/api/client-server/pushrules.yaml b/data/api/client-server/pushrules.yaml index fd56f46ed..c95fd8913 100644 --- a/data/api/client-server/pushrules.yaml +++ b/data/api/client-server/pushrules.yaml @@ -164,7 +164,8 @@ paths: content: application/json: schema: - type: object # empty json object + type: object + maxProperties: 0 # empty json object examples: response: value: {} @@ -291,7 +292,8 @@ paths: content: application/json: schema: - type: object # empty json object + type: object + maxProperties: 0 # empty json object examples: response: value: {} @@ -445,6 +447,7 @@ paths: application/json: schema: type: object + maxProperties: 0 # empty json object examples: response: value: {} @@ -596,6 +599,7 @@ paths: application/json: schema: type: object + maxProperties: 0 # empty json object examples: response: value: {} diff --git a/data/api/client-server/read_markers.yaml b/data/api/client-server/read_markers.yaml index ba2f4f0ba..4c1af23a0 100644 --- a/data/api/client-server/read_markers.yaml +++ b/data/api/client-server/read_markers.yaml @@ -74,7 +74,7 @@ paths: application/json: schema: type: object - properties: {} + maxProperties: 0 # empty json object "429": description: This request was rate-limited. content: diff --git a/data/api/client-server/registration.yaml b/data/api/client-server/registration.yaml index 2e9290bad..149d97269 100644 --- a/data/api/client-server/registration.yaml +++ b/data/api/client-server/registration.yaml @@ -426,6 +426,7 @@ paths: application/json: schema: type: object + maxProperties: 0 # empty json object examples: response: value: {} diff --git a/data/api/client-server/report_content.yaml b/data/api/client-server/report_content.yaml index f30e189d9..a7127ff08 100644 --- a/data/api/client-server/report_content.yaml +++ b/data/api/client-server/report_content.yaml @@ -77,6 +77,7 @@ paths: application/json: schema: type: object + maxProperties: 0 # empty json object examples: response: value: {} diff --git a/data/api/client-server/tags.yaml b/data/api/client-server/tags.yaml index c8e1d78c4..a93249c87 100644 --- a/data/api/client-server/tags.yaml +++ b/data/api/client-server/tags.yaml @@ -115,6 +115,7 @@ paths: application/json: schema: type: object + maxProperties: 0 # empty json object examples: response: value: {} @@ -158,6 +159,7 @@ paths: application/json: schema: type: object + maxProperties: 0 # empty json object examples: response: value: {} diff --git a/data/api/client-server/third_party_membership.yaml b/data/api/client-server/third_party_membership.yaml index ea366648c..30cc19fd7 100644 --- a/data/api/client-server/third_party_membership.yaml +++ b/data/api/client-server/third_party_membership.yaml @@ -115,6 +115,7 @@ paths: application/json: schema: type: object + maxProperties: 0 # empty json object examples: response: value: {} diff --git a/data/api/client-server/to_device.yaml b/data/api/client-server/to_device.yaml index cea23ab71..1ef64ec97 100644 --- a/data/api/client-server/to_device.yaml +++ b/data/api/client-server/to_device.yaml @@ -79,6 +79,7 @@ paths: application/json: schema: type: object + maxProperties: 0 # empty json object examples: response: value: {} diff --git a/data/api/client-server/typing.yaml b/data/api/client-server/typing.yaml index 0d21f4524..914127453 100644 --- a/data/api/client-server/typing.yaml +++ b/data/api/client-server/typing.yaml @@ -71,7 +71,8 @@ paths: content: application/json: schema: - type: object # empty json object + type: object + maxProperties: 0 # empty json object examples: response: value: {}