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

API doc: started documentation using OPENAPI 3.0.1

Browse source
This commit is contained in:
Sonja Happ 2019-04-15 12:04:56 +02:00
parent 83cb2ea1db
commit 49c9dc26a7
2 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/api/Makefile
View file

@ -6,7 +6,7 @@ index.html: swagger-codegen-cli.jar api.yaml
java -jar swagger-codegen-cli.jar generate -i api.yaml -l html2 -o ./ java -jar swagger-codegen-cli.jar generate -i api.yaml -l html2 -o ./
swagger-codegen-cli.jar: swagger-codegen-cli.jar:
wget http://central.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.4/swagger-codegen-cli-2.4.4.jar -O swagger-codegen-cli.jar wget http://central.maven.org/maven2/io/swagger/swagger-codegen-cli/3.0.0-rc1/swagger-codegen-cli-3.0.0-rc1.jar -O swagger-codegen-cli.jar
clean: clean:
rm -rf index.html swagger-codegen-cli.jar rm -rf index.html swagger-codegen-cli.jar

5
doc/api/api.yaml
View file

@ -60,6 +60,7 @@ paths:
content: {} content: {}
500: 500:
description: Internal server error description: Internal server error
content: {}
components: components:
@ -140,9 +141,9 @@ components:
projects: projects:
type: array type: array
items: items:
$ref: '#/components/schemas/Project' type: object
user: user:
$ref: '#/components/schemas/User' type: object
startParameters: startParameters:
type: object type: object
properties: {} properties: {}