mirrors/pomme
1
0
Fork 0
mirror of https://git.freecumextremist.com/grumbulon/pomme.git synced 2024-12-22 17:20:44 +00:00
Code Issues Releases Wiki Activity

small doc fixes

Browse source
This commit is contained in:
grumbulon 2023-01-20 16:55:59 -05:00
parent c59553184a
commit 4e11746c32
5 changed files with 20 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/docs.go
View file

@ -33,7 +33,7 @@ const docTemplate = `{
"parameters": [
{
"type": "string",
"description": "Account ID",
"description": "Username",
"name": "username",
"in": "query",
"required": true
@ -83,14 +83,14 @@ const docTemplate = `{
"parameters": [
{
"type": "string",
"description": "Zonefile",
"description": "Zonefile name",
"name": "filename",
"in": "query",
"required": true
},
{
"type": "string",
"description": "authToken",
"description": "Bearer Token",
"name": "Authorization",
"in": "header",
"required": true
@ -133,14 +133,14 @@ const docTemplate = `{
"parameters": [
{
"type": "file",
"description": "Zonefile",
"description": "Zonefile to upload",
"name": "file",
"in": "formData",
"required": true
},
{
"type": "string",
"description": "authToken",
"description": "Bearer Token",
"name": "Authorization",
"in": "header",
"required": true

10
docs/swagger.json
View file

@ -24,7 +24,7 @@
"parameters": [
{
"type": "string",
"description": "Account ID",
"description": "Username",
"name": "username",
"in": "query",
"required": true
@ -74,14 +74,14 @@
"parameters": [
{
"type": "string",
"description": "Zonefile",
"description": "Zonefile name",
"name": "filename",
"in": "query",
"required": true
},
{
"type": "string",
"description": "authToken",
"description": "Bearer Token",
"name": "Authorization",
"in": "header",
"required": true
@ -124,14 +124,14 @@
"parameters": [
{
"type": "file",
"description": "Zonefile",
"description": "Zonefile to upload",
"name": "file",
"in": "formData",
"required": true
},
{
"type": "string",
"description": "authToken",
"description": "Bearer Token",
"name": "Authorization",
"in": "header",
"required": true

10
docs/swagger.yaml
View file

@ -39,7 +39,7 @@ paths:
- application/json
description: login
parameters:
- description: Account ID
- description: Username
in: query
name: username
required: true
@ -70,12 +70,12 @@ paths:
description: parse your zonefile -- you must specify "Bearer" before entering
your token
parameters:
- description: Zonefile
- description: Zonefile name
in: query
name: filename
required: true
type: string
- description: authToken
- description: Bearer Token
in: header
name: Authorization
required: true
@ -103,12 +103,12 @@ paths:
description: upload a file -- you must specify "Bearer" before entering your
token
parameters:
- description: Zonefile
- description: Zonefile to upload
in: formData
name: file
required: true
type: file
- description: authToken
- description: Bearer Token
in: header
name: Authorization
required: true

2
internal/api/auth.go
View file

@ -36,7 +36,7 @@ type httpInternalServerError struct {
// @Tags accounts
// @Accept json
// @Produce json
// @Param username query string true "Account ID"
// @Param username query string true "Username"
// @Param password query string true "Password"
// @Success 200 {object} httpSuccess
// @Failure 401 {object} httpError

8
internal/api/zone.go
View file

@ -38,10 +38,10 @@ type Zone struct {
// @Tags DNS
// @Accept mpfd
// @Produce json
// @Param file formData file true "Zonefile"
// @Param file formData file true "Zonefile to upload"
// @Success 200 {object} httpSuccess
// @Failure 500 {object} httpInternalServerError
// @Param Authorization header string true "authToken"
// @Param Authorization header string true "Bearer Token"
//
// @Security Bearer
//
@ -102,10 +102,10 @@ func ReceiveFile(w http.ResponseWriter, r *http.Request) {
// @Tags DNS
// @Accept mpfd
// @Produce json
// @Param filename query string true "Zonefile"
// @Param filename query string true "Zonefile name"
// @Success 200 {object} httpSuccess
// @Failure 500 {object} httpInternalServerError
// @Param Authorization header string true "authToken"
// @Param Authorization header string true "Bearer Token"
//
// @Security Bearer
//