API docs ready for swagger-ui

This commit is contained in:
Mal 2020-08-22 21:10:49 +02:00
parent 44aaff929c
commit e1a62442d9
2 changed files with 5 additions and 4 deletions

1
.gitignore vendored
View File

@ -2,4 +2,5 @@ backend/classes/Setting.php
backend/cache
backend/tmp
backend/qr
api/docs
.idea

View File

@ -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: