{ "swagger": "2.0", "info": { "description": "近山社区小程序平台", "title": "jinshan_community", "contact": {}, "version": "v1.0.0" }, "paths": { "/api/v1/activities": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ActivityAPI" ], "summary": "Query activity list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.Activity" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ActivityAPI" ], "summary": "Create activity record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.ActivityForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Activity" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/activities/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ActivityAPI" ], "summary": "Get activity record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Activity" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ActivityAPI" ], "summary": "Update activity record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.ActivityForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ActivityAPI" ], "summary": "Delete activity record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/activity-categories": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ActivityCategoryAPI" ], "summary": "Query activity category list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.ActivityCategory" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ActivityCategoryAPI" ], "summary": "Create activity category record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.ActivityCategoryForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.ActivityCategory" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/activity-categories/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ActivityCategoryAPI" ], "summary": "Get activity category record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.ActivityCategory" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ActivityCategoryAPI" ], "summary": "Update activity category record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.ActivityCategoryForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ActivityCategoryAPI" ], "summary": "Delete activity category record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/ai-requests": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "AiRequestAPI" ], "summary": "Query ai request list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.AiRequest" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "AiRequestAPI" ], "summary": "Create ai request record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.AiRequestForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.AiRequest" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/ai-requests/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "AiRequestAPI" ], "summary": "Get ai request record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.AiRequest" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "AiRequestAPI" ], "summary": "Update ai request record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.AiRequestForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "AiRequestAPI" ], "summary": "Delete ai request record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/apps": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "AppAPI" ], "summary": "Query app list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.App" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "AppAPI" ], "summary": "Create app record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.AppForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.App" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/apps/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "AppAPI" ], "summary": "Get app record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.App" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "AppAPI" ], "summary": "Update app record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.AppForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "AppAPI" ], "summary": "Delete app record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/balances": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "BalanceAPI" ], "summary": "Query balance list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.Balance" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "BalanceAPI" ], "summary": "Create balance record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.BalanceForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Balance" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/balances/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "BalanceAPI" ], "summary": "Get balance record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Balance" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "BalanceAPI" ], "summary": "Update balance record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.BalanceForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "BalanceAPI" ], "summary": "Delete balance record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/banners": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "BannerAPI" ], "summary": "Query banner list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.Banner" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "BannerAPI" ], "summary": "Create banner record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.BannerForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Banner" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/banners/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "BannerAPI" ], "summary": "Get banner record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Banner" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "BannerAPI" ], "summary": "Update banner record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.BannerForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "BannerAPI" ], "summary": "Delete banner record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/captcha/id": { "get": { "tags": [ "LoginAPI" ], "summary": "Get captcha ID", "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Captcha" } } } ] } } } } }, "/api/v1/captcha/image": { "get": { "produces": [ "image/png" ], "tags": [ "LoginAPI" ], "summary": "Response captcha image", "parameters": [ { "type": "string", "description": "Captcha ID", "name": "id", "in": "query", "required": true }, { "type": "number", "description": "Reload captcha image (reload=1)", "name": "reload", "in": "query" } ], "responses": { "200": { "description": "Captcha image" }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/current/logout": { "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "LoginAPI" ], "summary": "Logout system", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/current/menus": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "LoginAPI" ], "summary": "Query current user menus based on the current user role", "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.Menu" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/current/password": { "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "LoginAPI" ], "summary": "Change current user password", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.UpdateLoginPassword" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/current/refresh-token": { "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "LoginAPI" ], "summary": "Refresh current access token", "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.LoginToken" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/current/user": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "LoginAPI" ], "summary": "Get current user info", "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.User" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "LoginAPI" ], "summary": "Update current user info", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.UpdateCurrentUser" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/customers": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "CustomerAPI" ], "summary": "Query customer list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.Customer" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "CustomerAPI" ], "summary": "Create customer record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.CustomerForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Customer" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/customers/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "CustomerAPI" ], "summary": "Get customer record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Customer" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "CustomerAPI" ], "summary": "Update customer record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.CustomerForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "CustomerAPI" ], "summary": "Delete customer record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/helps": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "HelpAPI" ], "summary": "Query help list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.Help" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "HelpAPI" ], "summary": "Create help record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.HelpForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Help" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/helps/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "HelpAPI" ], "summary": "Get help record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Help" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "HelpAPI" ], "summary": "Update help record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.HelpForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "HelpAPI" ], "summary": "Delete help record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/loggers": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "LoggerAPI" ], "summary": "Query logger list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true }, { "type": "string", "description": "log level", "name": "level", "in": "query" }, { "type": "string", "description": "trace ID", "name": "traceID", "in": "query" }, { "type": "string", "description": "user name", "name": "userName", "in": "query" }, { "type": "string", "description": "log tag", "name": "tag", "in": "query" }, { "type": "string", "description": "log message", "name": "message", "in": "query" }, { "type": "string", "description": "start time", "name": "startTime", "in": "query" }, { "type": "string", "description": "end time", "name": "endTime", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.Logger" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/login": { "post": { "tags": [ "LoginAPI" ], "summary": "Login system with username and password", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.LoginForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.LoginToken" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/menus": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "MenuAPI" ], "summary": "Query menu tree data", "parameters": [ { "type": "string", "description": "Code path of menu (like xxx.xxx.xxx)", "name": "code", "in": "query" }, { "type": "string", "description": "Name of menu", "name": "name", "in": "query" }, { "type": "boolean", "description": "Whether to include menu resources", "name": "includeResources", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.Menu" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "MenuAPI" ], "summary": "Create menu record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.MenuForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Menu" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/menus/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "MenuAPI" ], "summary": "Get menu record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Menu" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "MenuAPI" ], "summary": "Update menu record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.MenuForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "MenuAPI" ], "summary": "Delete menu record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/metting-room-orders": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "MettingRoomOrderAPI" ], "summary": "Query metting room order list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.MettingRoomOrder" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "MettingRoomOrderAPI" ], "summary": "Create metting room order record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.MettingRoomOrderForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.MettingRoomOrder" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/metting-room-orders/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "MettingRoomOrderAPI" ], "summary": "Get metting room order record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.MettingRoomOrder" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "MettingRoomOrderAPI" ], "summary": "Update metting room order record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.MettingRoomOrderForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "MettingRoomOrderAPI" ], "summary": "Delete metting room order record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/metting-rooms": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "MettingRoomAPI" ], "summary": "Query metting room list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.MettingRoom" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "MettingRoomAPI" ], "summary": "Create metting room record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.MettingRoomForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.MettingRoom" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/metting-rooms/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "MettingRoomAPI" ], "summary": "Get metting room record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.MettingRoom" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "MettingRoomAPI" ], "summary": "Update metting room record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.MettingRoomForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "MettingRoomAPI" ], "summary": "Delete metting room record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/notices": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "NoticeAPI" ], "summary": "Query notice list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.Notice" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "NoticeAPI" ], "summary": "Create notice record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.NoticeForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Notice" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/notices/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "NoticeAPI" ], "summary": "Get notice record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Notice" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "NoticeAPI" ], "summary": "Update notice record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.NoticeForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "NoticeAPI" ], "summary": "Delete notice record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/orders": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "OrderAPI" ], "summary": "Query order list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.Order" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "OrderAPI" ], "summary": "Create order record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.OrderForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Order" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/orders/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "OrderAPI" ], "summary": "Get order record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Order" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "OrderAPI" ], "summary": "Update order record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.OrderForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "OrderAPI" ], "summary": "Delete order record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/product-categories": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ProductCategoryAPI" ], "summary": "Query product category list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.ProductCategory" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ProductCategoryAPI" ], "summary": "Create product category record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.ProductCategoryForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.ProductCategory" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/product-categories/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ProductCategoryAPI" ], "summary": "Get product category record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.ProductCategory" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ProductCategoryAPI" ], "summary": "Update product category record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.ProductCategoryForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ProductCategoryAPI" ], "summary": "Delete product category record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/products": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ProductAPI" ], "summary": "Query product list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.Product" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ProductAPI" ], "summary": "Create product record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.ProductForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Product" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/products/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ProductAPI" ], "summary": "Get product record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Product" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ProductAPI" ], "summary": "Update product record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.ProductForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ProductAPI" ], "summary": "Delete product record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/reciprocities": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ReciprocityAPI" ], "summary": "Query reciprocity list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.Reciprocity" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ReciprocityAPI" ], "summary": "Create reciprocity record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.ReciprocityForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Reciprocity" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/reciprocities/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ReciprocityAPI" ], "summary": "Get reciprocity record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Reciprocity" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ReciprocityAPI" ], "summary": "Update reciprocity record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.ReciprocityForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ReciprocityAPI" ], "summary": "Delete reciprocity record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/roles": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "RoleAPI" ], "summary": "Query role list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true }, { "type": "string", "description": "Display name of role", "name": "name", "in": "query" }, { "type": "string", "description": "Status of role (disabled, enabled)", "name": "status", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.Role" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "RoleAPI" ], "summary": "Create role record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.RoleForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Role" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/roles/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "RoleAPI" ], "summary": "Get role record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Role" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "RoleAPI" ], "summary": "Update role record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.RoleForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "RoleAPI" ], "summary": "Delete role record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/shops": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ShopAPI" ], "summary": "Query shop list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.Shop" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ShopAPI" ], "summary": "Create shop record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.ShopForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Shop" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/shops/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ShopAPI" ], "summary": "Get shop record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.Shop" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ShopAPI" ], "summary": "Update shop record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.ShopForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "ShopAPI" ], "summary": "Delete shop record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/surrounding-service-types": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "SurroundingServiceTypeAPI" ], "summary": "Query surrounding service type list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.SurroundingServiceType" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "SurroundingServiceTypeAPI" ], "summary": "Create surrounding service type record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.SurroundingServiceTypeForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.SurroundingServiceType" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/surrounding-service-types/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "SurroundingServiceTypeAPI" ], "summary": "Get surrounding service type record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.SurroundingServiceType" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "SurroundingServiceTypeAPI" ], "summary": "Update surrounding service type record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.SurroundingServiceTypeForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "SurroundingServiceTypeAPI" ], "summary": "Delete surrounding service type record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/surrounding-services": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "SurroundingServiceAPI" ], "summary": "Query surrounding service list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.SurroundingService" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "SurroundingServiceAPI" ], "summary": "Create surrounding service record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.SurroundingServiceForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.SurroundingService" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/surrounding-services/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "SurroundingServiceAPI" ], "summary": "Get surrounding service record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.SurroundingService" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "SurroundingServiceAPI" ], "summary": "Update surrounding service record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.SurroundingServiceForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "SurroundingServiceAPI" ], "summary": "Delete surrounding service record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/users": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "UserAPI" ], "summary": "Query user list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true }, { "type": "string", "description": "Username for login", "name": "username", "in": "query" }, { "type": "string", "description": "Name of user", "name": "name", "in": "query" }, { "type": "string", "description": "Status of user (activated, freezed)", "name": "status", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.User" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "UserAPI" ], "summary": "Create user record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.UserForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.User" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/users/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "UserAPI" ], "summary": "Get user record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.User" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "UserAPI" ], "summary": "Update user record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.UserForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "UserAPI" ], "summary": "Delete user record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/users/{id}/reset-pwd": { "patch": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "UserAPI" ], "summary": "Reset user password by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/web-sites": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "WebSiteAPI" ], "summary": "Query web site list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.WebSite" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "WebSiteAPI" ], "summary": "Create web site record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.WebSiteForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.WebSite" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/web-sites/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "WebSiteAPI" ], "summary": "Get web site record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.WebSite" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "WebSiteAPI" ], "summary": "Update web site record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.WebSiteForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "WebSiteAPI" ], "summary": "Delete web site record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/work-order-types": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "WorkOrderTypeAPI" ], "summary": "Query work order type list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.WorkOrderType" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "WorkOrderTypeAPI" ], "summary": "Create work order type record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.WorkOrderTypeForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.WorkOrderType" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/work-order-types/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "WorkOrderTypeAPI" ], "summary": "Get work order type record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.WorkOrderType" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "WorkOrderTypeAPI" ], "summary": "Update work order type record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.WorkOrderTypeForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "WorkOrderTypeAPI" ], "summary": "Delete work order type record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/work-orders": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "WorkOrderAPI" ], "summary": "Query work order list", "parameters": [ { "type": "integer", "default": 1, "description": "pagination index", "name": "current", "in": "query", "required": true }, { "type": "integer", "default": 10, "description": "pagination size", "name": "pageSize", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/schema.WorkOrder" } } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "WorkOrderAPI" ], "summary": "Create work order record", "parameters": [ { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.WorkOrderForm" } } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.WorkOrder" } } } ] } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } }, "/api/v1/work-orders/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "WorkOrderAPI" ], "summary": "Get work order record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "allOf": [ { "$ref": "#/definitions/util.ResponseResult" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/schema.WorkOrder" } } } ] } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "put": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "WorkOrderAPI" ], "summary": "Update work order record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true }, { "description": "Request body", "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/schema.WorkOrderForm" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "tags": [ "WorkOrderAPI" ], "summary": "Delete work order record by ID", "parameters": [ { "type": "string", "description": "unique id", "name": "id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/util.ResponseResult" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/util.ResponseResult" } } } } } }, "definitions": { "errors.Error": { "type": "object", "properties": { "code": { "type": "integer" }, "detail": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "string" } } }, "schema.Activity": { "type": "object", "properties": { "address": { "type": "string" }, "categoryId": { "type": "string" }, "content": { "type": "string" }, "cover": { "type": "string" }, "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "endAt": { "type": "string" }, "endSignupAt": { "type": "string" }, "id": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "maxSignupNum": { "type": "integer" }, "signupNum": { "type": "integer" }, "startAt": { "type": "string" }, "startSignupAt": { "type": "string" }, "status": { "type": "string" }, "title": { "type": "string" }, "updatedAt": { "type": "string" } } }, "schema.ActivityCategory": { "type": "object", "properties": { "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "sequence": { "type": "integer" }, "status": { "type": "string" }, "updatedAt": { "type": "string" } } }, "schema.ActivityCategoryForm": { "type": "object" }, "schema.ActivityForm": { "type": "object", "properties": { "address": { "type": "string" }, "categoryId": { "type": "string" }, "content": { "type": "string" }, "cover": { "type": "string" }, "endAt": { "type": "string" }, "endSignupAt": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "maxSignupNum": { "type": "integer" }, "signupNum": { "type": "integer" }, "startAt": { "type": "string" }, "startSignupAt": { "type": "string" }, "status": { "type": "string" }, "title": { "type": "string" } } }, "schema.AiRequest": { "type": "object", "properties": { "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "id": { "type": "string" }, "updatedAt": { "type": "string" } } }, "schema.AiRequestForm": { "type": "object", "properties": { "msg": { "type": "string" } } }, "schema.App": { "type": "object", "properties": { "created_at": { "description": "Create time", "type": "string" }, "id": { "description": "Unique ID", "type": "string" }, "updated_at": { "description": "Update time", "type": "string" } } }, "schema.AppForm": { "type": "object" }, "schema.Balance": { "type": "object", "properties": { "after": { "type": "integer" }, "before": { "type": "integer" }, "change": { "type": "integer" }, "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "customerId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "id": { "type": "string" }, "operatorId": { "type": "string" }, "reason": { "type": "string" }, "type": { "type": "string" }, "updatedAt": { "type": "string" } } }, "schema.BalanceForm": { "type": "object", "properties": { "CreatedID": { "type": "string" }, "after": { "type": "integer" }, "before": { "type": "integer" }, "change": { "type": "integer" }, "customerId": { "type": "string" }, "operatorId": { "type": "string" }, "reason": { "type": "string" }, "type": { "type": "string" } } }, "schema.Banner": { "type": "object", "properties": { "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "desc": { "type": "string" }, "id": { "type": "string" }, "img": { "type": "string" }, "link": { "type": "string" }, "sequence": { "type": "integer" }, "status": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" }, "updatedAt": { "type": "string" } } }, "schema.BannerForm": { "type": "object", "properties": { "desc": { "type": "string" }, "img": { "type": "string" }, "link": { "type": "string" }, "sequence": { "type": "integer" }, "status": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" } } }, "schema.Captcha": { "type": "object", "properties": { "captcha_id": { "description": "Captcha ID", "type": "string" } } }, "schema.Customer": { "type": "object", "properties": { "avatar": { "type": "string" }, "birthday": { "type": "string" }, "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "id": { "type": "string" }, "introduce": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" }, "status": { "type": "string" }, "updatedAt": { "type": "string" }, "wxSign": { "type": "string" } } }, "schema.CustomerForm": { "type": "object", "properties": { "avatar": { "type": "string" }, "birthday": { "type": "string" }, "introduce": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": "string" }, "status": { "type": "string" }, "wxSign": { "type": "string" } } }, "schema.Help": { "type": "object", "properties": { "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "customerId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "desc": { "type": "string" }, "id": { "type": "string" }, "img": { "type": "string" }, "link": { "type": "string" }, "sequence": { "type": "integer" }, "status": { "type": "string" }, "type": { "type": "string" }, "updatedAt": { "type": "string" } } }, "schema.HelpForm": { "type": "object" }, "schema.Logger": { "type": "object", "properties": { "created_at": { "description": "Create time", "type": "string" }, "data": { "description": "Log data", "type": "string" }, "id": { "description": "Unique ID", "type": "string" }, "level": { "description": "Log level", "type": "string" }, "login_name": { "description": "From User.Username", "type": "string" }, "message": { "description": "Log message", "type": "string" }, "stack": { "description": "Error stack", "type": "string" }, "tag": { "description": "Log tag", "type": "string" }, "trace_id": { "description": "Trace ID", "type": "string" }, "user_id": { "description": "User ID", "type": "string" }, "user_name": { "description": "From User.Name", "type": "string" } } }, "schema.LoginForm": { "type": "object", "required": [ "password", "username" ], "properties": { "captcha_code": { "description": "Captcha verify code", "type": "string" }, "captcha_id": { "description": "Captcha verify id", "type": "string" }, "password": { "description": "Login password (md5 hash)", "type": "string" }, "username": { "description": "Login name", "type": "string" } } }, "schema.LoginToken": { "type": "object", "properties": { "access_token": { "description": "Access token (JWT)", "type": "string" }, "expires_at": { "description": "Expired time (Unit: second)", "type": "integer" }, "token_type": { "description": "Token type (Usage: Authorization=${token_type} ${access_token})", "type": "string" } } }, "schema.Menu": { "type": "object", "properties": { "children": { "description": "Child menus", "type": "array", "items": { "$ref": "#/definitions/schema.Menu" } }, "code": { "description": "Code of menu (unique for each level)", "type": "string" }, "created_at": { "description": "Create time", "type": "string" }, "description": { "description": "Details about menu", "type": "string" }, "id": { "description": "Unique ID", "type": "string" }, "name": { "description": "Display name of menu", "type": "string" }, "parent_id": { "description": "Parent ID (From Menu.ID)", "type": "string" }, "parent_path": { "description": "Parent path (split by .)", "type": "string" }, "path": { "description": "Access path of menu", "type": "string" }, "properties": { "description": "Properties of menu (JSON)", "type": "string" }, "resources": { "description": "Resources of menu", "type": "array", "items": { "$ref": "#/definitions/schema.MenuResource" } }, "sequence": { "description": "Sequence for sorting (Order by desc)", "type": "integer" }, "status": { "description": "Status of menu (enabled, disabled)", "type": "string" }, "type": { "description": "Type of menu (page, button)", "type": "string" }, "updated_at": { "description": "Update time", "type": "string" } } }, "schema.MenuForm": { "type": "object", "required": [ "code", "name", "status", "type" ], "properties": { "code": { "description": "Code of menu (unique for each level)", "type": "string", "maxLength": 32 }, "description": { "description": "Details about menu", "type": "string" }, "name": { "description": "Display name of menu", "type": "string", "maxLength": 128 }, "parent_id": { "description": "Parent ID (From Menu.ID)", "type": "string" }, "path": { "description": "Access path of menu", "type": "string" }, "properties": { "description": "Properties of menu (JSON)", "type": "string" }, "resources": { "description": "Resources of menu", "type": "array", "items": { "$ref": "#/definitions/schema.MenuResource" } }, "sequence": { "description": "Sequence for sorting (Order by desc)", "type": "integer" }, "status": { "description": "Status of menu (enabled, disabled)", "type": "string", "enum": [ "disabled", "enabled" ] }, "type": { "description": "Type of menu (page, button)", "type": "string", "enum": [ "page", "button" ] } } }, "schema.MenuResource": { "type": "object", "properties": { "created_at": { "description": "Create time", "type": "string" }, "id": { "description": "Unique ID", "type": "string" }, "menu_id": { "description": "From Menu.ID", "type": "string" }, "method": { "description": "HTTP method", "type": "string" }, "path": { "description": "API request path (e.g. /api/v1/users/:id)", "type": "string" }, "updated_at": { "description": "Update time", "type": "string" } } }, "schema.MettingRoom": { "type": "object", "properties": { "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "desc": { "type": "string" }, "id": { "type": "string" }, "imgs": { "type": "array", "items": { "type": "string" } }, "link": { "type": "string" }, "maxNum": { "type": "integer" }, "status": { "type": "string" }, "title": { "type": "string" }, "updatedAt": { "type": "string" } } }, "schema.MettingRoomForm": { "type": "object", "properties": { "desc": { "type": "string" }, "imgs": { "type": "array", "items": { "type": "string" } }, "link": { "type": "string" }, "maxNum": { "type": "integer" }, "status": { "type": "string" }, "title": { "type": "string" } } }, "schema.MettingRoomOrder": { "type": "object", "properties": { "concatName": { "type": "string" }, "concatPhone": { "type": "string" }, "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "customerId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "endAt": { "type": "string" }, "id": { "type": "string" }, "roomId": { "type": "string" }, "startAt": { "type": "string" }, "status": { "type": "string" }, "updatedAt": { "type": "string" } } }, "schema.MettingRoomOrderForm": { "type": "object", "properties": { "concatName": { "type": "string" }, "concatPhone": { "type": "string" }, "customerId": { "type": "string" }, "endAt": { "type": "string" }, "roomId": { "type": "string" }, "startAt": { "type": "string" }, "status": { "type": "string" } } }, "schema.Notice": { "type": "object", "properties": { "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "desc": { "type": "string" }, "id": { "type": "string" }, "link": { "type": "string" }, "sequence": { "type": "integer" }, "status": { "type": "string" }, "title": { "type": "string" }, "updatedAt": { "type": "string" } } }, "schema.NoticeForm": { "type": "object", "properties": { "desc": { "type": "string" }, "link": { "type": "string" }, "sequence": { "type": "integer" }, "status": { "type": "string" }, "title": { "type": "string" } } }, "schema.Order": { "type": "object", "properties": { "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "customerId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "id": { "type": "string" }, "num": { "type": "integer" }, "productId": { "type": "string" }, "shopId": { "type": "string" }, "status": { "type": "string" }, "updatedAt": { "type": "string" } } }, "schema.OrderForm": { "type": "object" }, "schema.Product": { "type": "object", "properties": { "categoryId": { "type": "string" }, "content": { "type": "string" }, "cover": { "type": "string" }, "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "id": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "introduce": { "type": "string" }, "num": { "type": "integer" }, "price": { "type": "integer" }, "shopId": { "type": "string" }, "status": { "type": "string" }, "title": { "type": "string" }, "updatedAt": { "type": "string" } } }, "schema.ProductCategory": { "type": "object", "properties": { "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "sequence": { "type": "integer" }, "status": { "type": "string" }, "updatedAt": { "type": "string" } } }, "schema.ProductCategoryForm": { "type": "object", "properties": { "name": { "type": "string" }, "sequence": { "type": "integer" }, "status": { "type": "string" } } }, "schema.ProductForm": { "type": "object", "properties": { "categoryId": { "type": "string" }, "content": { "type": "string" }, "cover": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "introduce": { "type": "string" }, "num": { "type": "integer" }, "price": { "type": "integer" }, "shopId": { "type": "string" }, "status": { "type": "string" }, "title": { "type": "string" } } }, "schema.Reciprocity": { "type": "object", "properties": { "content": { "type": "string" }, "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "customerId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "id": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "title": { "type": "string" }, "updatedAt": { "type": "string" } } }, "schema.ReciprocityForm": { "type": "object", "properties": { "content": { "type": "string" }, "customerId": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string" }, "title": { "type": "string" } } }, "schema.Record": { "type": "object", "properties": { "content": { "type": "string" }, "sendAt": { "type": "string" }, "sender": { "type": "string" } } }, "schema.Role": { "type": "object", "properties": { "code": { "description": "Code of role (unique)", "type": "string" }, "created_at": { "description": "Create time", "type": "string" }, "description": { "description": "Details about role", "type": "string" }, "id": { "description": "Unique ID", "type": "string" }, "menus": { "description": "Role menu list", "type": "array", "items": { "$ref": "#/definitions/schema.RoleMenu" } }, "name": { "description": "Display name of role", "type": "string" }, "sequence": { "description": "Sequence for sorting", "type": "integer" }, "status": { "description": "Status of role (disabled, enabled)", "type": "string" }, "updated_at": { "description": "Update time", "type": "string" } } }, "schema.RoleForm": { "type": "object", "required": [ "code", "name", "status" ], "properties": { "code": { "description": "Code of role (unique)", "type": "string", "maxLength": 32 }, "description": { "description": "Details about role", "type": "string" }, "menus": { "description": "Role menu list", "type": "array", "items": { "$ref": "#/definitions/schema.RoleMenu" } }, "name": { "description": "Display name of role", "type": "string", "maxLength": 128 }, "sequence": { "description": "Sequence for sorting", "type": "integer" }, "status": { "description": "Status of role (enabled, disabled)", "type": "string", "enum": [ "disabled", "enabled" ] } } }, "schema.RoleMenu": { "type": "object", "properties": { "created_at": { "description": "Create time", "type": "string" }, "id": { "description": "Unique ID", "type": "string" }, "menu_id": { "description": "From Menu.ID", "type": "string" }, "role_id": { "description": "From Role.ID", "type": "string" }, "updated_at": { "description": "Update time", "type": "string" } } }, "schema.Shop": { "type": "object", "properties": { "content": { "type": "string" }, "cover": { "type": "string" }, "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "id": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "introduce": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "status": { "type": "string" }, "title": { "type": "string" }, "updatedAt": { "type": "string" } } }, "schema.ShopForm": { "type": "object", "properties": { "content": { "type": "string" }, "cover": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "introduce": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "status": { "type": "string" }, "title": { "type": "string" } } }, "schema.SurroundingService": { "type": "object", "properties": { "content": { "type": "string" }, "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "desc": { "type": "string" }, "id": { "type": "string" }, "img": { "type": "string" }, "link": { "type": "string" }, "sequence": { "type": "integer" }, "status": { "type": "string" }, "title": { "type": "string" }, "typeId": { "type": "string" }, "updatedAt": { "type": "string" } } }, "schema.SurroundingServiceForm": { "type": "object", "properties": { "content": { "type": "string" }, "desc": { "type": "string" }, "img": { "type": "string" }, "link": { "type": "string" }, "sequence": { "type": "integer" }, "status": { "type": "string" }, "title": { "type": "string" }, "typeId": { "type": "string" } } }, "schema.SurroundingServiceType": { "type": "object", "properties": { "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "sequence": { "type": "integer" }, "status": { "type": "string" }, "updatedAt": { "type": "string" } } }, "schema.SurroundingServiceTypeForm": { "type": "object", "properties": { "name": { "type": "string" }, "sequence": { "type": "integer" }, "status": { "type": "string" } } }, "schema.UpdateCurrentUser": { "type": "object", "required": [ "name" ], "properties": { "email": { "description": "Email of user", "type": "string", "maxLength": 128 }, "name": { "description": "Name of user", "type": "string", "maxLength": 64 }, "phone": { "description": "Phone number of user", "type": "string", "maxLength": 32 }, "remark": { "description": "Remark of user", "type": "string", "maxLength": 1024 } } }, "schema.UpdateLoginPassword": { "type": "object", "required": [ "new_password", "old_password" ], "properties": { "new_password": { "description": "New password (md5 hash)", "type": "string" }, "old_password": { "description": "Old password (md5 hash)", "type": "string" } } }, "schema.User": { "type": "object", "properties": { "created_at": { "description": "Create time", "type": "string" }, "email": { "description": "Email of user", "type": "string" }, "id": { "description": "Unique ID", "type": "string" }, "name": { "description": "Name of user", "type": "string" }, "phone": { "description": "Phone number of user", "type": "string" }, "remark": { "description": "Remark of user", "type": "string" }, "roles": { "description": "Roles of user", "type": "array", "items": { "$ref": "#/definitions/schema.UserRole" } }, "status": { "description": "Status of user (activated, freezed)", "type": "string" }, "updated_at": { "description": "Update time", "type": "string" }, "username": { "description": "Username for login", "type": "string" } } }, "schema.UserForm": { "type": "object", "required": [ "name", "roles", "status", "username" ], "properties": { "email": { "description": "Email of user", "type": "string", "maxLength": 128 }, "name": { "description": "Name of user", "type": "string", "maxLength": 64 }, "password": { "description": "Password for login (md5 hash)", "type": "string", "maxLength": 64 }, "phone": { "description": "Phone number of user", "type": "string", "maxLength": 32 }, "remark": { "description": "Remark of user", "type": "string", "maxLength": 1024 }, "roles": { "description": "Roles of user", "type": "array", "items": { "$ref": "#/definitions/schema.UserRole" } }, "status": { "description": "Status of user (activated, freezed)", "type": "string", "enum": [ "activated", "freezed" ] }, "username": { "description": "Username for login", "type": "string", "maxLength": 64 } } }, "schema.UserRole": { "type": "object", "properties": { "created_at": { "description": "Create time", "type": "string" }, "id": { "description": "Unique ID", "type": "string" }, "role_id": { "description": "From Role.ID", "type": "string" }, "role_name": { "description": "From Role.Name", "type": "string" }, "updated_at": { "description": "Update time", "type": "string" }, "user_id": { "description": "From User.ID", "type": "string" } } }, "schema.WebSite": { "type": "object", "properties": { "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "id": { "type": "string" }, "phone": { "type": "string" }, "updatedAt": { "type": "string" } } }, "schema.WebSiteForm": { "type": "object", "properties": { "phone": { "type": "string" } } }, "schema.WorkOrder": { "type": "object", "properties": { "content": { "type": "string" }, "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "customerId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "id": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "records": { "type": "array", "items": { "$ref": "#/definitions/schema.Record" } }, "status": { "type": "string" }, "updatedAt": { "type": "string" }, "videos": { "type": "array", "items": { "type": "string" } } } }, "schema.WorkOrderForm": { "type": "object", "properties": { "content": { "type": "string" }, "customerId": { "type": "string" }, "images": { "type": "array", "items": { "type": "string" } }, "records": { "type": "array", "items": { "$ref": "#/definitions/schema.Record" } }, "status": { "type": "string" }, "videos": { "type": "array", "items": { "type": "string" } } } }, "schema.WorkOrderType": { "type": "object", "properties": { "createdAt": { "type": "string" }, "createdId": { "type": "string" }, "deletedAt": { "type": "integer" }, "deletedId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "sequence": { "type": "integer" }, "status": { "type": "string" }, "updatedAt": { "type": "string" } } }, "schema.WorkOrderTypeForm": { "type": "object", "properties": { "name": { "type": "string" }, "sequence": { "type": "integer" }, "status": { "type": "string" } } }, "util.ResponseResult": { "type": "object", "properties": { "data": {}, "error": { "$ref": "#/definitions/errors.Error" }, "success": { "type": "boolean" }, "total": { "type": "integer" } } } }, "securityDefinitions": { "ApiKeyAuth": { "type": "apiKey", "name": "Authorization", "in": "header" } } }