me/gin-gonic-prepack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Swagger tweak, removing manually built postman build

Browse Source
This commit is contained in:
🐙PiperYxzzy
2022-05-29 19:32:00 +02:00
parent 403cc51e12
commit 10a28f4e89
5 changed files with 103 additions and 310 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
docs/docs.go
View File

@@ -18,7 +18,7 @@ const docTemplate = `{
"paths": {
"/adm/doot": {
"get": {
"summary": "Admin ming",
"summary": "Admin ping",
"parameters": [
{
"type": "string",
@@ -28,7 +28,11 @@ const docTemplate = `{
"required": true
}
],
"responses": {}
"responses": {
"200": {
"description": ""
}
}
}
},
"/admin": {
@@ -40,7 +44,7 @@ const docTemplate = `{
"produces": [
"application/json"
],
"summary": "User login",
"summary": "Admin login",
"parameters": [
{
"description": "email, password and 2FA code. 2FA code is required",
@@ -74,7 +78,11 @@ const docTemplate = `{
"/doot": {
"get": {
"summary": "Unauthenticated Ping",
"responses": {}
"responses": {
"200": {
"description": ""
}
}
}
},
"/forgot": {
@@ -182,6 +190,25 @@ const docTemplate = `{
}
}
},
"/sec/2fa-doot": {
"get": {
"summary": "2FA-Restricted Ping",
"parameters": [
{
"type": "string",
"description": "2FA authentication code",
"name": "twofactorcode",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": ""
}
}
}
},
"/sec/doot": {
"get": {
"summary": "User ping",
@@ -194,7 +221,11 @@ const docTemplate = `{
"required": true
}
],
"responses": {}
"responses": {
"200": {
"description": ""
}
}
}
},
"/signup": {

41
docs/swagger.json
View File

@@ -9,7 +9,7 @@
"paths": {
"/adm/doot": {
"get": {
"summary": "Admin ming",
"summary": "Admin ping",
"parameters": [
{
"type": "string",
@@ -19,7 +19,11 @@
"required": true
}
],
"responses": {}
"responses": {
"200": {
"description": ""
}
}
}
},
"/admin": {
@@ -31,7 +35,7 @@
"produces": [
"application/json"
],
"summary": "User login",
"summary": "Admin login",
"parameters": [
{
"description": "email, password and 2FA code. 2FA code is required",
@@ -65,7 +69,11 @@
"/doot": {
"get": {
"summary": "Unauthenticated Ping",
"responses": {}
"responses": {
"200": {
"description": ""
}
}
}
},
"/forgot": {
@@ -173,6 +181,25 @@
}
}
},
"/sec/2fa-doot": {
"get": {
"summary": "2FA-Restricted Ping",
"parameters": [
{
"type": "string",
"description": "2FA authentication code",
"name": "twofactorcode",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": ""
}
}
}
},
"/sec/doot": {
"get": {
"summary": "User ping",
@@ -185,7 +212,11 @@
"required": true
}
],
"responses": {}
"responses": {
"200": {
"description": ""
}
}
}
},
"/signup": {

28
docs/swagger.yaml
View File

@@ -52,8 +52,10 @@ paths:
name: jwt
required: true
type: string
responses: {}
summary: Admin ming
responses:
"200":
description: ""
summary: Admin ping
/admin:
post:
consumes:
@@ -79,10 +81,12 @@ paths:
description: userkey, 2fa token or password missing
"401":
description: not found or credentials invalid
summary: User login
summary: Admin login
/doot:
get:
responses: {}
responses:
"200":
description: ""
summary: Unauthenticated Ping
/forgot:
post:
@@ -152,6 +156,18 @@ paths:
"401":
description: bad token or user not found
summary: Password reset
/sec/2fa-doot:
get:
parameters:
- description: 2FA authentication code
in: query
name: twofactorcode
required: true
type: string
responses:
"200":
description: ""
summary: 2FA-Restricted Ping
/sec/doot:
get:
parameters:
@@ -160,7 +176,9 @@ paths:
name: jwt
required: true
type: string
responses: {}
responses:
"200":
description: ""
summary: User ping
/signup:
post: