From e1a62442d9d9c93a284d705fa2c874b41ce0c74e Mon Sep 17 00:00:00 2001 From: Mal <=> Date: Sat, 22 Aug 2020 21:10:49 +0200 Subject: [PATCH] API docs ready for swagger-ui --- .gitignore | 1 + api/{v1 => }/openapi.yaml | 8 ++++---- 2 files changed, 5 insertions(+), 4 deletions(-) rename api/{v1 => }/openapi.yaml (99%) diff --git a/.gitignore b/.gitignore index 2cbd1f5..c4e618d 100644 --- a/.gitignore +++ b/.gitignore @@ -2,4 +2,5 @@ backend/classes/Setting.php backend/cache backend/tmp backend/qr +api/docs .idea diff --git a/api/v1/openapi.yaml b/api/openapi.yaml similarity index 99% rename from api/v1/openapi.yaml rename to api/openapi.yaml index d24ef3c..d2bfdaf 100644 --- a/api/v1/openapi.yaml +++ b/api/openapi.yaml @@ -5,10 +5,6 @@ info: version: 1.0.0 description: The restfull API of the jabber fingerprint keyring. -servers: - - url: https://sabolli.de/ringfinger - description: Test server - tags: - name: User description: A user that can login, store fingerprints and share them with other users. @@ -353,6 +349,10 @@ paths: example: 42 userSharedId: $ref: '#/components/schemas/SharingUserId' + allOf: + - required: + - userId + - userSharedId responses: 200: