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

feat(docs): Annotated required params

Browse Source
This commit is contained in:
Nicolai Ort
2024-12-11 17:45:51 +01:00
parent f5debf58fc
commit e2cd445aeb
6 changed files with 163 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
docs/docs.go
View File

@@ -100,12 +100,18 @@ const docTemplate = `{
"definitions": {
"models.Card": {
"type": "object",
"required": [
"code",
"id",
"runner"
],
"properties": {
"code": {
"type": "string"
},
"enabled": {
"type": "boolean"
"type": "boolean",
"default": true
},
"id": {
"type": "integer"
@@ -117,6 +123,10 @@ const docTemplate = `{
},
"models.CardRequest": {
"type": "object",
"required": [
"cards",
"locale"
],
"properties": {
"cards": {
"type": "array",
@@ -135,6 +145,10 @@ const docTemplate = `{
},
"models.CertificateRequest": {
"type": "object",
"required": [
"locale",
"runners"
],
"properties": {
"locale": {
"type": "string",
@@ -153,6 +167,10 @@ const docTemplate = `{
},
"models.ContractRequest": {
"type": "object",
"required": [
"locale",
"runners"
],
"properties": {
"locale": {
"type": "string",
@@ -171,6 +189,11 @@ const docTemplate = `{
},
"models.DistanceDonation": {
"type": "object",
"required": [
"amount_per_distance",
"donor",
"id"
],
"properties": {
"amount": {
"type": "integer"
@@ -191,6 +214,11 @@ const docTemplate = `{
},
"models.Donor": {
"type": "object",
"required": [
"first_name",
"id",
"last_name"
],
"properties": {
"first_name": {
"type": "string"
@@ -208,6 +236,10 @@ const docTemplate = `{
},
"models.Group": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "integer"
@@ -222,6 +254,12 @@ const docTemplate = `{
},
"models.Runner": {
"type": "object",
"required": [
"first_name",
"group",
"id",
"last_name"
],
"properties": {
"first_name": {
"type": "string"
@@ -242,6 +280,13 @@ const docTemplate = `{
},
"models.RunnerWithDonations": {
"type": "object",
"required": [
"distance",
"first_name",
"group",
"id",
"last_name"
],
"properties": {
"distance": {
"type": "integer"