From 3b5340539dd25c2190593f7bceea37b351111824 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Thu, 28 May 2020 14:40:29 +0200 Subject: [PATCH] c2s: Make allOf and description siblings throughout the PR The overall mess with allOf will be addressed separately; this PR just puts $ref under allOf to fix the glaring misuse of $ref objects. --- api/client-server/administrative_contact.yaml | 6 +++--- api/client-server/login.yaml | 11 +++++------ api/client-server/registration.yaml | 8 ++++---- 3 files changed, 12 insertions(+), 13 deletions(-) diff --git a/api/client-server/administrative_contact.yaml b/api/client-server/administrative_contact.yaml index 72565b68..f8cdf5a0 100644 --- a/api/client-server/administrative_contact.yaml +++ b/api/client-server/administrative_contact.yaml @@ -201,10 +201,10 @@ paths: type: object properties: auth: + description: |- + Additional authentication information for the + user-interactive authentication API. allOf: - - description: |- - Additional authentication information for the - user-interactive authentication API. - $ref: "definitions/auth_data.yaml" client_secret: type: string diff --git a/api/client-server/login.yaml b/api/client-server/login.yaml index d37d135d..a959b312 100644 --- a/api/client-server/login.yaml +++ b/api/client-server/login.yaml @@ -175,13 +175,12 @@ paths: ID of the logged-in device. Will be the same as the corresponding parameter in the request, if one was specified. well_known: + description: |- + Optional client configuration provided by the server. If present, + clients SHOULD use the provided object to reconfigure themselves, + optionally validating the URLs within. This object takes the same + form as the one returned from .well-known autodiscovery. allOf: - - type: object - description: |- - Optional client configuration provided by the server. If present, - clients SHOULD use the provided object to reconfigure themselves, - optionally validating the URLs within. This object takes the same - form as the one returned from .well-known autodiscovery. - "$ref": "definitions/wellknown/full.yaml" 400: description: |- diff --git a/api/client-server/registration.yaml b/api/client-server/registration.yaml index cf1a2f23..c535bb99 100644 --- a/api/client-server/registration.yaml +++ b/api/client-server/registration.yaml @@ -89,13 +89,13 @@ paths: type: object properties: auth: - allOf: - - description: |- + description: |- Additional authentication information for the user-interactive authentication API. Note that this information is *not* used to define how the registered user should be authenticated, but is instead used to authenticate the ``register`` call itself. + allOf: - "$ref": "definitions/auth_data.yaml" username: type: string @@ -347,9 +347,9 @@ paths: description: The new password for the account. example: "ihatebananas" auth: - allOf: - - description: |- + description: |- Additional authentication information for the user-interactive authentication API. + allOf: - "$ref": "definitions/auth_data.yaml" required: ["new_password"] responses: