lfk/document-server
2
0
Fork 0
Code Issues 2 Pull Requests Actions Projects Releases 13 Wiki Activity

docs(swagger): Updated swagger metadata

Browse Source
This commit is contained in:
Nicolai Ort 2024-12-11 19:45:05 +01:00
parent 1dfd96869d
commit d19029b5ad
Signed by: niggl
GPG Key ID: 13AFA55AF62F269F
4 changed files with 30 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/docs.go
View File

@ -9,7 +9,15 @@ const docTemplate = `{
"info": { "info": {
"description": "{{escape .Description}}", "description": "{{escape .Description}}",
"title": "{{.Title}}", "title": "{{.Title}}",
"contact": {}, "termsOfService": "https://lauf-fuer-kaya.de/datenschutz",
"contact": {
"name": "ODIT.Services UG (haftungsbeschränkt)",
"url": "https://odit.services",
"email": "info@odit.services"
},
"license": {
"name": "CC BY-NC-SA 4.0"
},
"version": "{{.Version}}" "version": "{{.Version}}"
}, },
"host": "{{.Host}}", "host": "{{.Host}}",

10
docs/swagger.json
View File

@ -3,7 +3,15 @@
"info": { "info": {
"description": "This is the API documentation for the LfK Document Server - a tool for pdf generation.", "description": "This is the API documentation for the LfK Document Server - a tool for pdf generation.",
"title": "LfK Document Server API", "title": "LfK Document Server API",
"contact": {} "termsOfService": "https://lauf-fuer-kaya.de/datenschutz",
"contact": {
"name": "ODIT.Services UG (haftungsbeschränkt)",
"url": "https://odit.services",
"email": "info@odit.services"
},
"license": {
"name": "CC BY-NC-SA 4.0"
}
}, },
"paths": { "paths": {
"/cards": { "/cards": {

8
docs/swagger.yaml
View File

@ -152,9 +152,15 @@ definitions:
- last_name - last_name
type: object type: object
info: info:
contact: {} contact:
email: info@odit.services
name: ODIT.Services UG (haftungsbeschränkt)
url: https://odit.services
description: This is the API documentation for the LfK Document Server - a tool description: This is the API documentation for the LfK Document Server - a tool
for pdf generation. for pdf generation.
license:
name: CC BY-NC-SA 4.0
termsOfService: https://lauf-fuer-kaya.de/datenschutz
title: LfK Document Server API title: LfK Document Server API
paths: paths:
/cards: /cards:

5
main.go
View File

@ -57,6 +57,11 @@ func loadEnv() error {
// @title LfK Document Server API // @title LfK Document Server API
// @description This is the API documentation for the LfK Document Server - a tool for pdf generation. // @description This is the API documentation for the LfK Document Server - a tool for pdf generation.
// @license.name CC BY-NC-SA 4.0
// @termsOfService https://lauf-fuer-kaya.de/datenschutz
// @contact.name ODIT.Services UG (haftungsbeschränkt)
// @contact.url https://odit.services
// @contact.email info@odit.services
// @securityDefinitions.apiKey ApiKeyAuth // @securityDefinitions.apiKey ApiKeyAuth
// @in query // @in query
// @name key // @name key