// Package api Code generated by swaggo/swag. DO NOT EDIT package api import "github.com/swaggo/swag" const docTemplateapi = `{ "schemes": {{ marshal .Schemes }}, "swagger": "2.0", "info": { "description": "{{escape .Description}}", "title": "{{.Title}}", "contact": {}, "version": "{{.Version}}" }, "host": "{{.Host}}", "basePath": "{{.BasePath}}", "paths": { "/": { "get": { "description": "首页", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "首页" ], "summary": "首页", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/ab": { "get": { "security": [ { "BearerAuth": [] } ], "description": "地址列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "地址" ], "summary": "地址列表", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.ErrorResponse" } } } }, "post": { "security": [ { "BearerAuth": [] } ], "description": "地址更新", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "地址" ], "summary": "地址更新", "parameters": [ { "description": "地址表单", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.AddressBookForm" } } ], "responses": { "200": { "description": "null", "schema": { "type": "string" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.ErrorResponse" } } } } }, "/ab/peer/add/{guid}": { "post": { "security": [ { "BearerAuth": [] } ], "description": "添加地址", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "地址[Personal]" ], "summary": "添加地址", "parameters": [ { "type": "string", "description": "guid", "name": "guid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.ErrorResponse" } } } }, "delete": { "security": [ { "BearerAuth": [] } ], "description": "删除地址", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "地址[Personal]" ], "summary": "删除地址", "parameters": [ { "type": "string", "description": "guid", "name": "guid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.ErrorResponse" } } } } }, "/ab/peer/update/{guid}": { "put": { "security": [ { "BearerAuth": [] } ], "description": "更新地址", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "地址[Personal]" ], "summary": "更新地址", "parameters": [ { "type": "string", "description": "guid", "name": "guid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.ErrorResponse" } } } } }, "/ab/peers": { "post": { "security": [ { "BearerAuth": [] } ], "description": "地址", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "地址[Personal]" ], "summary": "地址列表", "parameters": [ { "type": "integer", "description": "页码", "name": "current", "in": "query" }, { "type": "integer", "description": "每页数量", "name": "pageSize", "in": "query" }, { "type": "string", "description": "guid", "name": "ab", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/ab/personal": { "post": { "security": [ { "BearerAuth": [] } ], "description": "个人地址", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "地址[Personal]" ], "summary": "个人地址", "parameters": [ { "description": "string valid", "name": "string", "in": "body", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/ab/settings": { "post": { "security": [ { "BearerAuth": [] } ], "description": "设置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "地址[Personal]" ], "summary": "设置", "parameters": [ { "description": "string valid", "name": "string", "in": "body", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/ab/shared/profiles": { "post": { "security": [ { "BearerAuth": [] } ], "description": "共享", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "地址[Personal]" ], "summary": "共享地址簿", "parameters": [ { "type": "integer", "description": "页码", "name": "current", "in": "query" }, { "type": "integer", "description": "每页数量", "name": "pageSize", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/ab/tag/add/{guid}": { "post": { "security": [ { "BearerAuth": [] } ], "description": "标签", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "地址[Personal]" ], "summary": "标签添加", "parameters": [ { "type": "string", "description": "guid", "name": "guid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.ErrorResponse" } } } } }, "/ab/tag/rename/{guid}": { "put": { "security": [ { "BearerAuth": [] } ], "description": "标签", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "地址[Personal]" ], "summary": "标签重命名", "parameters": [ { "type": "string", "description": "guid", "name": "guid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.ErrorResponse" } } } } }, "/ab/tag/update/{guid}": { "put": { "security": [ { "BearerAuth": [] } ], "description": "标签", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "地址[Personal]" ], "summary": "标签修改颜色", "parameters": [ { "type": "string", "description": "guid", "name": "guid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.ErrorResponse" } } } } }, "/ab/tag/{guid}": { "delete": { "security": [ { "BearerAuth": [] } ], "description": "标签", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "地址[Personal]" ], "summary": "标签删除", "parameters": [ { "type": "string", "description": "guid", "name": "guid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.ErrorResponse" } } } } }, "/ab/tags/{guid}": { "post": { "security": [ { "BearerAuth": [] } ], "description": "标签", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "地址[Personal]" ], "summary": "标签", "parameters": [ { "type": "string", "description": "guid", "name": "guid", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/model.TagList" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.ErrorResponse" } } } } }, "/api": { "get": { "security": [ { "token": [] } ], "description": "用户信息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "用户" ], "summary": "用户信息", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.UserPayload" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/audit/conn": { "post": { "description": "审计连接", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "审计" ], "summary": "审计连接", "parameters": [ { "description": "审计连接", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.AuditConnForm" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/audit/file": { "post": { "description": "审计文件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "审计" ], "summary": "审计文件", "parameters": [ { "description": "审计文件", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.AuditFileForm" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/heartbeat": { "post": { "description": "心跳", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "首页" ], "summary": "心跳", "responses": { "200": { "description": "OK" }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/login": { "post": { "description": "登录", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "登录" ], "summary": "登录", "parameters": [ { "description": "登录表单", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.LoginForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.LoginRes" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.ErrorResponse" } } } } }, "/login-options": { "get": { "description": "登录选项", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "登录" ], "summary": "登录选项", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "type": "string" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.ErrorResponse" } } } } }, "/logout": { "post": { "description": "登出", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "登录" ], "summary": "登出", "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.ErrorResponse" } } } } }, "/oauth/callback": { "get": { "description": "OauthCallback", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Oauth" ], "summary": "OauthCallback", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.LoginRes" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.ErrorResponse" } } } } }, "/oidc/auth": { "post": { "description": "OidcAuth", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Oauth" ], "summary": "OidcAuth", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.LoginRes" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.ErrorResponse" } } } } }, "/oidc/auth-query": { "get": { "description": "OidcAuthQuery", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "Oauth" ], "summary": "OidcAuthQuery", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/api.LoginRes" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.ErrorResponse" } } } } }, "/peers": { "get": { "security": [ { "BearerAuth": [] } ], "description": "机器", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群组" ], "summary": "机器", "parameters": [ { "type": "integer", "description": "页码", "name": "page", "in": "query" }, { "type": "integer", "description": "每页数量", "name": "pageSize", "in": "query" }, { "type": "integer", "description": "状态", "name": "status", "in": "query" }, { "type": "string", "description": "accessible", "name": "accessible", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.DataResponse" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/server-config": { "get": { "security": [ { "token": [] } ], "description": "服务配置,给webclient提供api-server", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "WEBCLIENT" ], "summary": "服务配置", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/shared-peer": { "post": { "description": "分享的peer", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "WEBCLIENT" ], "summary": "分享的peer", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/response.Response" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.Response" } } } } }, "/sysinfo": { "post": { "description": "提交系统信息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "地址" ], "summary": "提交系统信息", "parameters": [ { "description": "系统信息表单", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/api.PeerForm" } } ], "responses": { "200": { "description": "SYSINFO_UPDATED,ID_NOT_FOUND", "schema": { "type": "string" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.ErrorResponse" } } } } }, "/tags": { "post": { "security": [ { "BearerAuth": [] } ], "description": "标签", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "地址" ], "summary": "标签", "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/model.Tag" } } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.ErrorResponse" } } } } }, "/users": { "get": { "security": [ { "BearerAuth": [] } ], "description": "用户列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "群组" ], "summary": "用户列表", "parameters": [ { "type": "integer", "description": "页码", "name": "page", "in": "query" }, { "type": "integer", "description": "每页数量", "name": "pageSize", "in": "query" }, { "type": "integer", "description": "状态", "name": "status", "in": "query" }, { "type": "string", "description": "accessible", "name": "accessible", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/response.DataResponse" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/api.UserPayload" } } } } ] } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/response.ErrorResponse" } } } } } }, "definitions": { "api.AddressBookForm": { "type": "object", "properties": { "data": { "type": "string", "example": "{\"tags\":[\"tag1\",\"tag2\",\"tag3\"],\"peers\":[{\"id\":\"abc\",\"username\":\"abv-l\",\"hostname\":\"\",\"platform\":\"Windows\",\"alias\":\"\",\"tags\":[\"tag1\",\"tag2\"],\"hash\":\"hash\"}],\"tag_colors\":\"{\\\"tag1\\\":4288585374,\\\"tag2\\\":4278238420,\\\"tag3\\\":4291681337}\"}" } } }, "api.AuditConnForm": { "type": "object", "properties": { "action": { "type": "string" }, "conn_id": { "type": "integer" }, "id": { "type": "string" }, "ip": { "type": "string" }, "peer": { "type": "array", "items": { "type": "string" } }, "session_id": { "type": "number" }, "type": { "type": "integer" }, "uuid": { "type": "string" } } }, "api.AuditFileForm": { "type": "object", "properties": { "id": { "type": "string" }, "info": { "type": "string" }, "is_file": { "type": "boolean" }, "path": { "type": "string" }, "peer_id": { "type": "string" }, "type": { "type": "integer" }, "uuid": { "type": "string" } } }, "api.DeviceInfoInLogin": { "type": "object", "properties": { "name": { "type": "string" }, "os": { "type": "string" }, "type": { "type": "string" } } }, "api.LoginForm": { "type": "object", "required": [ "username" ], "properties": { "autoLogin": { "type": "boolean" }, "deviceInfo": { "$ref": "#/definitions/api.DeviceInfoInLogin" }, "id": { "type": "string" }, "password": { "type": "string", "maxLength": 20, "minLength": 4 }, "type": { "type": "string" }, "username": { "type": "string", "maxLength": 10, "minLength": 2 }, "uuid": { "type": "string" } } }, "api.LoginRes": { "type": "object", "properties": { "access_token": { "type": "string" }, "secret": { "type": "string" }, "tfa_type": { "type": "string" }, "type": { "type": "string" }, "user": { "$ref": "#/definitions/api.UserPayload" } } }, "api.PeerForm": { "type": "object", "properties": { "cpu": { "type": "string" }, "hostname": { "type": "string" }, "id": { "type": "string" }, "memory": { "type": "string" }, "os": { "type": "string" }, "username": { "type": "string" }, "uuid": { "type": "string" }, "version": { "type": "string" } } }, "api.UserPayload": { "type": "object", "properties": { "email": { "type": "string" }, "info": { "type": "object", "additionalProperties": true }, "is_admin": { "type": "boolean" }, "name": { "type": "string" }, "note": { "type": "string" }, "status": { "type": "integer" } } }, "model.AddressBookCollection": { "type": "object", "required": [ "name" ], "properties": { "created_at": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "updated_at": { "type": "string" }, "user_id": { "type": "integer" } } }, "model.Tag": { "type": "object", "properties": { "collection": { "$ref": "#/definitions/model.AddressBookCollection" }, "collection_id": { "type": "integer" }, "color": { "description": "color 是flutter的颜色值,从0x00000000 到 0xFFFFFFFF; 前两位表示透明度，后面6位表示颜色, 可以转成rgba", "type": "integer" }, "created_at": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "updated_at": { "type": "string" }, "user_id": { "type": "integer" } } }, "model.TagList": { "type": "object", "properties": { "list": { "type": "array", "items": { "$ref": "#/definitions/model.Tag" } }, "page": { "type": "integer" }, "page_size": { "type": "integer" }, "total": { "type": "integer" } } }, "response.DataResponse": { "type": "object", "properties": { "data": {}, "total": { "type": "integer" } } }, "response.ErrorResponse": { "type": "object", "properties": { "error": { "type": "string" } } }, "response.Response": { "type": "object", "properties": { "code": { "type": "integer" }, "data": {}, "message": { "type": "string" } } } }, "securityDefinitions": { "BearerAuth": { "type": "apiKey", "name": "Authorization", "in": "header" }, "token": { "type": "apiKey", "name": "api-token", "in": "header" } } }` // SwaggerInfoapi holds exported Swagger Info so clients can modify it var SwaggerInfoapi = &swag.Spec{ Version: "1.0", Host: "", BasePath: "/api", Schemes: []string{}, Title: "管理系统API", Description: "接口", InfoInstanceName: "api", SwaggerTemplate: docTemplateapi, LeftDelim: "{{", RightDelim: "}}", } func init() { swag.Register(SwaggerInfoapi.InstanceName(), SwaggerInfoapi) }