dragonfly/api/v2/manager/docs/docs.go

414 lines
12 KiB
Go

// GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
// This file was generated by swaggo/swag
package docs
import (
"bytes"
"encoding/json"
"strings"
"github.com/alecthomas/template"
"github.com/swaggo/swag"
)
var doc = `{
"schemes": {{ marshal .Schemes }},
"swagger": "2.0",
"info": {
"description": "{{.Description}}",
"title": "{{.Title}}",
"termsOfService": "http://swagger.io/terms/",
"contact": {
"name": "API Support",
"url": "http://www.swagger.io/support",
"email": "support@swagger.io"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "{{.Version}}"
},
"host": "{{.Host}}",
"basePath": "{{.BasePath}}",
"paths": {
"/configs": {
"get": {
"description": "get configs",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"configs"
],
"summary": "List configs",
"parameters": [
{
"type": "string",
"description": "configs search by object",
"name": "object",
"in": "query",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/types.ListConfigsResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/handler.HTTPError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/handler.HTTPError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/handler.HTTPError"
}
}
}
},
"post": {
"description": "add by json config",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"configs"
],
"summary": "Add a config",
"parameters": [
{
"description": "Add config",
"name": "config",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/types.Config"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/types.AddConfigResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/handler.HTTPError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/handler.HTTPError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/handler.HTTPError"
}
}
}
}
},
"/configs/{id}": {
"get": {
"description": "get a config by Config ID",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"configs"
],
"summary": "Get a config",
"parameters": [
{
"type": "string",
"description": "Config ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/types.GetConfigResponse"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/handler.HTTPError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/handler.HTTPError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/handler.HTTPError"
}
}
}
},
"post": {
"description": "Update by json config",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"configs"
],
"summary": "Update a config",
"parameters": [
{
"type": "string",
"description": "Config ID",
"name": "id",
"in": "path",
"required": true
},
{
"description": "Update Config",
"name": "Config",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/types.Config"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/handler.HTTPError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/handler.HTTPError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/handler.HTTPError"
}
}
}
},
"delete": {
"description": "Delete by config ID",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"configs"
],
"summary": "Delete a config",
"parameters": [
{
"type": "string",
"description": "Config ID",
"name": "id",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/handler.HTTPError"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/handler.HTTPError"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/handler.HTTPError"
}
}
}
}
}
},
"definitions": {
"handler.HTTPError": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"example": 400
},
"message": {
"type": "string",
"example": "status bad request"
}
}
},
"types.AddConfigResponse": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
},
"types.Config": {
"type": "object",
"required": [
"data",
"object",
"type",
"version"
],
"properties": {
"create_at": {
"type": "string"
},
"data": {
"type": "string"
},
"id": {
"type": "string"
},
"object": {
"type": "string"
},
"type": {
"type": "string"
},
"update_at": {
"type": "string"
},
"version": {
"type": "integer"
}
}
},
"types.GetConfigResponse": {
"type": "object",
"properties": {
"config": {
"$ref": "#/definitions/types.Config"
}
}
},
"types.ListConfigsResponse": {
"type": "object",
"properties": {
"configs": {
"type": "array",
"items": {
"$ref": "#/definitions/types.Config"
}
}
}
}
}
}`
type swaggerInfo struct {
Version string
Host string
BasePath string
Schemes []string
Title string
Description string
}
// SwaggerInfo holds exported Swagger Info so clients can modify it
var SwaggerInfo = swaggerInfo{
Version: "1.0",
Host: "localhost:8080",
BasePath: "/api/v2",
Schemes: []string{},
Title: "Swagger Example API",
Description: "This is a sample server Petstore server.",
}
type s struct{}
func (s *s) ReadDoc() string {
sInfo := SwaggerInfo
sInfo.Description = strings.Replace(sInfo.Description, "\n", "\\n", -1)
t, err := template.New("swagger_info").Funcs(template.FuncMap{
"marshal": func(v interface{}) string {
a, _ := json.Marshal(v)
return string(a)
},
}).Parse(doc)
if err != nil {
return doc
}
var tpl bytes.Buffer
if err := t.Execute(&tpl, sInfo); err != nil {
return doc
}
return tpl.String()
}
func init() {
swag.Register(swag.Name, &s{})
}