22272 lines
779 KiB
Go
22272 lines
779 KiB
Go
// Package swagger Code generated by swaggo/swag. DO NOT EDIT
|
|
package swagger
|
|
|
|
import "github.com/swaggo/swag"
|
|
|
|
const docTemplate = `{
|
|
"schemes": {{ marshal .Schemes }},
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"description": "{{escape .Description}}",
|
|
"title": "{{.Title}}",
|
|
"contact": {},
|
|
"version": "{{.Version}}"
|
|
},
|
|
"host": "{{.Host}}",
|
|
"basePath": "{{.BasePath}}",
|
|
"paths": {
|
|
"/activity-logs": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all ActivityLogs",
|
|
"tags": [
|
|
"ActivityLogs"
|
|
],
|
|
"summary": "Get all ActivityLogs",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "activityTypeId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "articleId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "url",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "userId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create ActivityLogs",
|
|
"tags": [
|
|
"ActivityLogs"
|
|
],
|
|
"summary": "Create ActivityLogs",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ActivityLogsCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/activity-logs/detail/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one ActivityLogs",
|
|
"tags": [
|
|
"ActivityLogs"
|
|
],
|
|
"summary": "Get one ActivityLogs",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ActivityLogs ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/activity-logs/statistics": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for get activity stats ActivityLogs",
|
|
"tags": [
|
|
"ActivityLogs"
|
|
],
|
|
"summary": "Get activity stats ActivityLogs",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/activity-logs/{id}": {
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update ActivityLogs",
|
|
"tags": [
|
|
"ActivityLogs"
|
|
],
|
|
"summary": "update ActivityLogs",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ActivityLogsUpdateRequest"
|
|
}
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ActivityLogs ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete ActivityLogs",
|
|
"tags": [
|
|
"ActivityLogs"
|
|
],
|
|
"summary": "delete ActivityLogs",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ActivityLogs ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/advertisement": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all Advertisement",
|
|
"tags": [
|
|
"Advertisement"
|
|
],
|
|
"summary": "Get all Advertisement",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "description",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"name": "isPublish",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "placement",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "redirectLink",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "statusId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "title",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create Advertisement",
|
|
"tags": [
|
|
"Advertisement"
|
|
],
|
|
"summary": "Create Advertisement",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.AdvertisementCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/advertisement/publish/{id}": {
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for Update Publish Advertisement",
|
|
"tags": [
|
|
"Advertisement"
|
|
],
|
|
"summary": "Update Publish Advertisement",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Advertisement ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"description": "Advertisement Publish Status",
|
|
"name": "isPublish",
|
|
"in": "query",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/advertisement/upload/{id}": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for Upload File Advertisement",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"Advertisement"
|
|
],
|
|
"summary": "Upload Advertisement",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "file",
|
|
"description": "Upload file",
|
|
"name": "file",
|
|
"in": "formData",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Advertisement ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/advertisement/viewer/{filename}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for Viewer Advertisement",
|
|
"tags": [
|
|
"Advertisement"
|
|
],
|
|
"summary": "Viewer Advertisement",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Content File Name",
|
|
"name": "filename",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/advertisement/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one Advertisement",
|
|
"tags": [
|
|
"Advertisement"
|
|
],
|
|
"summary": "Get one Advertisement",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Advertisement ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update Advertisement",
|
|
"tags": [
|
|
"Advertisement"
|
|
],
|
|
"summary": "update Advertisement",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.AdvertisementUpdateRequest"
|
|
}
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Advertisement ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete Advertisement",
|
|
"tags": [
|
|
"Advertisement"
|
|
],
|
|
"summary": "delete Advertisement",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Advertisement ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/approval-workflow-steps": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all ApprovalWorkflowSteps",
|
|
"tags": [
|
|
"ApprovalWorkflowSteps"
|
|
],
|
|
"summary": "Get all ApprovalWorkflowSteps",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Workflow ID filter",
|
|
"name": "workflowId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Step order filter",
|
|
"name": "stepOrder",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Step name filter",
|
|
"name": "stepName",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "User level ID filter",
|
|
"name": "userLevelId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"description": "Is optional filter",
|
|
"name": "isOptional",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"description": "Is active filter",
|
|
"name": "isActive",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for saving ApprovalWorkflowSteps",
|
|
"tags": [
|
|
"ApprovalWorkflowSteps"
|
|
],
|
|
"summary": "Save ApprovalWorkflowSteps",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.CreateApprovalWorkflowStepsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/approval-workflow-steps/bulk": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for bulk creating ApprovalWorkflowSteps",
|
|
"tags": [
|
|
"ApprovalWorkflowSteps"
|
|
],
|
|
"summary": "Bulk create ApprovalWorkflowSteps",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.BulkCreateApprovalWorkflowStepsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/approval-workflow-steps/role/{roleId}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting ApprovalWorkflowSteps by Role ID",
|
|
"tags": [
|
|
"ApprovalWorkflowSteps"
|
|
],
|
|
"summary": "Get ApprovalWorkflowSteps by Role ID",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Role ID",
|
|
"name": "roleId",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/approval-workflow-steps/workflow/{workflowId}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting ApprovalWorkflowSteps by Workflow ID",
|
|
"tags": [
|
|
"ApprovalWorkflowSteps"
|
|
],
|
|
"summary": "Get ApprovalWorkflowSteps by Workflow ID",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Workflow ID",
|
|
"name": "workflowId",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/approval-workflow-steps/workflow/{workflowId}/reorder": {
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for reordering ApprovalWorkflowSteps",
|
|
"tags": [
|
|
"ApprovalWorkflowSteps"
|
|
],
|
|
"summary": "Reorder ApprovalWorkflowSteps",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Workflow ID",
|
|
"name": "workflowId",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ReorderApprovalWorkflowStepsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/approval-workflow-steps/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one ApprovalWorkflowSteps",
|
|
"tags": [
|
|
"ApprovalWorkflowSteps"
|
|
],
|
|
"summary": "Get one ApprovalWorkflowSteps",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ApprovalWorkflowSteps ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for updating ApprovalWorkflowSteps",
|
|
"tags": [
|
|
"ApprovalWorkflowSteps"
|
|
],
|
|
"summary": "Update ApprovalWorkflowSteps",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ApprovalWorkflowSteps ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UpdateApprovalWorkflowStepsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for deleting ApprovalWorkflowSteps",
|
|
"tags": [
|
|
"ApprovalWorkflowSteps"
|
|
],
|
|
"summary": "Delete ApprovalWorkflowSteps",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ApprovalWorkflowSteps ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/approval-workflows": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all ApprovalWorkflows",
|
|
"tags": [
|
|
"ApprovalWorkflows"
|
|
],
|
|
"summary": "Get all ApprovalWorkflows",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "description",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"name": "isActive",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"name": "isDefault",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "name",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for saving ApprovalWorkflows",
|
|
"tags": [
|
|
"ApprovalWorkflows"
|
|
],
|
|
"summary": "Save ApprovalWorkflows",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ApprovalWorkflowsCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/approval-workflows/comprehensive-details": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting comprehensive details of approval workflow including steps, client settings, and related data",
|
|
"tags": [
|
|
"ApprovalWorkflows"
|
|
],
|
|
"summary": "Get comprehensive approval workflow details",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/approval-workflows/default": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting default ApprovalWorkflows",
|
|
"tags": [
|
|
"ApprovalWorkflows"
|
|
],
|
|
"summary": "Get default ApprovalWorkflows",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/approval-workflows/with-client-settings": {
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for updating ApprovalWorkflows with workflow steps and client approval settings in a single call",
|
|
"tags": [
|
|
"ApprovalWorkflows"
|
|
],
|
|
"summary": "Update comprehensive ApprovalWorkflows with client settings",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Comprehensive approval workflow update data",
|
|
"name": "req",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UpdateApprovalWorkflowWithClientSettingsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for creating ApprovalWorkflows with workflow steps and client approval settings in a single call",
|
|
"tags": [
|
|
"ApprovalWorkflows"
|
|
],
|
|
"summary": "Create comprehensive ApprovalWorkflows with client settings",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Comprehensive approval workflow data",
|
|
"name": "req",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.CreateApprovalWorkflowWithClientSettingsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/approval-workflows/with-steps": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for creating ApprovalWorkflows with steps",
|
|
"tags": [
|
|
"ApprovalWorkflows"
|
|
],
|
|
"summary": "Create ApprovalWorkflows with steps",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "ApprovalWorkflows with steps data",
|
|
"name": "req",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ApprovalWorkflowsWithStepsCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/approval-workflows/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one ApprovalWorkflows",
|
|
"tags": [
|
|
"ApprovalWorkflows"
|
|
],
|
|
"summary": "Get one ApprovalWorkflows",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ApprovalWorkflows ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for updating ApprovalWorkflows",
|
|
"tags": [
|
|
"ApprovalWorkflows"
|
|
],
|
|
"summary": "Update ApprovalWorkflows",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ApprovalWorkflows ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ApprovalWorkflowsUpdateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for deleting ApprovalWorkflows",
|
|
"tags": [
|
|
"ApprovalWorkflows"
|
|
],
|
|
"summary": "Delete ApprovalWorkflows",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ApprovalWorkflows ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/approval-workflows/{id}/activate": {
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for activating ApprovalWorkflows",
|
|
"tags": [
|
|
"ApprovalWorkflows"
|
|
],
|
|
"summary": "Activate ApprovalWorkflows",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ApprovalWorkflows ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/approval-workflows/{id}/deactivate": {
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for deactivating ApprovalWorkflows",
|
|
"tags": [
|
|
"ApprovalWorkflows"
|
|
],
|
|
"summary": "Deactivate ApprovalWorkflows",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ApprovalWorkflows ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/approval-workflows/{id}/set-default": {
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for setting default ApprovalWorkflows",
|
|
"tags": [
|
|
"ApprovalWorkflows"
|
|
],
|
|
"summary": "Set default ApprovalWorkflows",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ApprovalWorkflows ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/approval-workflows/{id}/with-steps": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting ApprovalWorkflows with steps",
|
|
"tags": [
|
|
"ApprovalWorkflows"
|
|
],
|
|
"summary": "Get ApprovalWorkflows with steps",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ApprovalWorkflows ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for updating ApprovalWorkflows with steps",
|
|
"tags": [
|
|
"ApprovalWorkflows"
|
|
],
|
|
"summary": "Update ApprovalWorkflows with steps",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ApprovalWorkflows ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "ApprovalWorkflows with steps data",
|
|
"name": "req",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ApprovalWorkflowsWithStepsUpdateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-flows": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all ArticleApprovalFlows",
|
|
"tags": [
|
|
"ArticleApprovalFlows"
|
|
],
|
|
"summary": "Get all ArticleApprovalFlows",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "articleId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "currentStep",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "dateFrom",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "dateTo",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "statusId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "submittedBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "workflowId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-flows/analytics": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting approval analytics",
|
|
"tags": [
|
|
"ArticleApprovalFlows"
|
|
],
|
|
"summary": "Get approval analytics",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Period filter (daily, weekly, monthly)",
|
|
"name": "period",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Start date filter (YYYY-MM-DD)",
|
|
"name": "startDate",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "End date filter (YYYY-MM-DD)",
|
|
"name": "endDate",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-flows/articles/{articleId}/approve": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for approving an article using its currently active approval flow (simplified version)",
|
|
"tags": [
|
|
"ArticleApprovalFlows"
|
|
],
|
|
"summary": "Approve article by its active approval flow",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Article ID",
|
|
"name": "articleId",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ApprovalActionRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-flows/dashboard-stats": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting dashboard statistics",
|
|
"tags": [
|
|
"ArticleApprovalFlows"
|
|
],
|
|
"summary": "Get dashboard statistics",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-flows/history": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting approval history",
|
|
"tags": [
|
|
"ArticleApprovalFlows"
|
|
],
|
|
"summary": "Get approval history",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Article ID filter",
|
|
"name": "articleId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "User ID filter",
|
|
"name": "userId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-flows/my-queue": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting my approval queue",
|
|
"tags": [
|
|
"ArticleApprovalFlows"
|
|
],
|
|
"summary": "Get my approval queue",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"description": "Include article preview",
|
|
"name": "includePreview",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"description": "Show only urgent articles",
|
|
"name": "urgentOnly",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-flows/pending": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting pending approvals",
|
|
"tags": [
|
|
"ArticleApprovalFlows"
|
|
],
|
|
"summary": "Get pending approvals",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-flows/submit": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for submitting article for approval",
|
|
"tags": [
|
|
"ArticleApprovalFlows"
|
|
],
|
|
"summary": "Submit article for approval",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Submit for approval data",
|
|
"name": "req",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/netidhub-saas-be_app_module_article_approval_flows_request.SubmitForApprovalRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-flows/workload-stats": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting workload statistics",
|
|
"tags": [
|
|
"ArticleApprovalFlows"
|
|
],
|
|
"summary": "Get workload statistics",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-flows/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one ArticleApprovalFlows",
|
|
"tags": [
|
|
"ArticleApprovalFlows"
|
|
],
|
|
"summary": "Get one ArticleApprovalFlows",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleApprovalFlows ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-flows/{id}/approve": {
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for approving article",
|
|
"tags": [
|
|
"ArticleApprovalFlows"
|
|
],
|
|
"summary": "Approve article",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleApprovalFlows ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Approval action data",
|
|
"name": "req",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ApprovalActionRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-flows/{id}/multi-branch-approve": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for processing multi-branch approval with conditional routing",
|
|
"tags": [
|
|
"ArticleApprovalFlows"
|
|
],
|
|
"summary": "Process multi-branch approval",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleApprovalFlows ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Approval action data",
|
|
"name": "req",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ApprovalActionRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-flows/{id}/next-steps-preview": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting preview of next steps based on submitter's user level",
|
|
"tags": [
|
|
"ArticleApprovalFlows"
|
|
],
|
|
"summary": "Get next steps preview for multi-branch workflow",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleApprovalFlows ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-flows/{id}/resubmit": {
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for resubmitting article after revision",
|
|
"tags": [
|
|
"ArticleApprovalFlows"
|
|
],
|
|
"summary": "Resubmit article after revision",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleApprovalFlows ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Resubmit data",
|
|
"name": "req",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ResubmitRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-step-logs": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all ArticleApprovalStepLogs",
|
|
"tags": [
|
|
"ArticleApprovalStepLogs"
|
|
],
|
|
"summary": "Get all ArticleApprovalStepLogs",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "approvalStatusId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "approverUserId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "articleApprovalFlowId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "dateFrom",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "dateTo",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"name": "isAutoApproved",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "workflowStepId",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for saving ArticleApprovalStepLogs",
|
|
"tags": [
|
|
"ArticleApprovalStepLogs"
|
|
],
|
|
"summary": "Save ArticleApprovalStepLogs",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ArticleApprovalStepLogsCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-step-logs/approver/{user_id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting ArticleApprovalStepLogs by Approver User ID",
|
|
"tags": [
|
|
"ArticleApprovalStepLogs"
|
|
],
|
|
"summary": "Get ArticleApprovalStepLogs by Approver User ID",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Approver User ID",
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-step-logs/bulk-process": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for bulk processing approval steps",
|
|
"tags": [
|
|
"ArticleApprovalStepLogs"
|
|
],
|
|
"summary": "Bulk Process Approvals",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.BulkProcessApprovalRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-step-logs/flow/{flow_id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting ArticleApprovalStepLogs by Approval Flow ID",
|
|
"tags": [
|
|
"ArticleApprovalStepLogs"
|
|
],
|
|
"summary": "Get ArticleApprovalStepLogs by Approval Flow ID",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Approval Flow ID",
|
|
"name": "flow_id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-step-logs/history": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting approval history",
|
|
"tags": [
|
|
"ArticleApprovalStepLogs"
|
|
],
|
|
"summary": "Get Approval History",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Filter by article ID",
|
|
"name": "article_id",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Filter by user ID",
|
|
"name": "user_id",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Filter from date (YYYY-MM-DD)",
|
|
"name": "from_date",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Filter to date (YYYY-MM-DD)",
|
|
"name": "to_date",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-step-logs/overdue": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting overdue approvals",
|
|
"tags": [
|
|
"ArticleApprovalStepLogs"
|
|
],
|
|
"summary": "Get Overdue Approvals",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Filter by user ID",
|
|
"name": "user_id",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-step-logs/pending": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting pending approvals",
|
|
"tags": [
|
|
"ArticleApprovalStepLogs"
|
|
],
|
|
"summary": "Get Pending Approvals",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Filter by user ID",
|
|
"name": "user_id",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Filter by role ID",
|
|
"name": "role_id",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-step-logs/stats": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting approval statistics",
|
|
"tags": [
|
|
"ArticleApprovalStepLogs"
|
|
],
|
|
"summary": "Get Approval Statistics",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Filter from date (YYYY-MM-DD)",
|
|
"name": "from_date",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Filter to date (YYYY-MM-DD)",
|
|
"name": "to_date",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Filter by workflow ID",
|
|
"name": "workflow_id",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-step-logs/step/{step_id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting ArticleApprovalStepLogs by Workflow Step ID",
|
|
"tags": [
|
|
"ArticleApprovalStepLogs"
|
|
],
|
|
"summary": "Get ArticleApprovalStepLogs by Workflow Step ID",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Workflow Step ID",
|
|
"name": "step_id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-step-logs/user/{user_id}/workload": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting user workload statistics",
|
|
"tags": [
|
|
"ArticleApprovalStepLogs"
|
|
],
|
|
"summary": "Get User Workload",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "User ID",
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"description": "Include detailed statistics",
|
|
"name": "include_stats",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-step-logs/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one ArticleApprovalStepLogs",
|
|
"tags": [
|
|
"ArticleApprovalStepLogs"
|
|
],
|
|
"summary": "Get one ArticleApprovalStepLogs",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleApprovalStepLogs ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for updating ArticleApprovalStepLogs",
|
|
"tags": [
|
|
"ArticleApprovalStepLogs"
|
|
],
|
|
"summary": "Update ArticleApprovalStepLogs",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleApprovalStepLogs ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ArticleApprovalStepLogsUpdateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for deleting ArticleApprovalStepLogs",
|
|
"tags": [
|
|
"ArticleApprovalStepLogs"
|
|
],
|
|
"summary": "Delete ArticleApprovalStepLogs",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleApprovalStepLogs ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-step-logs/{id}/auto-approve": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for automatically approving a step",
|
|
"tags": [
|
|
"ArticleApprovalStepLogs"
|
|
],
|
|
"summary": "Auto Approve Step",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Step Log ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Auto approval reason",
|
|
"name": "reason",
|
|
"in": "query",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approval-step-logs/{id}/process": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for processing approval step",
|
|
"tags": [
|
|
"ArticleApprovalStepLogs"
|
|
],
|
|
"summary": "Process Approval",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Step Log ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ProcessApprovalRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approvals": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all ArticleApprovals",
|
|
"tags": [
|
|
"ArticleApprovals"
|
|
],
|
|
"summary": "Get all ArticleApprovals",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"name": "approvalAtLevel",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "approvalBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "articleId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "message",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "statusId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create ArticleApprovals",
|
|
"tags": [
|
|
"ArticleApprovals"
|
|
],
|
|
"summary": "Create ArticleApprovals",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ArticleApprovalsCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-approvals/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one ArticleApprovals",
|
|
"tags": [
|
|
"ArticleApprovals"
|
|
],
|
|
"summary": "Get one ArticleApprovals",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleApprovals ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update ArticleApprovals",
|
|
"tags": [
|
|
"ArticleApprovals"
|
|
],
|
|
"summary": "update ArticleApprovals",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ArticleApprovalsUpdateRequest"
|
|
}
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleApprovals ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete ArticleApprovals",
|
|
"tags": [
|
|
"ArticleApprovals"
|
|
],
|
|
"summary": "delete ArticleApprovals",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleApprovals ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-categories": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all ArticleCategories",
|
|
"tags": [
|
|
"Article Categories"
|
|
],
|
|
"summary": "Get all ArticleCategories",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "UserLevelId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "UserLevelNumber",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "description",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"name": "isPublish",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "parentId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "statusId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "title",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create ArticleCategories",
|
|
"tags": [
|
|
"Article Categories"
|
|
],
|
|
"summary": "Create ArticleCategories",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ArticleCategoriesCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-categories/old/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one ArticleCategories",
|
|
"tags": [
|
|
"Article Categories"
|
|
],
|
|
"summary": "Get one ArticleCategories",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleCategories Old ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-categories/slug/{slug}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one ArticleCategories",
|
|
"tags": [
|
|
"Article Categories"
|
|
],
|
|
"summary": "Get one ArticleCategories",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "ArticleCategories Slug",
|
|
"name": "slug",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-categories/thumbnail/viewer/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for View Thumbnail of ArticleCategories",
|
|
"tags": [
|
|
"Article Categories"
|
|
],
|
|
"summary": "Viewer ArticleCategories",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "ArticleCategories ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-categories/thumbnail/{id}": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for Upload ArticleCategories Thumbnail",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"Article Categories"
|
|
],
|
|
"summary": "Upload ArticleCategories Thumbnail",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "file",
|
|
"description": "Upload thumbnail",
|
|
"name": "files",
|
|
"in": "formData",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleCategories ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-categories/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one ArticleCategories",
|
|
"tags": [
|
|
"Article Categories"
|
|
],
|
|
"summary": "Get one ArticleCategories",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleCategories ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update ArticleCategories",
|
|
"tags": [
|
|
"Article Categories"
|
|
],
|
|
"summary": "update ArticleCategories",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ArticleCategoriesUpdateRequest"
|
|
}
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleCategories ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete ArticleCategories",
|
|
"tags": [
|
|
"Article Categories"
|
|
],
|
|
"summary": "delete ArticleCategories",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleCategories ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-category-details": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all ArticleCategoryDetails",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Get all ArticleCategoryDetails",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create ArticleCategoryDetails",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Create ArticleCategoryDetails",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-category-details/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one ArticleCategoryDetails",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Get one ArticleCategoryDetails",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleCategoryDetails ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update ArticleCategoryDetails",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "update ArticleCategoryDetails",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleCategoryDetails ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete ArticleCategoryDetails",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "delete ArticleCategoryDetails",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleCategoryDetails ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-comments": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all ArticleComments",
|
|
"tags": [
|
|
"ArticleComments"
|
|
],
|
|
"summary": "Get all ArticleComments",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "articleId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "commentFrom",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"name": "isPublic",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "message",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "parentId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create ArticleComments",
|
|
"tags": [
|
|
"ArticleComments"
|
|
],
|
|
"summary": "Create ArticleComments",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ArticleCommentsCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-comments/approval": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for Approval ArticleComments",
|
|
"tags": [
|
|
"ArticleComments"
|
|
],
|
|
"summary": "Approval ArticleComments",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ArticleCommentsApprovalRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-comments/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one ArticleComments",
|
|
"tags": [
|
|
"ArticleComments"
|
|
],
|
|
"summary": "Get one ArticleComments",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleComments ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update ArticleComments",
|
|
"tags": [
|
|
"ArticleComments"
|
|
],
|
|
"summary": "update ArticleComments",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ArticleCommentsUpdateRequest"
|
|
}
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleComments ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete ArticleComments",
|
|
"tags": [
|
|
"ArticleComments"
|
|
],
|
|
"summary": "delete ArticleComments",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleComments ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-files": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all ArticleFiles",
|
|
"tags": [
|
|
"Article Files"
|
|
],
|
|
"summary": "Get all ArticleFiles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "articleId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "fileName",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"name": "isPublish",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "statusId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-files/upload-status/{uploadId}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for GetUploadStatus ArticleFiles",
|
|
"tags": [
|
|
"Article Files"
|
|
],
|
|
"summary": "GetUploadStatus ArticleFiles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Upload ID of ArticleFiles",
|
|
"name": "uploadId",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-files/viewer/{filename}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for Viewer ArticleFiles",
|
|
"tags": [
|
|
"Article Files"
|
|
],
|
|
"summary": "Viewer ArticleFiles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Article File Name",
|
|
"name": "filename",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-files/{articleId}": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create ArticleFiles",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"Article Files"
|
|
],
|
|
"summary": "Upload ArticleFiles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "file",
|
|
"description": "Upload file",
|
|
"name": "files",
|
|
"in": "formData",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Article ID",
|
|
"name": "articleId",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-files/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one ArticleFiles",
|
|
"tags": [
|
|
"Article Files"
|
|
],
|
|
"summary": "Get one ArticleFiles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleFiles ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update ArticleFiles",
|
|
"tags": [
|
|
"Article Files"
|
|
],
|
|
"summary": "Update ArticleFiles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ArticleFilesUpdateRequest"
|
|
}
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleFiles ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete ArticleFiles",
|
|
"tags": [
|
|
"Article Files"
|
|
],
|
|
"summary": "Delete ArticleFiles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleFiles ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-nulis-ai": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all ArticleNulisAI",
|
|
"tags": [
|
|
"ArticleNulisAI"
|
|
],
|
|
"summary": "Get all ArticleNulisAI",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"name": "articleId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "categoryId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "creatorId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "description",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "htmlDescription",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nulisAiId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "tags",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "title",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create ArticleNulisAI",
|
|
"tags": [
|
|
"ArticleNulisAI"
|
|
],
|
|
"summary": "Create ArticleNulisAI",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ArticleNulisAICreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-nulis-ai/publish": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for publish ArticleNulisAI",
|
|
"tags": [
|
|
"ArticleNulisAI"
|
|
],
|
|
"summary": "publish ArticleNulisAI",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ArticleNulisAIUpdateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/article-nulis-ai/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one ArticleNulisAI",
|
|
"tags": [
|
|
"ArticleNulisAI"
|
|
],
|
|
"summary": "Get one ArticleNulisAI",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleNulisAI ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update ArticleNulisAI",
|
|
"tags": [
|
|
"ArticleNulisAI"
|
|
],
|
|
"summary": "update ArticleNulisAI",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ArticleNulisAIUpdateRequest"
|
|
}
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleNulisAI ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete ArticleNulisAI",
|
|
"tags": [
|
|
"ArticleNulisAI"
|
|
],
|
|
"summary": "delete ArticleNulisAI",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "ArticleNulisAI ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/articles": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all Articles",
|
|
"tags": [
|
|
"Articles"
|
|
],
|
|
"summary": "Get all Articles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "category",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "categoryId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "clientSlug",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "createdById",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "description",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"name": "isBanner",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"name": "isDraft",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"name": "isPublish",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "statusId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "tags",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "title",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "typeId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create Articles",
|
|
"tags": [
|
|
"Articles"
|
|
],
|
|
"summary": "Create Articles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ArticlesCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/articles/banner/{id}": {
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for Update Banner Articles",
|
|
"tags": [
|
|
"Articles"
|
|
],
|
|
"summary": "Update Banner Articles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Articles ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"description": "Articles Banner Status",
|
|
"name": "isBanner",
|
|
"in": "query",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/articles/old-id/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one Articles",
|
|
"tags": [
|
|
"Articles"
|
|
],
|
|
"summary": "Get one Articles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/articles/pending-approval": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting articles pending approval for current user level",
|
|
"tags": [
|
|
"Articles"
|
|
],
|
|
"summary": "Get Pending Approvals",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "page number",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "items per page",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "article type id",
|
|
"name": "typeId",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/articles/publish-scheduling": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for Publish Schedule of Article",
|
|
"tags": [
|
|
"Articles"
|
|
],
|
|
"summary": "PublishScheduling Articles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "article id",
|
|
"name": "id",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "publish date",
|
|
"name": "date",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/articles/statistic/monthly": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for ArticleMonthlyStats of Article",
|
|
"tags": [
|
|
"Articles"
|
|
],
|
|
"summary": "ArticleMonthlyStats Articles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "year",
|
|
"name": "year",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/articles/statistic/summary": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for Summary Stats of Article",
|
|
"tags": [
|
|
"Articles"
|
|
],
|
|
"summary": "SummaryStats Articles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/articles/statistic/user-levels": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for ArticlePerUserLevelStats of Article",
|
|
"tags": [
|
|
"Articles"
|
|
],
|
|
"summary": "ArticlePerUserLevelStats Articles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "start date",
|
|
"name": "startDate",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "start date",
|
|
"name": "endDate",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/articles/thumbnail/viewer/{thumbnailName}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for View Thumbnail of Article",
|
|
"tags": [
|
|
"Articles"
|
|
],
|
|
"summary": "Viewer Articles Thumbnail",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Articles Thumbnail Name",
|
|
"name": "thumbnailName",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/articles/thumbnail/{id}": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for Save Thumbnail of Articles",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"Articles"
|
|
],
|
|
"summary": "Save Thumbnail Articles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Articles ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/articles/waiting-for-approval": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting articles that are waiting for approval by the current user's level",
|
|
"tags": [
|
|
"Articles"
|
|
],
|
|
"summary": "Get articles waiting for approval by current user level",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"default": 1,
|
|
"description": "Page number",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"default": 10,
|
|
"description": "Items per page",
|
|
"name": "limit",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/articles/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one Articles",
|
|
"tags": [
|
|
"Articles"
|
|
],
|
|
"summary": "Get one Articles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update Articles",
|
|
"tags": [
|
|
"Articles"
|
|
],
|
|
"summary": "Update Articles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ArticlesUpdateRequest"
|
|
}
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Articles ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete Articles",
|
|
"tags": [
|
|
"Articles"
|
|
],
|
|
"summary": "Delete Articles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Articles ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/articles/{id}/approval-status": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting article approval status and workflow progress",
|
|
"tags": [
|
|
"Articles"
|
|
],
|
|
"summary": "Get Article Approval Status",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "article id",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/articles/{id}/submit-approval": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for submitting article for approval workflow",
|
|
"tags": [
|
|
"Articles"
|
|
],
|
|
"summary": "Submit Article for Approval",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "article id",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "approval request data",
|
|
"name": "req",
|
|
"in": "body",
|
|
"schema": {
|
|
"$ref": "#/definitions/netidhub-saas-be_app_module_articles_request.SubmitForApprovalRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/bookmarks": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all Bookmarks",
|
|
"tags": [
|
|
"Bookmarks"
|
|
],
|
|
"summary": "Get all Bookmarks",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "articleId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "userId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for creating new Bookmark",
|
|
"tags": [
|
|
"Bookmarks"
|
|
],
|
|
"summary": "Create new Bookmark",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Bookmark data",
|
|
"name": "req",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.BookmarksCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/bookmarks/check/{articleId}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for checking if an article is bookmarked by the current user",
|
|
"tags": [
|
|
"Bookmarks"
|
|
],
|
|
"summary": "Check if Article is Bookmarked by Current User",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Article ID",
|
|
"name": "articleId",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/bookmarks/summary": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting bookmark summary including total count and recent bookmarks",
|
|
"tags": [
|
|
"Bookmarks"
|
|
],
|
|
"summary": "Get Bookmark Summary for User",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/bookmarks/toggle/{articleId}": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for toggling bookmark status for an article",
|
|
"tags": [
|
|
"Bookmarks"
|
|
],
|
|
"summary": "Toggle Bookmark (Add/Remove)",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Article ID",
|
|
"name": "articleId",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/bookmarks/user": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting Bookmarks by User ID",
|
|
"tags": [
|
|
"Bookmarks"
|
|
],
|
|
"summary": "Get Bookmarks by User ID",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "articleId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "userId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/bookmarks/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting Bookmark by ID",
|
|
"tags": [
|
|
"Bookmarks"
|
|
],
|
|
"summary": "Get Bookmark by ID",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Bookmark ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for deleting Bookmark",
|
|
"tags": [
|
|
"Bookmarks"
|
|
],
|
|
"summary": "Delete Bookmark",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Bookmark ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/cities": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all Cities",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Get all Cities",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create Cities",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Create Cities",
|
|
"parameters": [
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.CitiesCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/cities/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one Cities",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Get one Cities",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Cities ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update Cities",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Update Cities",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Cities ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.CitiesUpdateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete Cities",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Delete Cities",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Cities ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/client-approval-settings": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting client approval settings",
|
|
"tags": [
|
|
"ClientApprovalSettings"
|
|
],
|
|
"summary": "Get Client Approval Settings",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for updating client approval settings",
|
|
"tags": [
|
|
"ClientApprovalSettings"
|
|
],
|
|
"summary": "Update Client Approval Settings",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UpdateClientApprovalSettingsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for creating client approval settings",
|
|
"tags": [
|
|
"ClientApprovalSettings"
|
|
],
|
|
"summary": "Create Client Approval Settings",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.CreateClientApprovalSettingsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for deleting client approval settings",
|
|
"tags": [
|
|
"ClientApprovalSettings"
|
|
],
|
|
"summary": "Delete Client Approval Settings",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/client-approval-settings/default-workflow": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for setting default workflow for client",
|
|
"tags": [
|
|
"ClientApprovalSettings"
|
|
],
|
|
"summary": "Set Default Workflow",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.SetDefaultWorkflowRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/client-approval-settings/disable": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for disabling approval system and auto-publish pending articles",
|
|
"tags": [
|
|
"ClientApprovalSettings"
|
|
],
|
|
"summary": "Disable Approval System",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.DisableApprovalRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/client-approval-settings/enable": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for enabling approval system with smooth transition",
|
|
"tags": [
|
|
"ClientApprovalSettings"
|
|
],
|
|
"summary": "Enable Approval System",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.EnableApprovalRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/client-approval-settings/exempt-categories/{action}/{category_id}": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for adding/removing categories from approval exemption",
|
|
"tags": [
|
|
"ClientApprovalSettings"
|
|
],
|
|
"summary": "Manage Exempt Categories",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Action: add or remove",
|
|
"name": "action",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Category ID",
|
|
"name": "category_id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/client-approval-settings/exempt-roles/{action}/{role_id}": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for adding/removing roles from approval exemption",
|
|
"tags": [
|
|
"ClientApprovalSettings"
|
|
],
|
|
"summary": "Manage Exempt Roles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Action: add or remove",
|
|
"name": "action",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Role ID",
|
|
"name": "role_id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/client-approval-settings/exempt-users/{action}/{user_id}": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for adding/removing users from approval exemption",
|
|
"tags": [
|
|
"ClientApprovalSettings"
|
|
],
|
|
"summary": "Manage Exempt Users",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Action: add or remove",
|
|
"name": "action",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "User ID",
|
|
"name": "user_id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/client-approval-settings/toggle": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for toggling approval requirement on/off",
|
|
"tags": [
|
|
"ClientApprovalSettings"
|
|
],
|
|
"summary": "Toggle Approval Requirement",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the Authorization",
|
|
"name": "Authorization",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ToggleApprovalRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all Clients with hierarchy filtering",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "Get all Clients",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Filter by client name",
|
|
"name": "name",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Filter by client type (parent_client, sub_client, standalone)",
|
|
"name": "clientType",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Filter by parent client ID",
|
|
"name": "parentClientId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"description": "Include all descendants",
|
|
"name": "includeSubClients",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"description": "Only clients with children",
|
|
"name": "onlyParentClients",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"description": "Only standalone clients",
|
|
"name": "onlyStandalone",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"description": "Only root level clients",
|
|
"name": "onlyRootClients",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"description": "Filter by active status",
|
|
"name": "isActive",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Filter by creator ID",
|
|
"name": "createdById",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Page number",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Items per page",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Sort field",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Sort direction (asc, desc)",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create Clients",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "Create Clients",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ClientsCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/bulk-sub-clients": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for creating multiple sub-clients at once",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "Bulk create sub-clients",
|
|
"parameters": [
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.BulkCreateSubClientsRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/check-name/{name}": {
|
|
"get": {
|
|
"description": "API for checking if client name exists (returns only exist status)",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "Check if client name exists",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Client name to check",
|
|
"name": "name",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/logo": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for uploading client logo image to MinIO (uses client ID from auth token)",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "Upload client logo",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "file",
|
|
"description": "Logo image file (jpg, jpeg, png, gif, webp, max 5MB)",
|
|
"name": "logo",
|
|
"in": "formData",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/logo/{filename}": {
|
|
"get": {
|
|
"description": "API for viewing client logo file by filename",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "View client logo",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Logo filename",
|
|
"name": "filename",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/profile": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting Clients detail using client ID from auth token",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "Get Clients detail with auth token",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/public": {
|
|
"get": {
|
|
"description": "API for getting all Clients for public consumption without sensitive data",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "Get all Clients (Public)",
|
|
"parameters": [
|
|
{
|
|
"enum": [
|
|
"parent_client",
|
|
"sub_client",
|
|
"standalone"
|
|
],
|
|
"type": "string",
|
|
"name": "clientType",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"description": "Include all descendants",
|
|
"name": "includeSubClients",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"description": "Status filter",
|
|
"name": "isActive",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Search filters",
|
|
"name": "name",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"description": "Only clients with children",
|
|
"name": "onlyParentClients",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"description": "Only standalone clients",
|
|
"name": "onlyStandalone",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Hierarchy filters",
|
|
"name": "parentClientId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/public/slug/{slug}": {
|
|
"get": {
|
|
"description": "API for getting Clients by slug for public consumption",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "Get Clients by slug (Public)",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Client slug",
|
|
"name": "slug",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/update": {
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update Clients using client ID from auth token",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "update Clients with auth token",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ClientsUpdateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/with-user": {
|
|
"post": {
|
|
"description": "API for creating a client and its admin user in a single request (Public endpoint)",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "Create client with admin user",
|
|
"parameters": [
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ClientWithUserCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one Clients",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "Get one Clients",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Clients ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update Clients",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "update Clients",
|
|
"parameters": [
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ClientsUpdateRequest"
|
|
}
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Clients ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete Clients",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "delete Clients",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Clients ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/{id}/hierarchy": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting client tree structure",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "Get client hierarchy",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Client ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/{id}/logo": {
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for deleting client logo from MinIO",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "Delete client logo",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Client ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/{id}/logo/url": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for generating presigned URL for client logo",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "Get client logo URL",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Client ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/{id}/move": {
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for moving a client to different parent",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "Move client",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Client ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.MoveClientRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/{id}/stats": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting client statistics",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "Get client statistics",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Client ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/clients/{id}/sub-clients": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting direct children of a client",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "Get sub-clients",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Parent Client ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for creating a client under a parent",
|
|
"tags": [
|
|
"Clients"
|
|
],
|
|
"summary": "Create sub-client",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Parent Client ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.ClientsCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/custom-static-pages": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all CustomStaticPages",
|
|
"tags": [
|
|
"CustomStaticPages"
|
|
],
|
|
"summary": "Get all CustomStaticPages",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "description",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "htmlBody",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "slug",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "title",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create CustomStaticPages",
|
|
"tags": [
|
|
"CustomStaticPages"
|
|
],
|
|
"summary": "Create CustomStaticPages",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.CustomStaticPagesCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/custom-static-pages/slug/{slug}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one CustomStaticPages",
|
|
"tags": [
|
|
"CustomStaticPages"
|
|
],
|
|
"summary": "Get one CustomStaticPages",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "CustomStaticPages Slug",
|
|
"name": "slug",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/custom-static-pages/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one CustomStaticPages",
|
|
"tags": [
|
|
"CustomStaticPages"
|
|
],
|
|
"summary": "Get one CustomStaticPages",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "CustomStaticPages ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update CustomStaticPages",
|
|
"tags": [
|
|
"CustomStaticPages"
|
|
],
|
|
"summary": "update CustomStaticPages",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.CustomStaticPagesUpdateRequest"
|
|
}
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "CustomStaticPages ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete CustomStaticPages",
|
|
"tags": [
|
|
"CustomStaticPages"
|
|
],
|
|
"summary": "delete CustomStaticPages",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "CustomStaticPages ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/districts": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all Districts",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Get all Districts",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create Districts",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Create Districts",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/districts/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one Districts",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Get one Districts",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Districts ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update Districts",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Update Districts",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Districts ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete Districts",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Delete Districts",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Districts ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/feedbacks": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all Feedbacks",
|
|
"tags": [
|
|
"Feedbacks"
|
|
],
|
|
"summary": "Get all Feedbacks",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "commentFromEmail",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "commentFromName",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "endDate",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "message",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "startDate",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "statusId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create Feedbacks",
|
|
"tags": [
|
|
"Feedbacks"
|
|
],
|
|
"summary": "Create Feedbacks",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.FeedbacksCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/feedbacks/statistic/monthly": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for FeedbackMonthlyStats of Feedbacks",
|
|
"tags": [
|
|
"Feedbacks"
|
|
],
|
|
"summary": "FeedbackMonthlyStats Feedbacks",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "year",
|
|
"name": "year",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/feedbacks/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one Feedbacks",
|
|
"tags": [
|
|
"Feedbacks"
|
|
],
|
|
"summary": "Get one Feedbacks",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Feedbacks ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update Feedbacks",
|
|
"tags": [
|
|
"Feedbacks"
|
|
],
|
|
"summary": "update Feedbacks",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.FeedbacksUpdateRequest"
|
|
}
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Feedbacks ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete Feedbacks",
|
|
"tags": [
|
|
"Feedbacks"
|
|
],
|
|
"summary": "delete Feedbacks",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Feedbacks ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/magazine-files": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all MagazineFiles",
|
|
"tags": [
|
|
"Magazine Files"
|
|
],
|
|
"summary": "Get all MagazineFiles",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/magazine-files/viewer/{filename}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create MagazineFiles",
|
|
"tags": [
|
|
"Magazine Files"
|
|
],
|
|
"summary": "Create MagazineFiles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Magazine File Name",
|
|
"name": "filename",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/magazine-files/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one MagazineFiles",
|
|
"tags": [
|
|
"Magazine Files"
|
|
],
|
|
"summary": "Get one MagazineFiles",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "MagazineFiles ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update MagazineFiles",
|
|
"tags": [
|
|
"Magazine Files"
|
|
],
|
|
"summary": "Update MagazineFiles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "MagazineFiles ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete MagazineFiles",
|
|
"tags": [
|
|
"Magazine Files"
|
|
],
|
|
"summary": "delete MagazineFiles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "MagazineFiles ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/magazine-files/{magazineId}": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create MagazineFiles",
|
|
"tags": [
|
|
"Magazine Files"
|
|
],
|
|
"summary": "Create MagazineFiles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "file",
|
|
"description": "Upload file",
|
|
"name": "files",
|
|
"in": "formData",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Magazine file title",
|
|
"name": "title",
|
|
"in": "formData",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Magazine file description",
|
|
"name": "description",
|
|
"in": "formData",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Magazine ID",
|
|
"name": "magazineId",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/magazines": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all Magazines",
|
|
"tags": [
|
|
"Magazines"
|
|
],
|
|
"summary": "Get all Magazines",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "createdById",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "description",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"name": "isPublish",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "pageUrl",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "statusId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "thumbnailPath",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "thumbnailUrl",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "title",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create Magazines",
|
|
"tags": [
|
|
"Magazines"
|
|
],
|
|
"summary": "Create Magazines",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.MagazinesCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/magazines/thumbnail/viewer/{thumbnailName}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for View Thumbnail of Magazines",
|
|
"tags": [
|
|
"Magazines"
|
|
],
|
|
"summary": "Viewer Magazines Thumbnail",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Magazines Thumbnail Name",
|
|
"name": "thumbnailName",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/magazines/thumbnail/{id}": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for Save Thumbnail of Magazines",
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"tags": [
|
|
"Magazines"
|
|
],
|
|
"summary": "Save Thumbnail Magazines",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Magazine ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "file",
|
|
"description": "Upload thumbnail",
|
|
"name": "files",
|
|
"in": "formData",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/magazines/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one Magazines",
|
|
"tags": [
|
|
"Magazines"
|
|
],
|
|
"summary": "Get one Magazines",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Magazines ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update Magazines",
|
|
"tags": [
|
|
"Magazines"
|
|
],
|
|
"summary": "Update Magazines",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Magazines ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.MagazinesUpdateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete Magazines",
|
|
"tags": [
|
|
"Magazines"
|
|
],
|
|
"summary": "Delete Magazines",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Magazines ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/master-menus": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all MasterMenus",
|
|
"tags": [
|
|
"MasterMenus"
|
|
],
|
|
"summary": "Get all MasterMenus",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"name": "description",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "moduleId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "name",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "parentMenuId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "statusId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create MasterMenus",
|
|
"tags": [
|
|
"MasterMenus"
|
|
],
|
|
"summary": "Create MasterMenus",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.MasterMenusCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/master-menus/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one MasterMenus",
|
|
"tags": [
|
|
"MasterMenus"
|
|
],
|
|
"summary": "Get one MasterMenus",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "MasterMenus ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update MasterMenus",
|
|
"tags": [
|
|
"MasterMenus"
|
|
],
|
|
"summary": "Update MasterMenus",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "MasterMenus ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete MasterMenus",
|
|
"tags": [
|
|
"MasterMenus"
|
|
],
|
|
"summary": "Delete MasterMenus",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "MasterMenus ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/master-modules": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all MasterModules",
|
|
"tags": [
|
|
"MasterModules"
|
|
],
|
|
"summary": "Get all MasterModules",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"name": "description",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "name",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "statusId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create MasterModules",
|
|
"tags": [
|
|
"MasterModules"
|
|
],
|
|
"summary": "Create MasterModules",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.MasterModulesCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/master-modules/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one MasterModules",
|
|
"tags": [
|
|
"MasterModules"
|
|
],
|
|
"summary": "Get one MasterModules",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "MasterModules ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update MasterModules",
|
|
"tags": [
|
|
"MasterModules"
|
|
],
|
|
"summary": "Update MasterModules",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "MasterModules ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.MasterModulesUpdateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete MasterModules",
|
|
"tags": [
|
|
"MasterModules"
|
|
],
|
|
"summary": "Delete MasterModules",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "MasterModules ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/master-statuses": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all MasterStatuses",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Get all MasterStatuses",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create MasterStatuses",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Create MasterStatuses",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/master-statuses/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one MasterStatuses",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Get one MasterStatuses",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "MasterStatuses ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update MasterStatuses",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Update MasterStatuses",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "MasterStatuses ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete MasterStatuses",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Delete MasterStatuses",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "MasterStatuses ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/menu-actions": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all MenuActions",
|
|
"tags": [
|
|
"MenuActions"
|
|
],
|
|
"summary": "Get all MenuActions",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Menu ID",
|
|
"name": "menu_id",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Action Code",
|
|
"name": "action_code",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create MenuAction",
|
|
"tags": [
|
|
"MenuActions"
|
|
],
|
|
"summary": "Create MenuAction",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.MenuActionsCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/menu-actions/batch": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create MenuActions batch",
|
|
"tags": [
|
|
"MenuActions"
|
|
],
|
|
"summary": "Create MenuActions batch",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.MenuActionsBatchCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/menu-actions/menu/{menu_id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting MenuActions by Menu ID",
|
|
"tags": [
|
|
"MenuActions"
|
|
],
|
|
"summary": "Get MenuActions by Menu ID",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Menu ID",
|
|
"name": "menu_id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/menu-actions/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one MenuAction",
|
|
"tags": [
|
|
"MenuActions"
|
|
],
|
|
"summary": "Get one MenuAction",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "MenuAction ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update MenuAction",
|
|
"tags": [
|
|
"MenuActions"
|
|
],
|
|
"summary": "Update MenuAction",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "MenuAction ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.MenuActionsUpdateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete MenuAction",
|
|
"tags": [
|
|
"MenuActions"
|
|
],
|
|
"summary": "Delete MenuAction",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "MenuAction ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/menu-modules": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all MenuModules",
|
|
"tags": [
|
|
"MenuModules"
|
|
],
|
|
"summary": "Get all MenuModules",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Menu ID",
|
|
"name": "menu_id",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Module ID",
|
|
"name": "module_id",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create MenuModule",
|
|
"tags": [
|
|
"MenuModules"
|
|
],
|
|
"summary": "Create MenuModule",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.MenuModulesCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/menu-modules/batch": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for creating multiple MenuModules at once for a menu",
|
|
"tags": [
|
|
"MenuModules"
|
|
],
|
|
"summary": "Create multiple MenuModules",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.MenuModulesBatchCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/menu-modules/menu/{menu_id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting MenuModules by Menu ID",
|
|
"tags": [
|
|
"MenuModules"
|
|
],
|
|
"summary": "Get MenuModules by Menu ID",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Menu ID",
|
|
"name": "menu_id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/menu-modules/module/{module_id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting MenuModules by Module ID",
|
|
"tags": [
|
|
"MenuModules"
|
|
],
|
|
"summary": "Get MenuModules by Module ID",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Module ID",
|
|
"name": "module_id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/menu-modules/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one MenuModule",
|
|
"tags": [
|
|
"MenuModules"
|
|
],
|
|
"summary": "Get one MenuModule",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "MenuModule ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update MenuModule",
|
|
"tags": [
|
|
"MenuModules"
|
|
],
|
|
"summary": "Update MenuModule",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.MenuModulesUpdateRequest"
|
|
}
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "MenuModule ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete MenuModule (soft delete)",
|
|
"tags": [
|
|
"MenuModules"
|
|
],
|
|
"summary": "Delete MenuModule",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "MenuModule ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/provinces": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all Provinces",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Get all Provinces",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create Provinces",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Create Provinces",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/provinces/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one Provinces",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Get one Provinces",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Provinces ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update Provinces",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Update Provinces",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Provinces ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete Provinces",
|
|
"tags": [
|
|
"Untags"
|
|
],
|
|
"summary": "Delete Provinces",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Provinces ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/schedules": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all Schedules",
|
|
"tags": [
|
|
"Schedules"
|
|
],
|
|
"summary": "Get all Schedules",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "clientSlug",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "createdById",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "description",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "endDate",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"name": "isLiveStreaming",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "location",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "speakers",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "startDate",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "statusId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "title",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "typeId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create Schedule",
|
|
"tags": [
|
|
"Schedules"
|
|
],
|
|
"summary": "Create Schedule",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.SchedulesCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/schedules/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one Schedule",
|
|
"tags": [
|
|
"Schedules"
|
|
],
|
|
"summary": "Get one Schedule",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Schedule ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update Schedule",
|
|
"tags": [
|
|
"Schedules"
|
|
],
|
|
"summary": "Update Schedule",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.SchedulesUpdateRequest"
|
|
}
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Schedule ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete Schedule",
|
|
"tags": [
|
|
"Schedules"
|
|
],
|
|
"summary": "Delete Schedule",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Schedule ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/subscription": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all Subscription",
|
|
"tags": [
|
|
"Subscription"
|
|
],
|
|
"summary": "Get all Subscription",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "email",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create Subscription",
|
|
"tags": [
|
|
"Subscription"
|
|
],
|
|
"summary": "Create Subscription",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.SubscriptionCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/subscription/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one Subscription",
|
|
"tags": [
|
|
"Subscription"
|
|
],
|
|
"summary": "Get one Subscription",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Subscription ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update Subscription",
|
|
"tags": [
|
|
"Subscription"
|
|
],
|
|
"summary": "update Subscription",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.SubscriptionUpdateRequest"
|
|
}
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Subscription ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete Subscription",
|
|
"tags": [
|
|
"Subscription"
|
|
],
|
|
"summary": "delete Subscription",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Client-Key",
|
|
"name": "X-Client-Key",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Subscription ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-level-menu-accesses": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all UserLevelMenuAccesses",
|
|
"tags": [
|
|
"UserLevelMenuAccesses"
|
|
],
|
|
"summary": "Get all UserLevelMenuAccesses",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "User Level ID",
|
|
"name": "user_level_id",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Menu ID",
|
|
"name": "menu_id",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create UserLevelMenuAccess",
|
|
"tags": [
|
|
"UserLevelMenuAccesses"
|
|
],
|
|
"summary": "Create UserLevelMenuAccess",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserLevelMenuAccessesCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-level-menu-accesses/batch": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create UserLevelMenuAccesses batch",
|
|
"tags": [
|
|
"UserLevelMenuAccesses"
|
|
],
|
|
"summary": "Create UserLevelMenuAccesses batch",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserLevelMenuAccessesBatchCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-level-menu-accesses/check/{user_level_id}/{menu_id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for checking if user level has access to menu",
|
|
"tags": [
|
|
"UserLevelMenuAccesses"
|
|
],
|
|
"summary": "Check User Level Menu Access",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "User Level ID",
|
|
"name": "user_level_id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Menu ID",
|
|
"name": "menu_id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-level-menu-accesses/menu/{menu_id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting UserLevelMenuAccesses by Menu ID",
|
|
"tags": [
|
|
"UserLevelMenuAccesses"
|
|
],
|
|
"summary": "Get UserLevelMenuAccesses by Menu ID",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Menu ID",
|
|
"name": "menu_id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-level-menu-accesses/user-level/{user_level_id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting UserLevelMenuAccesses by User Level ID",
|
|
"tags": [
|
|
"UserLevelMenuAccesses"
|
|
],
|
|
"summary": "Get UserLevelMenuAccesses by User Level ID",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "User Level ID",
|
|
"name": "user_level_id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-level-menu-accesses/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one UserLevelMenuAccess",
|
|
"tags": [
|
|
"UserLevelMenuAccesses"
|
|
],
|
|
"summary": "Get one UserLevelMenuAccess",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "UserLevelMenuAccess ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update UserLevelMenuAccess",
|
|
"tags": [
|
|
"UserLevelMenuAccesses"
|
|
],
|
|
"summary": "Update UserLevelMenuAccess",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "UserLevelMenuAccess ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserLevelMenuAccessesUpdateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete UserLevelMenuAccess",
|
|
"tags": [
|
|
"UserLevelMenuAccesses"
|
|
],
|
|
"summary": "Delete UserLevelMenuAccess",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "UserLevelMenuAccess ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-level-menu-action-accesses": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all UserLevelMenuActionAccesses",
|
|
"tags": [
|
|
"UserLevelMenuActionAccesses"
|
|
],
|
|
"summary": "Get all UserLevelMenuActionAccesses",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "User Level ID",
|
|
"name": "user_level_id",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Menu ID",
|
|
"name": "menu_id",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Action Code",
|
|
"name": "action_code",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create UserLevelMenuActionAccess",
|
|
"tags": [
|
|
"UserLevelMenuActionAccesses"
|
|
],
|
|
"summary": "Create UserLevelMenuActionAccess",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserLevelMenuActionAccessesCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-level-menu-action-accesses/batch": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create UserLevelMenuActionAccesses batch",
|
|
"tags": [
|
|
"UserLevelMenuActionAccesses"
|
|
],
|
|
"summary": "Create UserLevelMenuActionAccesses batch",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserLevelMenuActionAccessesBatchCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-level-menu-action-accesses/check/{user_level_id}/{menu_id}/{action_code}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for checking if user level has access to action in menu",
|
|
"tags": [
|
|
"UserLevelMenuActionAccesses"
|
|
],
|
|
"summary": "Check User Level Menu Action Access",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "User Level ID",
|
|
"name": "user_level_id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Menu ID",
|
|
"name": "menu_id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Action Code",
|
|
"name": "action_code",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-level-menu-action-accesses/menu/{menu_id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting UserLevelMenuActionAccesses by Menu ID",
|
|
"tags": [
|
|
"UserLevelMenuActionAccesses"
|
|
],
|
|
"summary": "Get UserLevelMenuActionAccesses by Menu ID",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Menu ID",
|
|
"name": "menu_id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-level-menu-action-accesses/user-level/{user_level_id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting UserLevelMenuActionAccesses by User Level ID",
|
|
"tags": [
|
|
"UserLevelMenuActionAccesses"
|
|
],
|
|
"summary": "Get UserLevelMenuActionAccesses by User Level ID",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "User Level ID",
|
|
"name": "user_level_id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-level-menu-action-accesses/user-level/{user_level_id}/menu/{menu_id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting UserLevelMenuActionAccesses by User Level ID and Menu ID",
|
|
"tags": [
|
|
"UserLevelMenuActionAccesses"
|
|
],
|
|
"summary": "Get UserLevelMenuActionAccesses by User Level ID and Menu ID",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "User Level ID",
|
|
"name": "user_level_id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Menu ID",
|
|
"name": "menu_id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-level-menu-action-accesses/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one UserLevelMenuActionAccess",
|
|
"tags": [
|
|
"UserLevelMenuActionAccesses"
|
|
],
|
|
"summary": "Get one UserLevelMenuActionAccess",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "UserLevelMenuActionAccess ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update UserLevelMenuActionAccess",
|
|
"tags": [
|
|
"UserLevelMenuActionAccesses"
|
|
],
|
|
"summary": "Update UserLevelMenuActionAccess",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "UserLevelMenuActionAccess ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserLevelMenuActionAccessesUpdateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete UserLevelMenuActionAccess",
|
|
"tags": [
|
|
"UserLevelMenuActionAccesses"
|
|
],
|
|
"summary": "Delete UserLevelMenuActionAccess",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "UserLevelMenuActionAccess ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-level-module-accesses": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all UserLevelModuleAccesses",
|
|
"tags": [
|
|
"UserLevelModuleAccesses"
|
|
],
|
|
"summary": "Get all UserLevelModuleAccesses",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "User Level ID",
|
|
"name": "user_level_id",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Module ID",
|
|
"name": "module_id",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "boolean",
|
|
"description": "Can Access",
|
|
"name": "can_access",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create UserLevelModuleAccess",
|
|
"tags": [
|
|
"UserLevelModuleAccesses"
|
|
],
|
|
"summary": "Create UserLevelModuleAccess",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserLevelModuleAccessesCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-level-module-accesses/batch": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for creating multiple UserLevelModuleAccesses at once for a user level",
|
|
"tags": [
|
|
"UserLevelModuleAccesses"
|
|
],
|
|
"summary": "Create multiple UserLevelModuleAccesses",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserLevelModuleAccessesBatchCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-level-module-accesses/check-access": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for checking if user level has access to module",
|
|
"tags": [
|
|
"UserLevelModuleAccesses"
|
|
],
|
|
"summary": "Check user level module access",
|
|
"parameters": [
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.CheckAccessRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-level-module-accesses/module/{module_id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting UserLevelModuleAccesses by Module ID",
|
|
"tags": [
|
|
"UserLevelModuleAccesses"
|
|
],
|
|
"summary": "Get UserLevelModuleAccesses by Module ID",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "Module ID",
|
|
"name": "module_id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-level-module-accesses/user-level/{user_level_id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting UserLevelModuleAccesses by User Level ID",
|
|
"tags": [
|
|
"UserLevelModuleAccesses"
|
|
],
|
|
"summary": "Get UserLevelModuleAccesses by User Level ID",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "User Level ID",
|
|
"name": "user_level_id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-level-module-accesses/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one UserLevelModuleAccess",
|
|
"tags": [
|
|
"UserLevelModuleAccesses"
|
|
],
|
|
"summary": "Get one UserLevelModuleAccess",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "UserLevelModuleAccess ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update UserLevelModuleAccess",
|
|
"tags": [
|
|
"UserLevelModuleAccesses"
|
|
],
|
|
"summary": "Update UserLevelModuleAccess",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserLevelModuleAccessesUpdateRequest"
|
|
}
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "UserLevelModuleAccess ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete UserLevelModuleAccess (soft delete)",
|
|
"tags": [
|
|
"UserLevelModuleAccesses"
|
|
],
|
|
"summary": "Delete UserLevelModuleAccess",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "UserLevelModuleAccess ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-levels": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all UserLevels",
|
|
"tags": [
|
|
"UserLevels"
|
|
],
|
|
"summary": "Get all UserLevels",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "levelNumber",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "name",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "parentLevelId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "provinceId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create UserLevels",
|
|
"tags": [
|
|
"UserLevels"
|
|
],
|
|
"summary": "Create UserLevels",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserLevelsCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-levels/alias/{alias}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one UserLevels",
|
|
"tags": [
|
|
"UserLevels"
|
|
],
|
|
"summary": "Get one UserLevels",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "UserLevels Alias",
|
|
"name": "alias",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-levels/enable-approval": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for Enable Approval of Article",
|
|
"tags": [
|
|
"UserLevels"
|
|
],
|
|
"summary": "EnableApproval Articles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserLevelsApprovalRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-levels/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one UserLevels",
|
|
"tags": [
|
|
"UserLevels"
|
|
],
|
|
"summary": "Get one UserLevels",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "UserLevels ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update UserLevels",
|
|
"tags": [
|
|
"UserLevels"
|
|
],
|
|
"summary": "update UserLevels",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserLevelsUpdateRequest"
|
|
}
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "UserLevels ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete UserLevels",
|
|
"tags": [
|
|
"UserLevels"
|
|
],
|
|
"summary": "delete UserLevels",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "UserLevels ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-role-accesses": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all UserRoleAccesses",
|
|
"tags": [
|
|
"UserRoleAccesses"
|
|
],
|
|
"summary": "Get all UserRoleAccesses",
|
|
"parameters": [
|
|
{
|
|
"type": "boolean",
|
|
"name": "isActive",
|
|
"in": "query",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "menuId",
|
|
"in": "query",
|
|
"required": true
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "userRoleId",
|
|
"in": "query",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create UserRoleAccesses",
|
|
"tags": [
|
|
"UserRoleAccesses"
|
|
],
|
|
"summary": "Create UserRoleAccesses",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserRoleAccessesCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-role-accesses/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one UserRoleAccesses",
|
|
"tags": [
|
|
"UserRoleAccesses"
|
|
],
|
|
"summary": "Get one UserRoleAccesses",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "UserRoleAccesses ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update UserRoleAccesses",
|
|
"tags": [
|
|
"UserRoleAccesses"
|
|
],
|
|
"summary": "update UserRoleAccesses",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserRoleAccessesUpdateRequest"
|
|
}
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "UserRoleAccesses ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete UserRoleAccesses",
|
|
"tags": [
|
|
"UserRoleAccesses"
|
|
],
|
|
"summary": "delete UserRoleAccesses",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "UserRoleAccesses ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-role-level-details": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all UserRoleLevelDetails",
|
|
"tags": [
|
|
"Task"
|
|
],
|
|
"summary": "Get all UserRoleLevelDetails",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create UserRoleLevelDetails",
|
|
"tags": [
|
|
"Task"
|
|
],
|
|
"summary": "Create UserRoleLevelDetails",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-role-level-details/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one UserRoleLevelDetails",
|
|
"tags": [
|
|
"Task"
|
|
],
|
|
"summary": "Get one UserRoleLevelDetails",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "UserRoleLevelDetails ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update UserRoleLevelDetails",
|
|
"tags": [
|
|
"Task"
|
|
],
|
|
"summary": "update UserRoleLevelDetails",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "UserRoleLevelDetails ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete UserRoleLevelDetails",
|
|
"tags": [
|
|
"Task"
|
|
],
|
|
"summary": "delete UserRoleLevelDetails",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "UserRoleLevelDetails ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not Found",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Unprocessable Entity",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-roles": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all UserRoles",
|
|
"tags": [
|
|
"UserRoles"
|
|
],
|
|
"summary": "Get all UserRoles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"name": "code",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "description",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "name",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "statusId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "userLevelId",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create UserRoles",
|
|
"tags": [
|
|
"UserRoles"
|
|
],
|
|
"summary": "Create UserRoles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserRolesCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/user-roles/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one UserRoles",
|
|
"tags": [
|
|
"UserRoles"
|
|
],
|
|
"summary": "Get one UserRoles",
|
|
"parameters": [
|
|
{
|
|
"type": "integer",
|
|
"description": "UserRoles ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update UserRoles",
|
|
"tags": [
|
|
"UserRoles"
|
|
],
|
|
"summary": "update UserRoles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserRolesUpdateRequest"
|
|
}
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "UserRoles ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete UserRoles",
|
|
"tags": [
|
|
"UserRoles"
|
|
],
|
|
"summary": "delete UserRoles",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Insert the X-Csrf-Token",
|
|
"name": "X-Csrf-Token",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "UserRoles ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting all Users",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "Get all Users",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "count",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "limit",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "nextPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "page",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "previousPage",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sort",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"name": "sortBy",
|
|
"in": "query"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"name": "totalPage",
|
|
"in": "query"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for create Users",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "Create Users",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UsersCreateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/check-username/{username}": {
|
|
"get": {
|
|
"description": "API for checking if username exists (returns only exist status)",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "Check if username exists",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"description": "Username to check",
|
|
"name": "username",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/detail/{id}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one Users",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "Get one Users",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Users ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/email-validation": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for Email Validation Users",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "EmailValidation Users",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserEmailValidationRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/forgot-password": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for ForgotPassword Users",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "ForgotPassword Users",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserForgotPassword"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/info": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for ShowUserInfo",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "ShowInfo Users",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/login": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for Login Users",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "Login Users",
|
|
"parameters": [
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserLogin"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/otp-request": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for OtpRequest Users",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "OtpRequest Users",
|
|
"parameters": [
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserOtpRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/otp-validation": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for OtpValidation Users",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "OtpValidation Users",
|
|
"parameters": [
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserOtpValidation"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/pareto-login": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for ParetoLogin Users",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "ParetoLogin Users",
|
|
"parameters": [
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserLogin"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/reset-password": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for ResetPassword Users",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "ResetPassword Users",
|
|
"parameters": [
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserResetPassword"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/save-password": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for SavePassword Users",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "SavePassword Users",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserSavePassword"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/setup-email": {
|
|
"post": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for Setup Email Users",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "SetupEmail Users",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UserEmailValidationRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/username/{username}": {
|
|
"get": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for getting one Users",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "Get one Users",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "string",
|
|
"description": "Username",
|
|
"name": "username",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/users/{id}": {
|
|
"put": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for update Users",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "update Users",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Users ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
},
|
|
{
|
|
"description": "Required payload",
|
|
"name": "payload",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/request.UsersUpdateRequest"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"security": [
|
|
{
|
|
"Bearer": []
|
|
}
|
|
],
|
|
"description": "API for delete Users",
|
|
"tags": [
|
|
"Users"
|
|
],
|
|
"summary": "delete Users",
|
|
"parameters": [
|
|
{
|
|
"type": "string",
|
|
"default": "Bearer \u003cAdd access token here\u003e",
|
|
"description": "Insert your access token",
|
|
"name": "Authorization",
|
|
"in": "header"
|
|
},
|
|
{
|
|
"type": "integer",
|
|
"description": "Users ID",
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.Response"
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Bad Request",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.BadRequestError"
|
|
}
|
|
},
|
|
"401": {
|
|
"description": "Unauthorized",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.UnauthorizedError"
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Internal Server Error",
|
|
"schema": {
|
|
"$ref": "#/definitions/response.InternalServerError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"definitions": {
|
|
"netidhub-saas-be_app_module_article_approval_flows_request.SubmitForApprovalRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"articleId"
|
|
],
|
|
"properties": {
|
|
"articleId": {
|
|
"type": "integer"
|
|
},
|
|
"workflowId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"netidhub-saas-be_app_module_articles_request.SubmitForApprovalRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string",
|
|
"maxLength": 500
|
|
},
|
|
"workflow_id": {
|
|
"type": "integer",
|
|
"minimum": 1
|
|
}
|
|
}
|
|
},
|
|
"paginator.Pagination": {
|
|
"type": "object",
|
|
"properties": {
|
|
"count": {
|
|
"type": "integer"
|
|
},
|
|
"limit": {
|
|
"type": "integer"
|
|
},
|
|
"nextPage": {
|
|
"type": "integer"
|
|
},
|
|
"page": {
|
|
"type": "integer"
|
|
},
|
|
"previousPage": {
|
|
"type": "integer"
|
|
},
|
|
"sort": {
|
|
"type": "string"
|
|
},
|
|
"sortBy": {
|
|
"type": "string"
|
|
},
|
|
"totalPage": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.ActivityLogsCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"activityTypeId",
|
|
"url"
|
|
],
|
|
"properties": {
|
|
"activityTypeId": {
|
|
"type": "integer"
|
|
},
|
|
"articleId": {
|
|
"type": "integer"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "integer"
|
|
},
|
|
"visitorIp": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.ActivityLogsUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"activityTypeId",
|
|
"id",
|
|
"url"
|
|
],
|
|
"properties": {
|
|
"activityTypeId": {
|
|
"type": "integer"
|
|
},
|
|
"articleId": {
|
|
"type": "integer"
|
|
},
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.AdminUserCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"email",
|
|
"fullname",
|
|
"password",
|
|
"username"
|
|
],
|
|
"properties": {
|
|
"address": {
|
|
"type": "string"
|
|
},
|
|
"dateOfBirth": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"fullname": {
|
|
"type": "string"
|
|
},
|
|
"genderType": {
|
|
"type": "string"
|
|
},
|
|
"identityGroup": {
|
|
"type": "string"
|
|
},
|
|
"identityGroupNumber": {
|
|
"type": "string"
|
|
},
|
|
"identityNumber": {
|
|
"type": "string"
|
|
},
|
|
"identityType": {
|
|
"type": "string"
|
|
},
|
|
"lastEducation": {
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"type": "string"
|
|
},
|
|
"phoneNumber": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
},
|
|
"workType": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.AdvertisementCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"description",
|
|
"placement",
|
|
"redirectLink",
|
|
"title"
|
|
],
|
|
"properties": {
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"placement": {
|
|
"type": "string"
|
|
},
|
|
"redirectLink": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.AdvertisementUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"description",
|
|
"id",
|
|
"placement",
|
|
"redirectLink",
|
|
"title"
|
|
],
|
|
"properties": {
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"placement": {
|
|
"type": "string"
|
|
},
|
|
"redirectLink": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.ApprovalActionRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"action"
|
|
],
|
|
"properties": {
|
|
"action": {
|
|
"type": "string",
|
|
"enum": [
|
|
"approve",
|
|
"revision",
|
|
"reject"
|
|
]
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.ApprovalWorkflowStepRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"requiredUserLevelId",
|
|
"stepName",
|
|
"stepOrder"
|
|
],
|
|
"properties": {
|
|
"autoApproveAfterHours": {
|
|
"type": "integer"
|
|
},
|
|
"branchName": {
|
|
"type": "string"
|
|
},
|
|
"branchOrder": {
|
|
"type": "integer"
|
|
},
|
|
"canSkip": {
|
|
"type": "boolean"
|
|
},
|
|
"conditionType": {
|
|
"description": "'user_level', 'user_level_hierarchy', 'always', 'custom'",
|
|
"type": "string"
|
|
},
|
|
"conditionValue": {
|
|
"description": "JSON string for conditions",
|
|
"type": "string"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean"
|
|
},
|
|
"isParallel": {
|
|
"type": "boolean"
|
|
},
|
|
"parentStepId": {
|
|
"description": "Multi-branch support fields",
|
|
"type": "integer"
|
|
},
|
|
"requiredUserLevelId": {
|
|
"type": "integer"
|
|
},
|
|
"stepName": {
|
|
"type": "string"
|
|
},
|
|
"stepOrder": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.ApprovalWorkflowsCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"description",
|
|
"name"
|
|
],
|
|
"properties": {
|
|
"autoPublish": {
|
|
"type": "boolean"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean"
|
|
},
|
|
"isDefault": {
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"requiresApproval": {
|
|
"type": "boolean"
|
|
},
|
|
"steps": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/request.ApprovalWorkflowStepRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"request.ApprovalWorkflowsUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"description",
|
|
"name"
|
|
],
|
|
"properties": {
|
|
"autoPublish": {
|
|
"type": "boolean"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean"
|
|
},
|
|
"isDefault": {
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"requiresApproval": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"request.ApprovalWorkflowsWithStepsCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"description",
|
|
"name",
|
|
"steps"
|
|
],
|
|
"properties": {
|
|
"autoPublish": {
|
|
"type": "boolean"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean"
|
|
},
|
|
"isDefault": {
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"requiresApproval": {
|
|
"type": "boolean"
|
|
},
|
|
"steps": {
|
|
"type": "array",
|
|
"minItems": 1,
|
|
"items": {
|
|
"$ref": "#/definitions/request.ApprovalWorkflowStepRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"request.ApprovalWorkflowsWithStepsUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"description",
|
|
"name",
|
|
"steps"
|
|
],
|
|
"properties": {
|
|
"autoPublish": {
|
|
"type": "boolean"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean"
|
|
},
|
|
"isDefault": {
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"requiresApproval": {
|
|
"type": "boolean"
|
|
},
|
|
"steps": {
|
|
"type": "array",
|
|
"minItems": 1,
|
|
"items": {
|
|
"$ref": "#/definitions/request.ApprovalWorkflowStepRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"request.ArticleApprovalStepLogsCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"approvalStatusId",
|
|
"articleApprovalFlowId",
|
|
"workflowStepId"
|
|
],
|
|
"properties": {
|
|
"approvalStatusId": {
|
|
"type": "integer"
|
|
},
|
|
"approvedAt": {
|
|
"type": "string"
|
|
},
|
|
"approverUserId": {
|
|
"type": "integer"
|
|
},
|
|
"articleApprovalFlowId": {
|
|
"type": "integer"
|
|
},
|
|
"comments": {
|
|
"type": "string",
|
|
"maxLength": 1000
|
|
},
|
|
"dueDate": {
|
|
"type": "string"
|
|
},
|
|
"isAutoApproved": {
|
|
"type": "boolean"
|
|
},
|
|
"workflowStepId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.ArticleApprovalStepLogsUpdateRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"approvalStatusId": {
|
|
"type": "integer"
|
|
},
|
|
"approvedAt": {
|
|
"type": "string"
|
|
},
|
|
"approverUserId": {
|
|
"type": "integer"
|
|
},
|
|
"comments": {
|
|
"type": "string",
|
|
"maxLength": 1000
|
|
},
|
|
"dueDate": {
|
|
"type": "string"
|
|
},
|
|
"isAutoApproved": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"request.ArticleApprovalsCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"articleId",
|
|
"message",
|
|
"statusId"
|
|
],
|
|
"properties": {
|
|
"articleId": {
|
|
"type": "integer"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"statusId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.ArticleApprovalsUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"articleId",
|
|
"id",
|
|
"message",
|
|
"statusId"
|
|
],
|
|
"properties": {
|
|
"articleId": {
|
|
"type": "integer"
|
|
},
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"statusId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.ArticleCategoriesCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"description",
|
|
"statusId",
|
|
"title"
|
|
],
|
|
"properties": {
|
|
"createdById": {
|
|
"type": "integer"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"oldCategoryId": {
|
|
"type": "integer"
|
|
},
|
|
"parentId": {
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"statusId": {
|
|
"type": "integer"
|
|
},
|
|
"tags": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.ArticleCategoriesUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"description",
|
|
"id",
|
|
"statusId",
|
|
"title"
|
|
],
|
|
"properties": {
|
|
"createdById": {
|
|
"type": "integer"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"isPublish": {
|
|
"type": "boolean"
|
|
},
|
|
"parentId": {
|
|
"type": "integer"
|
|
},
|
|
"publishedAt": {
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"statusId": {
|
|
"type": "integer"
|
|
},
|
|
"tags": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.ArticleCommentsApprovalRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"statusId"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"statusId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.ArticleCommentsCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"articleId",
|
|
"message"
|
|
],
|
|
"properties": {
|
|
"articleId": {
|
|
"type": "integer"
|
|
},
|
|
"isPublic": {
|
|
"type": "boolean"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"parentId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.ArticleCommentsUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"articleId",
|
|
"id",
|
|
"message"
|
|
],
|
|
"properties": {
|
|
"articleId": {
|
|
"type": "integer"
|
|
},
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"isPublic": {
|
|
"type": "boolean"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"parentId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.ArticleFilesUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"articleId",
|
|
"id",
|
|
"isPublish",
|
|
"publishedAt",
|
|
"statusId"
|
|
],
|
|
"properties": {
|
|
"articleId": {
|
|
"type": "integer"
|
|
},
|
|
"fileAlt": {
|
|
"type": "string"
|
|
},
|
|
"fileName": {
|
|
"type": "string"
|
|
},
|
|
"filePath": {
|
|
"type": "string"
|
|
},
|
|
"fileThumbnail": {
|
|
"type": "string"
|
|
},
|
|
"fileUrl": {
|
|
"type": "string"
|
|
},
|
|
"heightPixel": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"isPublish": {
|
|
"type": "boolean"
|
|
},
|
|
"publishedAt": {
|
|
"type": "string"
|
|
},
|
|
"size": {
|
|
"type": "string"
|
|
},
|
|
"statusId": {
|
|
"type": "integer"
|
|
},
|
|
"widthPixel": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.ArticleNulisAICreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"articleId",
|
|
"categoryId",
|
|
"creatorId",
|
|
"description",
|
|
"htmlDescription",
|
|
"nulisAiId",
|
|
"tags",
|
|
"title"
|
|
],
|
|
"properties": {
|
|
"articleId": {
|
|
"type": "integer"
|
|
},
|
|
"categoryId": {
|
|
"type": "integer"
|
|
},
|
|
"creatorId": {
|
|
"type": "integer"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"htmlDescription": {
|
|
"type": "string"
|
|
},
|
|
"nulisAiId": {
|
|
"type": "integer"
|
|
},
|
|
"tags": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.ArticleNulisAIUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"articleId",
|
|
"categoryId",
|
|
"creatorId",
|
|
"description",
|
|
"htmlDescription",
|
|
"id",
|
|
"nulisAiId",
|
|
"tags",
|
|
"title"
|
|
],
|
|
"properties": {
|
|
"articleId": {
|
|
"type": "integer"
|
|
},
|
|
"categoryId": {
|
|
"type": "integer"
|
|
},
|
|
"creatorId": {
|
|
"type": "integer"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"htmlDescription": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"nulisAiId": {
|
|
"type": "integer"
|
|
},
|
|
"tags": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
},
|
|
"updated_at": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.ArticlesCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"categoryIds",
|
|
"description",
|
|
"htmlDescription",
|
|
"slug",
|
|
"tags",
|
|
"title",
|
|
"typeId"
|
|
],
|
|
"properties": {
|
|
"aiArticleId": {
|
|
"type": "integer"
|
|
},
|
|
"categoryIds": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"createdById": {
|
|
"type": "integer"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"htmlDescription": {
|
|
"type": "string"
|
|
},
|
|
"isDraft": {
|
|
"type": "boolean"
|
|
},
|
|
"isPublish": {
|
|
"type": "boolean"
|
|
},
|
|
"oldId": {
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"tags": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
},
|
|
"typeId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.ArticlesUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"categoryIds",
|
|
"description",
|
|
"htmlDescription",
|
|
"slug",
|
|
"tags",
|
|
"title",
|
|
"typeId"
|
|
],
|
|
"properties": {
|
|
"aiArticleId": {
|
|
"type": "integer"
|
|
},
|
|
"categoryIds": {
|
|
"type": "string"
|
|
},
|
|
"createdAt": {
|
|
"type": "string"
|
|
},
|
|
"createdById": {
|
|
"type": "integer"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"htmlDescription": {
|
|
"type": "string"
|
|
},
|
|
"isDraft": {
|
|
"type": "boolean"
|
|
},
|
|
"isPublish": {
|
|
"type": "boolean"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"statusId": {
|
|
"type": "integer"
|
|
},
|
|
"tags": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
},
|
|
"typeId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.BookmarksCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"articleId"
|
|
],
|
|
"properties": {
|
|
"articleId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.BulkCreateApprovalWorkflowStepsRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"steps",
|
|
"workflowId"
|
|
],
|
|
"properties": {
|
|
"steps": {
|
|
"type": "array",
|
|
"maxItems": 20,
|
|
"minItems": 1,
|
|
"items": {
|
|
"$ref": "#/definitions/request.CreateApprovalWorkflowStepsRequest"
|
|
}
|
|
},
|
|
"workflowId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.BulkCreateSubClientsRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"parentClientId",
|
|
"subClients"
|
|
],
|
|
"properties": {
|
|
"parentClientId": {
|
|
"type": "string"
|
|
},
|
|
"subClients": {
|
|
"type": "array",
|
|
"minItems": 1,
|
|
"items": {
|
|
"$ref": "#/definitions/request.ClientsCreateSubClientDetail"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"request.BulkProcessApprovalRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"approvalStatusId",
|
|
"logIds",
|
|
"statusId",
|
|
"stepLogIds",
|
|
"userId"
|
|
],
|
|
"properties": {
|
|
"approvalStatusId": {
|
|
"type": "integer"
|
|
},
|
|
"comments": {
|
|
"type": "string",
|
|
"maxLength": 1000
|
|
},
|
|
"logIds": {
|
|
"type": "array",
|
|
"maxItems": 50,
|
|
"minItems": 1,
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"statusId": {
|
|
"type": "integer"
|
|
},
|
|
"stepLogIds": {
|
|
"type": "array",
|
|
"maxItems": 50,
|
|
"minItems": 1,
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"userId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.CheckAccessRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"module_id",
|
|
"user_level_id"
|
|
],
|
|
"properties": {
|
|
"module_id": {
|
|
"type": "integer"
|
|
},
|
|
"user_level_id": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.CitiesCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"city_name",
|
|
"prov_id"
|
|
],
|
|
"properties": {
|
|
"city_name": {
|
|
"type": "string"
|
|
},
|
|
"prov_id": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.CitiesUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"city_name",
|
|
"id",
|
|
"prov_id"
|
|
],
|
|
"properties": {
|
|
"city_name": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"prov_id": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.ClientApprovalSettingsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"approvalExemptCategories": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"approvalExemptRoles": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"approvalExemptUsers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"autoPublishArticles": {
|
|
"type": "boolean"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean"
|
|
},
|
|
"requireApprovalFor": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"requiresApproval": {
|
|
"type": "boolean"
|
|
},
|
|
"skipApprovalFor": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"request.ClientWithUserCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"adminUser",
|
|
"client"
|
|
],
|
|
"properties": {
|
|
"adminUser": {
|
|
"description": "Admin user information",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/request.AdminUserCreateRequest"
|
|
}
|
|
]
|
|
},
|
|
"client": {
|
|
"description": "Client information",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/request.ClientsCreateRequest"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"request.ClientsCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"clientType",
|
|
"name"
|
|
],
|
|
"properties": {
|
|
"clientType": {
|
|
"description": "Enum validation",
|
|
"type": "string",
|
|
"enum": [
|
|
"parent_client",
|
|
"sub_client",
|
|
"standalone"
|
|
]
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"maxStorage": {
|
|
"type": "integer"
|
|
},
|
|
"maxUsers": {
|
|
"description": "Resource limits",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parentClientId": {
|
|
"description": "Optional: only for sub_client type",
|
|
"type": "string"
|
|
},
|
|
"settings": {
|
|
"description": "Custom settings (JSON string)",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.ClientsCreateSubClientDetail": {
|
|
"type": "object",
|
|
"required": [
|
|
"name"
|
|
],
|
|
"properties": {
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"maxStorage": {
|
|
"type": "integer"
|
|
},
|
|
"maxUsers": {
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.ClientsUpdateRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"address": {
|
|
"description": "Alamat",
|
|
"type": "string"
|
|
},
|
|
"clientType": {
|
|
"type": "string",
|
|
"enum": [
|
|
"parent_client",
|
|
"sub_client",
|
|
"standalone"
|
|
]
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean"
|
|
},
|
|
"logoImagePath": {
|
|
"description": "Logo image path in MinIO",
|
|
"type": "string"
|
|
},
|
|
"logoUrl": {
|
|
"description": "Additional tenant information fields",
|
|
"type": "string"
|
|
},
|
|
"maxStorage": {
|
|
"type": "integer"
|
|
},
|
|
"maxUsers": {
|
|
"description": "Resource limits",
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parentClientId": {
|
|
"type": "string"
|
|
},
|
|
"phoneNumber": {
|
|
"description": "Nomor telepon",
|
|
"type": "string"
|
|
},
|
|
"settings": {
|
|
"description": "Custom settings",
|
|
"type": "string"
|
|
},
|
|
"website": {
|
|
"description": "Website resmi",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.CreateApprovalWorkflowStepsRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"approverRoleId",
|
|
"stepName",
|
|
"stepOrder",
|
|
"workflowId"
|
|
],
|
|
"properties": {
|
|
"approverRoleId": {
|
|
"type": "integer"
|
|
},
|
|
"autoApprove": {
|
|
"type": "boolean"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 500
|
|
},
|
|
"isOptional": {
|
|
"type": "boolean"
|
|
},
|
|
"requiresComment": {
|
|
"type": "boolean"
|
|
},
|
|
"stepName": {
|
|
"type": "string",
|
|
"maxLength": 100,
|
|
"minLength": 3
|
|
},
|
|
"stepOrder": {
|
|
"type": "integer",
|
|
"minimum": 1
|
|
},
|
|
"timeoutHours": {
|
|
"type": "integer",
|
|
"maximum": 720,
|
|
"minimum": 1
|
|
},
|
|
"workflowId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.CreateApprovalWorkflowWithClientSettingsRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"clientApprovalSettings",
|
|
"description",
|
|
"name",
|
|
"steps"
|
|
],
|
|
"properties": {
|
|
"autoPublish": {
|
|
"type": "boolean"
|
|
},
|
|
"clientApprovalSettings": {
|
|
"description": "Client approval settings",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/request.ClientApprovalSettingsRequest"
|
|
}
|
|
]
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean"
|
|
},
|
|
"isDefault": {
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Workflow details",
|
|
"type": "string"
|
|
},
|
|
"requiresApproval": {
|
|
"type": "boolean"
|
|
},
|
|
"steps": {
|
|
"type": "array",
|
|
"minItems": 1,
|
|
"items": {
|
|
"$ref": "#/definitions/request.ApprovalWorkflowStepRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"request.CreateClientApprovalSettingsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"approvalExemptCategories": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"approvalExemptRoles": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"approvalExemptUsers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"autoPublishArticles": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultWorkflowId": {
|
|
"type": "integer",
|
|
"minimum": 1
|
|
},
|
|
"isActive": {
|
|
"type": "boolean"
|
|
},
|
|
"requireApprovalFor": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"requiresApproval": {
|
|
"type": "boolean"
|
|
},
|
|
"skipApprovalFor": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"request.CustomStaticPagesCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"htmlBody",
|
|
"slug",
|
|
"title"
|
|
],
|
|
"properties": {
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"htmlBody": {
|
|
"type": "string"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.CustomStaticPagesUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"htmlBody",
|
|
"id",
|
|
"slug",
|
|
"title"
|
|
],
|
|
"properties": {
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"htmlBody": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"slug": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
},
|
|
"updated_at": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.DisableApprovalRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"handleAction",
|
|
"reason"
|
|
],
|
|
"properties": {
|
|
"handleAction": {
|
|
"description": "How to handle pending articles",
|
|
"type": "string",
|
|
"enum": [
|
|
"auto_approve",
|
|
"keep_pending",
|
|
"reset_to_draft"
|
|
]
|
|
},
|
|
"reason": {
|
|
"type": "string",
|
|
"maxLength": 500
|
|
}
|
|
}
|
|
},
|
|
"request.EnableApprovalRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"defaultWorkflowId": {
|
|
"type": "integer",
|
|
"minimum": 1
|
|
},
|
|
"reason": {
|
|
"type": "string",
|
|
"maxLength": 500
|
|
}
|
|
}
|
|
},
|
|
"request.FeedbacksCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"commentFromEmail",
|
|
"commentFromName",
|
|
"message"
|
|
],
|
|
"properties": {
|
|
"commentFromEmail": {
|
|
"type": "string"
|
|
},
|
|
"commentFromName": {
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.FeedbacksUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"commentFromEmail",
|
|
"commentFromName",
|
|
"id",
|
|
"message"
|
|
],
|
|
"properties": {
|
|
"commentFromEmail": {
|
|
"type": "string"
|
|
},
|
|
"commentFromName": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.MagazinesCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"description",
|
|
"statusId",
|
|
"title"
|
|
],
|
|
"properties": {
|
|
"createdById": {
|
|
"type": "integer"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"isPublish": {
|
|
"type": "boolean"
|
|
},
|
|
"pageUrl": {
|
|
"type": "string"
|
|
},
|
|
"publishedAt": {
|
|
"type": "string"
|
|
},
|
|
"statusId": {
|
|
"type": "integer"
|
|
},
|
|
"thumbnailPath": {
|
|
"type": "string"
|
|
},
|
|
"thumbnailUrl": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.MagazinesUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"description",
|
|
"id",
|
|
"statusId",
|
|
"title"
|
|
],
|
|
"properties": {
|
|
"createdById": {
|
|
"type": "integer"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"isPublish": {
|
|
"type": "boolean"
|
|
},
|
|
"pageUrl": {
|
|
"type": "string"
|
|
},
|
|
"publishedAt": {
|
|
"type": "string"
|
|
},
|
|
"statusId": {
|
|
"type": "integer"
|
|
},
|
|
"thumbnailPath": {
|
|
"type": "string"
|
|
},
|
|
"thumbnailUrl": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.MasterMenusCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"description",
|
|
"group",
|
|
"name",
|
|
"statusId"
|
|
],
|
|
"properties": {
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"group": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string"
|
|
},
|
|
"moduleId": {
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parentMenuId": {
|
|
"type": "integer"
|
|
},
|
|
"statusId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.MasterModulesCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"description",
|
|
"name",
|
|
"pathUrl",
|
|
"statusId"
|
|
],
|
|
"properties": {
|
|
"actionType": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"menuIds": {
|
|
"description": "Optional: untuk langsung assign ke menu saat create",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"pathUrl": {
|
|
"type": "string"
|
|
},
|
|
"statusId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.MasterModulesUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"description",
|
|
"id",
|
|
"name",
|
|
"pathUrl",
|
|
"statusId"
|
|
],
|
|
"properties": {
|
|
"actionType": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"menuIds": {
|
|
"description": "Optional: untuk update relasi dengan menu",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"pathUrl": {
|
|
"type": "string"
|
|
},
|
|
"statusId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.MenuActionsBatchCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"actionCodes",
|
|
"menuId"
|
|
],
|
|
"properties": {
|
|
"actionCodes": {
|
|
"type": "array",
|
|
"minItems": 1,
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"clientId": {
|
|
"type": "string"
|
|
},
|
|
"menuId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.MenuActionsCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"actionCode",
|
|
"actionName",
|
|
"menuId"
|
|
],
|
|
"properties": {
|
|
"actionCode": {
|
|
"type": "string"
|
|
},
|
|
"actionName": {
|
|
"type": "string"
|
|
},
|
|
"clientId": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"httpMethod": {
|
|
"type": "string"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean"
|
|
},
|
|
"menuId": {
|
|
"type": "integer"
|
|
},
|
|
"pathUrl": {
|
|
"type": "string"
|
|
},
|
|
"position": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.MenuActionsUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"actionName"
|
|
],
|
|
"properties": {
|
|
"actionCode": {
|
|
"type": "string"
|
|
},
|
|
"actionName": {
|
|
"type": "string"
|
|
},
|
|
"clientId": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"httpMethod": {
|
|
"type": "string"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean"
|
|
},
|
|
"menuId": {
|
|
"type": "integer"
|
|
},
|
|
"pathUrl": {
|
|
"type": "string"
|
|
},
|
|
"position": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.MenuModulesBatchCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"menu_id",
|
|
"module_ids"
|
|
],
|
|
"properties": {
|
|
"client_id": {
|
|
"type": "string"
|
|
},
|
|
"menu_id": {
|
|
"type": "integer"
|
|
},
|
|
"module_ids": {
|
|
"type": "array",
|
|
"minItems": 1,
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"request.MenuModulesCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"menu_id",
|
|
"module_id"
|
|
],
|
|
"properties": {
|
|
"client_id": {
|
|
"type": "string"
|
|
},
|
|
"is_active": {
|
|
"type": "boolean"
|
|
},
|
|
"menu_id": {
|
|
"type": "integer"
|
|
},
|
|
"module_id": {
|
|
"type": "integer"
|
|
},
|
|
"position": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.MenuModulesUpdateRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"client_id": {
|
|
"type": "string"
|
|
},
|
|
"is_active": {
|
|
"type": "boolean"
|
|
},
|
|
"menu_id": {
|
|
"type": "integer"
|
|
},
|
|
"module_id": {
|
|
"type": "integer"
|
|
},
|
|
"position": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.MoveClientRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"targetParentId": {
|
|
"description": "null = move to root (standalone)",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.ProcessApprovalRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"approvalStatusId",
|
|
"statusId",
|
|
"userId"
|
|
],
|
|
"properties": {
|
|
"approvalStatusId": {
|
|
"type": "integer"
|
|
},
|
|
"comments": {
|
|
"type": "string",
|
|
"maxLength": 1000
|
|
},
|
|
"statusId": {
|
|
"type": "integer"
|
|
},
|
|
"userId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.ReorderApprovalWorkflowStepsRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"stepOrders"
|
|
],
|
|
"properties": {
|
|
"stepOrders": {
|
|
"type": "array",
|
|
"minItems": 1,
|
|
"items": {
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"stepOrder"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"stepOrder": {
|
|
"type": "integer",
|
|
"minimum": 1
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"request.ResubmitRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"message": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.SchedulesCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"description",
|
|
"location",
|
|
"speakers",
|
|
"title",
|
|
"typeId"
|
|
],
|
|
"properties": {
|
|
"createdById": {
|
|
"type": "integer"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"endDate": {
|
|
"type": "string"
|
|
},
|
|
"endTime": {
|
|
"type": "string"
|
|
},
|
|
"isLiveStreaming": {
|
|
"type": "boolean"
|
|
},
|
|
"liveStreamingUrl": {
|
|
"type": "string"
|
|
},
|
|
"location": {
|
|
"type": "string"
|
|
},
|
|
"posterImagePath": {
|
|
"type": "string"
|
|
},
|
|
"speakers": {
|
|
"type": "string"
|
|
},
|
|
"startDate": {
|
|
"type": "string"
|
|
},
|
|
"startTime": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
},
|
|
"typeId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.SchedulesUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"description",
|
|
"location",
|
|
"speakers",
|
|
"title",
|
|
"typeId"
|
|
],
|
|
"properties": {
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"endDate": {
|
|
"type": "string"
|
|
},
|
|
"endTime": {
|
|
"type": "string"
|
|
},
|
|
"isLiveStreaming": {
|
|
"type": "boolean"
|
|
},
|
|
"liveStreamingUrl": {
|
|
"type": "string"
|
|
},
|
|
"location": {
|
|
"type": "string"
|
|
},
|
|
"posterImagePath": {
|
|
"type": "string"
|
|
},
|
|
"speakers": {
|
|
"type": "string"
|
|
},
|
|
"startDate": {
|
|
"type": "string"
|
|
},
|
|
"startTime": {
|
|
"type": "string"
|
|
},
|
|
"statusId": {
|
|
"type": "integer"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
},
|
|
"typeId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.SetDefaultWorkflowRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"workflowId": {
|
|
"type": "integer",
|
|
"minimum": 1
|
|
}
|
|
}
|
|
},
|
|
"request.SubscriptionCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"email"
|
|
],
|
|
"properties": {
|
|
"email": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.SubscriptionUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"email",
|
|
"id"
|
|
],
|
|
"properties": {
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.ToggleApprovalRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"requiresApproval": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"request.UpdateApprovalWorkflowStepsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"approverRoleId": {
|
|
"type": "integer"
|
|
},
|
|
"autoApprove": {
|
|
"type": "boolean"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 500
|
|
},
|
|
"isOptional": {
|
|
"type": "boolean"
|
|
},
|
|
"requiresComment": {
|
|
"type": "boolean"
|
|
},
|
|
"stepName": {
|
|
"type": "string",
|
|
"maxLength": 100,
|
|
"minLength": 3
|
|
},
|
|
"stepOrder": {
|
|
"type": "integer",
|
|
"minimum": 1
|
|
},
|
|
"timeoutHours": {
|
|
"type": "integer",
|
|
"maximum": 720,
|
|
"minimum": 1
|
|
}
|
|
}
|
|
},
|
|
"request.UpdateApprovalWorkflowWithClientSettingsRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"name",
|
|
"steps",
|
|
"workflowId"
|
|
],
|
|
"properties": {
|
|
"clientSettings": {
|
|
"description": "Client approval settings",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/request.ClientApprovalSettingsRequest"
|
|
}
|
|
]
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean"
|
|
},
|
|
"isDefault": {
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "Workflow details",
|
|
"type": "string"
|
|
},
|
|
"steps": {
|
|
"description": "Workflow steps",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/request.ApprovalWorkflowStepRequest"
|
|
}
|
|
},
|
|
"workflowId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.UpdateClientApprovalSettingsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"approvalExemptCategories": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"approvalExemptRoles": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"approvalExemptUsers": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"autoPublishArticles": {
|
|
"type": "boolean"
|
|
},
|
|
"defaultWorkflowId": {
|
|
"description": "double pointer to allow nil",
|
|
"type": "integer"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean"
|
|
},
|
|
"requireApprovalFor": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"requiresApproval": {
|
|
"type": "boolean"
|
|
},
|
|
"skipApprovalFor": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"request.UserEmailValidationRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"newEmail": {
|
|
"type": "string"
|
|
},
|
|
"oldEmail": {
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.UserForgotPassword": {
|
|
"type": "object",
|
|
"properties": {
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.UserLevelMenuAccessesBatchCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"menuIds",
|
|
"userLevelId"
|
|
],
|
|
"properties": {
|
|
"clientId": {
|
|
"type": "string"
|
|
},
|
|
"menuIds": {
|
|
"type": "array",
|
|
"minItems": 1,
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"userLevelId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.UserLevelMenuAccessesCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"menuId",
|
|
"userLevelId"
|
|
],
|
|
"properties": {
|
|
"canAccess": {
|
|
"type": "boolean"
|
|
},
|
|
"clientId": {
|
|
"type": "string"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean"
|
|
},
|
|
"menuId": {
|
|
"type": "integer"
|
|
},
|
|
"userLevelId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.UserLevelMenuAccessesUpdateRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"canAccess": {
|
|
"type": "boolean"
|
|
},
|
|
"clientId": {
|
|
"type": "string"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean"
|
|
},
|
|
"menuId": {
|
|
"type": "integer"
|
|
},
|
|
"userLevelId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.UserLevelMenuActionAccessesBatchCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"actionCodes",
|
|
"menuId",
|
|
"userLevelId"
|
|
],
|
|
"properties": {
|
|
"actionCodes": {
|
|
"type": "array",
|
|
"minItems": 1,
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"clientId": {
|
|
"type": "string"
|
|
},
|
|
"menuId": {
|
|
"type": "integer"
|
|
},
|
|
"userLevelId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.UserLevelMenuActionAccessesCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"actionCode",
|
|
"menuId",
|
|
"userLevelId"
|
|
],
|
|
"properties": {
|
|
"actionCode": {
|
|
"type": "string"
|
|
},
|
|
"canAccess": {
|
|
"type": "boolean"
|
|
},
|
|
"clientId": {
|
|
"type": "string"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean"
|
|
},
|
|
"menuId": {
|
|
"type": "integer"
|
|
},
|
|
"userLevelId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.UserLevelMenuActionAccessesUpdateRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"actionCode": {
|
|
"type": "string"
|
|
},
|
|
"canAccess": {
|
|
"type": "boolean"
|
|
},
|
|
"clientId": {
|
|
"type": "string"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean"
|
|
},
|
|
"menuId": {
|
|
"type": "integer"
|
|
},
|
|
"userLevelId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.UserLevelModuleAccessesBatchCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"module_ids",
|
|
"user_level_id"
|
|
],
|
|
"properties": {
|
|
"can_access": {
|
|
"type": "boolean"
|
|
},
|
|
"client_id": {
|
|
"type": "string"
|
|
},
|
|
"module_ids": {
|
|
"type": "array",
|
|
"minItems": 1,
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"user_level_id": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.UserLevelModuleAccessesCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"module_id",
|
|
"user_level_id"
|
|
],
|
|
"properties": {
|
|
"can_access": {
|
|
"type": "boolean"
|
|
},
|
|
"client_id": {
|
|
"type": "string"
|
|
},
|
|
"is_active": {
|
|
"type": "boolean"
|
|
},
|
|
"module_id": {
|
|
"type": "integer"
|
|
},
|
|
"user_level_id": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.UserLevelModuleAccessesUpdateRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"can_access": {
|
|
"type": "boolean"
|
|
},
|
|
"client_id": {
|
|
"type": "string"
|
|
},
|
|
"is_active": {
|
|
"type": "boolean"
|
|
},
|
|
"module_id": {
|
|
"type": "integer"
|
|
},
|
|
"user_level_id": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.UserLevelsApprovalRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"ids",
|
|
"isApprovalActive"
|
|
],
|
|
"properties": {
|
|
"ids": {
|
|
"type": "string"
|
|
},
|
|
"isApprovalActive": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"request.UserLevelsCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"aliasName",
|
|
"levelNumber",
|
|
"name"
|
|
],
|
|
"properties": {
|
|
"aliasName": {
|
|
"type": "string"
|
|
},
|
|
"group": {
|
|
"type": "string"
|
|
},
|
|
"isActive": {
|
|
"type": "boolean"
|
|
},
|
|
"isApprovalActive": {
|
|
"type": "boolean"
|
|
},
|
|
"levelNumber": {
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parentLevelId": {
|
|
"type": "integer"
|
|
},
|
|
"provinceId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.UserLevelsUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"aliasName",
|
|
"levelNumber",
|
|
"name"
|
|
],
|
|
"properties": {
|
|
"aliasName": {
|
|
"type": "string"
|
|
},
|
|
"group": {
|
|
"type": "string"
|
|
},
|
|
"isApprovalActive": {
|
|
"type": "boolean"
|
|
},
|
|
"levelNumber": {
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parentLevelId": {
|
|
"type": "integer"
|
|
},
|
|
"provinceId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.UserLogin": {
|
|
"type": "object",
|
|
"properties": {
|
|
"password": {
|
|
"type": "string"
|
|
},
|
|
"refreshToken": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.UserOtpRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"email"
|
|
],
|
|
"properties": {
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.UserOtpValidation": {
|
|
"type": "object",
|
|
"properties": {
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"otpCode": {
|
|
"type": "string"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.UserResetPassword": {
|
|
"type": "object",
|
|
"properties": {
|
|
"codeRequest": {
|
|
"type": "string"
|
|
},
|
|
"confirmPassword": {
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"type": "string"
|
|
},
|
|
"userId": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.UserRoleAccessesCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"isAdminEnabled",
|
|
"isApprovalEnabled",
|
|
"isDeleteEnabled",
|
|
"isInsertEnabled",
|
|
"isUpdateEnabled",
|
|
"isViewEnabled",
|
|
"menuId"
|
|
],
|
|
"properties": {
|
|
"isAdminEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"isApprovalEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"isDeleteEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"isInsertEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"isUpdateEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"isViewEnabled": {
|
|
"type": "boolean"
|
|
},
|
|
"menuId": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.UserRoleAccessesUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"is_admin_enabled",
|
|
"is_approval_enabled",
|
|
"is_delete_enabled",
|
|
"is_insert_enabled",
|
|
"is_update_enabled",
|
|
"is_view_enabled",
|
|
"menu_id",
|
|
"user_role_id"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "integer"
|
|
},
|
|
"is_admin_enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"is_approval_enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"is_delete_enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"is_insert_enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"is_update_enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"is_view_enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"menu_id": {
|
|
"type": "integer"
|
|
},
|
|
"user_role_id": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
},
|
|
"request.UserRolesCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"code",
|
|
"description",
|
|
"name",
|
|
"statusId",
|
|
"userLevelIds",
|
|
"userRoleAccess"
|
|
],
|
|
"properties": {
|
|
"code": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"statusId": {
|
|
"type": "integer"
|
|
},
|
|
"userLevelIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"userRoleAccess": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/request.UserRoleAccessesCreateRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"request.UserRolesUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"code",
|
|
"description",
|
|
"level_number",
|
|
"name",
|
|
"status_id",
|
|
"userLevelIds"
|
|
],
|
|
"properties": {
|
|
"code": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
},
|
|
"level_number": {
|
|
"type": "integer"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"status_id": {
|
|
"type": "integer"
|
|
},
|
|
"userLevelIds": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"request.UserSavePassword": {
|
|
"type": "object",
|
|
"properties": {
|
|
"confirmPassword": {
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.UsersCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"email",
|
|
"fullname",
|
|
"password",
|
|
"userLevelId",
|
|
"userRoleId",
|
|
"username"
|
|
],
|
|
"properties": {
|
|
"address": {
|
|
"type": "string"
|
|
},
|
|
"clientId": {
|
|
"type": "string"
|
|
},
|
|
"dateOfBirth": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"fullname": {
|
|
"type": "string"
|
|
},
|
|
"genderType": {
|
|
"type": "string"
|
|
},
|
|
"identityGroup": {
|
|
"type": "string"
|
|
},
|
|
"identityGroupNumber": {
|
|
"type": "string"
|
|
},
|
|
"identityNumber": {
|
|
"type": "string"
|
|
},
|
|
"identityType": {
|
|
"type": "string"
|
|
},
|
|
"lastEducation": {
|
|
"type": "string"
|
|
},
|
|
"password": {
|
|
"type": "string"
|
|
},
|
|
"phoneNumber": {
|
|
"type": "string"
|
|
},
|
|
"userLevelId": {
|
|
"type": "integer"
|
|
},
|
|
"userRoleId": {
|
|
"type": "integer"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
},
|
|
"workType": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"request.UsersUpdateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"email",
|
|
"fullname",
|
|
"userLevelId",
|
|
"userRoleId",
|
|
"username"
|
|
],
|
|
"properties": {
|
|
"address": {
|
|
"type": "string"
|
|
},
|
|
"dateOfBirth": {
|
|
"type": "string"
|
|
},
|
|
"email": {
|
|
"type": "string"
|
|
},
|
|
"fullname": {
|
|
"type": "string"
|
|
},
|
|
"genderType": {
|
|
"type": "string"
|
|
},
|
|
"identityGroup": {
|
|
"type": "string"
|
|
},
|
|
"identityGroupNumber": {
|
|
"type": "string"
|
|
},
|
|
"identityNumber": {
|
|
"type": "string"
|
|
},
|
|
"identityType": {
|
|
"type": "string"
|
|
},
|
|
"lastEducation": {
|
|
"type": "string"
|
|
},
|
|
"phoneNumber": {
|
|
"type": "string"
|
|
},
|
|
"statusId": {
|
|
"type": "integer"
|
|
},
|
|
"userLevelId": {
|
|
"type": "integer"
|
|
},
|
|
"userRoleId": {
|
|
"type": "integer"
|
|
},
|
|
"username": {
|
|
"type": "string"
|
|
},
|
|
"workType": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"response.BadRequestError": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"example": 400
|
|
},
|
|
"message": {
|
|
"type": "string",
|
|
"example": "bad request"
|
|
},
|
|
"success": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"response.InternalServerError": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"example": 500
|
|
},
|
|
"message": {
|
|
"type": "string",
|
|
"example": "internal server error"
|
|
},
|
|
"success": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
},
|
|
"response.Response": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"example": 200
|
|
},
|
|
"data": {},
|
|
"messages": {
|
|
"type": "array",
|
|
"items": {}
|
|
},
|
|
"meta": {},
|
|
"success": {
|
|
"type": "boolean",
|
|
"example": true
|
|
}
|
|
}
|
|
},
|
|
"response.UnauthorizedError": {
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"example": 401
|
|
},
|
|
"message": {
|
|
"type": "string",
|
|
"example": "unauthorized access"
|
|
},
|
|
"success": {
|
|
"type": "boolean",
|
|
"example": false
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}`
|
|
|
|
// SwaggerInfo holds exported Swagger Info so clients can modify it
|
|
var SwaggerInfo = &swag.Spec{
|
|
Version: "",
|
|
Host: "",
|
|
BasePath: "",
|
|
Schemes: []string{},
|
|
Title: "",
|
|
Description: "",
|
|
InfoInstanceName: "swagger",
|
|
SwaggerTemplate: docTemplate,
|
|
LeftDelim: "{{",
|
|
RightDelim: "}}",
|
|
}
|
|
|
|
func init() {
|
|
swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
|
|
}
|