Mirrors/VILLASweb-backend-go
1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/web-backend-go/ synced 2025-03-30 00:00:12 +01:00
Code Issues Releases Wiki Activity

some API doc updates from today's meeting

Browse source
This commit is contained in:
Sonja Happ 2019-05-20 11:56:53 +02:00
parent ab0d8dea8b
commit e7b15f6e5d
2 changed files with 14 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/api/Makefile
View file

@ -9,7 +9,7 @@ RSYNC_OPTS ?= --recursive --ignore-missing-args --copy-links --chown $(DEPLOY_US
all: index.html all: index.html
index.html: api.yaml 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 deploy: index.html
rsync $(RSYNC_OPTS) index.html api.yaml $(DEPLOY_USER)@$(DEPLOY_HOST):$(DEPLOY_PATH) rsync $(RSYNC_OPTS) index.html api.yaml $(DEPLOY_USER)@$(DEPLOY_HOST):$(DEPLOY_PATH)

15
doc/api/api.yaml
View file

@ -49,7 +49,7 @@ paths:
schema: schema:
type: object type: object
properties: properties:
Success: success:
type: boolean type: boolean
message: message:
type: string type: string
@ -63,7 +63,18 @@ paths:
403: 403:
description: Access forbidden. description: Access forbidden.
404: 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: 500:
description: Internal server error. Unable to compare passwords. description: Internal server error. Unable to compare passwords.
/counts: /counts: