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

docs(swagger): Added barcode generation docs

Browse Source
This commit is contained in:
Nicolai Ort
2024-12-12 16:31:07 +01:00
parent 5587fdaaa8
commit 649ac2a3c2
3 changed files with 110 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/docs.go
View File

@@ -23,7 +23,41 @@ const docTemplate = `{
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
"/cards": {
"/v1/barcodes/{type}/{content}": {
"get": {
"description": "Generate barcodes based on the provided data",
"produces": [
"application/pdf"
],
"tags": [
"barcodes"
],
"summary": "Generate barcodes",
"parameters": [
{
"enum": [
"ean13",
"code128"
],
"type": "string",
"description": "Barcode type",
"name": "type",
"in": "path",
"required": true
},
{
"minLength": 1,
"type": "string",
"description": "Barcode content",
"name": "content",
"in": "path",
"required": true
}
],
"responses": {}
}
},
"/v1/pdfs/cards": {
"post": {
"description": "Generate cards based on the provided data",
"consumes": [
@@ -33,7 +67,7 @@ const docTemplate = `{
"application/pdf"
],
"tags": [
"cards"
"pdfs"
],
"summary": "Generate runner cards",
"parameters": [
@@ -50,7 +84,7 @@ const docTemplate = `{
"responses": {}
}
},
"/certificates": {
"/v1/pdfs/certificates": {
"post": {
"description": "Generate certificates based on the provided data",
"consumes": [
@@ -60,7 +94,7 @@ const docTemplate = `{
"application/pdf"
],
"tags": [
"certificates"
"pdfs"
],
"summary": "Generate runner certificates",
"parameters": [
@@ -77,7 +111,7 @@ const docTemplate = `{
"responses": {}
}
},
"/contracts": {
"/v1/pdfs/contracts": {
"post": {
"description": "Generate a contract based on the provided data",
"consumes": [
@@ -87,7 +121,7 @@ const docTemplate = `{
"application/pdf"
],
"tags": [
"contracts"
"pdfs"
],
"summary": "Generate a contract",
"parameters": [