diff --git a/doc/api/Makefile b/doc/api/Makefile index 97118b8..8372465 100644 --- a/doc/api/Makefile +++ b/doc/api/Makefile @@ -9,7 +9,7 @@ RSYNC_OPTS ?= --recursive --ignore-missing-args --copy-links --chown $(DEPLOY_US all: index.html index.html: api.yaml - redoc-cli bundle --cdn --title "$(TITLE)" --output $@ api.yaml + redoc-cli bundle --cdn --title $(TITLE) --output $@ api.yaml deploy: index.html rsync $(RSYNC_OPTS) index.html api.yaml $(DEPLOY_USER)@$(DEPLOY_HOST):$(DEPLOY_PATH) diff --git a/doc/api/api.yaml b/doc/api/api.yaml index e0cd988..746b96f 100644 --- a/doc/api/api.yaml +++ b/doc/api/api.yaml @@ -49,7 +49,7 @@ paths: schema: type: object properties: - Success: + success: type: boolean message: type: string @@ -63,7 +63,18 @@ paths: 403: description: Access forbidden. 404: - description: Not found. User not found. + description: Not found. + content: + application/json: + schema: + type: object + properties: + success: + type: boolean + example: false + message: + type: string + example: error message 500: description: Internal server error. Unable to compare passwords. /counts: