ray-template/docs/contracts/admin-api.json

5367 lines
148 KiB
JSON

{
"openapi": "3.1.0",
"info": {
"title": "Ray Admin API",
"version": "1.1.0",
"description": "Mock and real backends share this contract. Route component values are identifiers from the frontend view catalog, never executable code."
},
"servers": [
{
"url": "/ray-template/api",
"description": "Default demo base. Replace with VITE_API_BASE_URL for your backend."
}
],
"components": {
"schemas": {
"UserInput": {
"type": "object",
"properties": {
"username": {
"type": "string",
"maxLength": 32,
"minLength": 2,
"pattern": "^\\S+$"
},
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"email": {
"type": "string",
"maxLength": 120,
"format": "email"
},
"phone": {
"type": "string",
"maxLength": 24,
"pattern": "^[+\\d ()-]*$"
},
"departmentId": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"role": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"status": {
"enum": [
"enabled",
"disabled"
],
"type": "string"
},
"remark": {
"type": "string",
"maxLength": 300
}
},
"required": [
"username",
"name",
"email",
"phone",
"departmentId",
"role",
"status",
"remark"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"User": {
"type": "object",
"properties": {
"username": {
"type": "string",
"maxLength": 32,
"minLength": 2,
"pattern": "^\\S+$"
},
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"email": {
"type": "string",
"maxLength": 120,
"format": "email"
},
"phone": {
"type": "string",
"maxLength": 24,
"pattern": "^[+\\d ()-]*$"
},
"departmentId": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"role": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"status": {
"enum": [
"enabled",
"disabled"
],
"type": "string"
},
"remark": {
"type": "string",
"maxLength": 300
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"createdAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"username",
"name",
"email",
"phone",
"departmentId",
"role",
"status",
"remark",
"id",
"createdAt"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"UserList": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"username": {
"type": "string",
"maxLength": 32,
"minLength": 2,
"pattern": "^\\S+$"
},
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"email": {
"type": "string",
"maxLength": 120,
"format": "email"
},
"phone": {
"type": "string",
"maxLength": 24,
"pattern": "^[+\\d ()-]*$"
},
"departmentId": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"role": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"status": {
"enum": [
"enabled",
"disabled"
],
"type": "string"
},
"remark": {
"type": "string",
"maxLength": 300
},
"id": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"createdAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"username",
"name",
"email",
"phone",
"departmentId",
"role",
"status",
"remark",
"id",
"createdAt"
]
}
},
"total": {
"type": "integer",
"minimum": 0
}
},
"required": [
"items",
"total"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"UserListQuery": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": 1
},
"pageSize": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"name": {
"type": "string",
"maxLength": 60
},
"username": {
"type": "string",
"maxLength": 32
},
"email": {
"type": "string",
"maxLength": 120
},
"departmentId": {
"type": "string",
"maxLength": 80
},
"status": {
"enum": [
"enabled",
"disabled"
],
"type": "string"
},
"role": {
"type": "string",
"maxLength": 80
}
},
"required": [],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"UserOptions": {
"type": "object",
"properties": {
"departments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"labelKey": {
"type": "string"
}
},
"required": [
"id",
"parentId",
"name"
]
}
},
"roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"label": {
"type": "string"
},
"labelKey": {
"type": "string"
},
"disabled": {
"type": "boolean"
}
},
"required": [
"value",
"label"
]
}
}
},
"required": [
"departments",
"roles"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"LoginInput": {
"type": "object",
"properties": {
"username": {
"type": "string",
"maxLength": 80,
"minLength": 1
},
"password": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"required": [
"username",
"password"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"LoginResult": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"avatar": {
"type": "string"
}
},
"required": [
"id",
"username",
"name",
"role"
]
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
},
"expiresAt": {
"type": "string",
"format": "date-time"
},
"accessToken": {
"type": "string",
"minLength": 1
}
},
"required": [
"user",
"permissions",
"expiresAt",
"accessToken"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"BrowserLoginResult": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"avatar": {
"type": "string"
}
},
"required": [
"id",
"username",
"name",
"role"
]
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"user",
"permissions",
"expiresAt"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"Session": {
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"type": "string"
},
"avatar": {
"type": "string"
}
},
"required": [
"id",
"username",
"name",
"role"
]
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
},
"expiresAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"user",
"permissions"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"AccountProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"username": {
"type": "string"
},
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"role": {
"type": "string"
},
"avatar": {
"type": "string"
},
"phone": {
"type": "string",
"maxLength": 24,
"pattern": "^[+\\d ()-]*$"
},
"email": {
"type": "string",
"maxLength": 120,
"format": "email"
},
"department": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"labelKey": {
"type": "string"
}
},
"required": [
"id",
"parentId",
"name"
]
}
},
"required": [
"id",
"username",
"name",
"role",
"phone",
"email",
"department"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"ProfileInput": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"phone": {
"type": "string",
"maxLength": 24,
"pattern": "^[+\\d ()-]*$"
}
},
"required": [
"name",
"phone"
],
"additionalProperties": false,
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"ChangePassword": {
"type": "object",
"properties": {
"currentPassword": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"newPassword": {
"type": "string",
"minLength": 12,
"maxLength": 128
}
},
"required": [
"currentPassword",
"newPassword"
],
"additionalProperties": false,
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"CredentialInput": {
"type": "object",
"properties": {
"newPassword": {
"type": "string",
"minLength": 12,
"maxLength": 128
}
},
"required": [
"newPassword"
],
"additionalProperties": false,
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"Ids": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"maxItems": 500
}
},
"required": [
"ids"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"StatusInput": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 1,
"maxItems": 500
},
"status": {
"enum": [
"enabled",
"disabled"
],
"type": "string"
}
},
"required": [
"ids",
"status"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"Changed": {
"type": "object",
"properties": {
"affected": {
"type": "integer",
"minimum": 0
}
},
"required": [
"affected"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"RouteConfig": {
"type": "object",
"properties": {
"version": {
"const": 1
},
"routes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^\\/?(?:[\\w~.-]+|:[A-Za-z_]\\w*\\??)(?:\\/(?:[\\w~.-]+|:[A-Za-z_]\\w*\\??))*$",
"description": "Absolute or relative child path. Supports named and optional parameters."
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^[A-Za-z_][\\w.-]*$",
"description": "Unique Vue Router name. Required for keepAlive."
},
"component": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "Registered view ID. Use layout for a menu group."
},
"alias": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^\\/(?:[\\w~.-]+|:[A-Za-z_]\\w*\\??)(?:\\/(?:[\\w~.-]+|:[A-Za-z_]\\w*\\??))*$"
},
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^\\/(?:[\\w~.-]+|:[A-Za-z_]\\w*\\??)(?:\\/(?:[\\w~.-]+|:[A-Za-z_]\\w*\\??))*$"
},
"minItems": 1,
"maxItems": 16
}
],
"description": "Absolute alternative path(s) for a leaf."
},
"redirect": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^\\/(?:[\\w~.-]+|:[A-Za-z_]\\w*\\??)(?:\\/(?:[\\w~.-]+|:[A-Za-z_]\\w*\\??))*$",
"description": "Absolute path of another configured page."
},
"props": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "object",
"propertyNames": {
"not": {
"pattern": "^(?:[oO][nN]|innerHTML$|outerHTML$|srcdoc$|__proto__$|constructor$|prototype$)"
}
},
"additionalProperties": {}
}
],
"description": "Pass route params (true) or a JSON object to the view."
},
"meta": {
"type": "object",
"properties": {
"i18nKey": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "Translation key for the menu title."
},
"noLocalTitle": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256
},
{
"type": "number"
}
],
"description": "Literal title if i18nKey is absent."
},
"icon": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^[\\w-]+\\/[\\w-]+$",
"description": "IconName from src/icons/manifest.ts."
},
"role": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256
},
{
"type": "number"
}
]
},
"maxItems": 32,
"description": "Allowed roles. Omitted or empty means any authenticated role."
},
"hidden": {
"type": "boolean",
"description": "Hide from the menu. Direct navigation still uses the role guard."
},
"sameLevel": {
"type": "boolean",
"description": "Append a breadcrumb without replacing the current tab."
},
"order": {
"type": "number",
"description": "Menu sort order at the top level."
},
"env": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256
},
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"maxItems": 16
}
],
"description": "Vite mode(s) in which the menu item is visible."
},
"windowOpen": {
"type": "string",
"maxLength": 2048,
"pattern": "^[Hh][Tt][Tt][Pp][Ss]?:\\/\\/",
"description": "Open this HTTP(S) URL in a new tab."
},
"ignoreAutoResetScroll": {
"type": "boolean",
"description": "Keep the content scroll position on navigation."
},
"keepAlive": {
"type": "boolean",
"description": "Keep the view mounted. name must match the registered view name."
},
"extra": {
"type": "object",
"properties": {
"label": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256
},
{
"type": "number"
}
]
},
"i18nLabel": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"icon": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^[\\w-]+\\/[\\w-]+$"
},
"show": {
"type": "boolean"
},
"type": {
"enum": [
"default",
"primary",
"info",
"success",
"warning",
"error"
],
"type": "string"
}
},
"required": [],
"additionalProperties": false,
"description": "Optional menu badge."
}
},
"required": [],
"additionalProperties": false
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RouteConfig/$defs/0"
},
"minItems": 1,
"maxItems": 300
}
},
"required": [
"path",
"meta"
],
"additionalProperties": false
},
"maxItems": 300
}
},
"required": [
"version",
"routes"
],
"additionalProperties": false,
"title": "Ray Template route configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$defs": {
"0": {
"type": "object",
"properties": {
"path": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^\\/?(?:[\\w~.-]+|:[A-Za-z_]\\w*\\??)(?:\\/(?:[\\w~.-]+|:[A-Za-z_]\\w*\\??))*$",
"description": "Absolute or relative child path. Supports named and optional parameters."
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^[A-Za-z_][\\w.-]*$",
"description": "Unique Vue Router name. Required for keepAlive."
},
"component": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "Registered view ID. Use layout for a menu group."
},
"alias": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^\\/(?:[\\w~.-]+|:[A-Za-z_]\\w*\\??)(?:\\/(?:[\\w~.-]+|:[A-Za-z_]\\w*\\??))*$"
},
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^\\/(?:[\\w~.-]+|:[A-Za-z_]\\w*\\??)(?:\\/(?:[\\w~.-]+|:[A-Za-z_]\\w*\\??))*$"
},
"minItems": 1,
"maxItems": 16
}
],
"description": "Absolute alternative path(s) for a leaf."
},
"redirect": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^\\/(?:[\\w~.-]+|:[A-Za-z_]\\w*\\??)(?:\\/(?:[\\w~.-]+|:[A-Za-z_]\\w*\\??))*$",
"description": "Absolute path of another configured page."
},
"props": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "object",
"propertyNames": {
"not": {
"pattern": "^(?:[oO][nN]|innerHTML$|outerHTML$|srcdoc$|__proto__$|constructor$|prototype$)"
}
},
"additionalProperties": {}
}
],
"description": "Pass route params (true) or a JSON object to the view."
},
"meta": {
"type": "object",
"properties": {
"i18nKey": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "Translation key for the menu title."
},
"noLocalTitle": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256
},
{
"type": "number"
}
],
"description": "Literal title if i18nKey is absent."
},
"icon": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^[\\w-]+\\/[\\w-]+$",
"description": "IconName from src/icons/manifest.ts."
},
"role": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256
},
{
"type": "number"
}
]
},
"maxItems": 32,
"description": "Allowed roles. Omitted or empty means any authenticated role."
},
"hidden": {
"type": "boolean",
"description": "Hide from the menu. Direct navigation still uses the role guard."
},
"sameLevel": {
"type": "boolean",
"description": "Append a breadcrumb without replacing the current tab."
},
"order": {
"type": "number",
"description": "Menu sort order at the top level."
},
"env": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256
},
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"maxItems": 16
}
],
"description": "Vite mode(s) in which the menu item is visible."
},
"windowOpen": {
"type": "string",
"maxLength": 2048,
"pattern": "^[Hh][Tt][Tt][Pp][Ss]?:\\/\\/",
"description": "Open this HTTP(S) URL in a new tab."
},
"ignoreAutoResetScroll": {
"type": "boolean",
"description": "Keep the content scroll position on navigation."
},
"keepAlive": {
"type": "boolean",
"description": "Keep the view mounted. name must match the registered view name."
},
"extra": {
"type": "object",
"properties": {
"label": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256
},
{
"type": "number"
}
]
},
"i18nLabel": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"icon": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^[\\w-]+\\/[\\w-]+$"
},
"show": {
"type": "boolean"
},
"type": {
"enum": [
"default",
"primary",
"info",
"success",
"warning",
"error"
],
"type": "string"
}
},
"required": [],
"additionalProperties": false,
"description": "Optional menu badge."
}
},
"required": [],
"additionalProperties": false
},
"children": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RouteConfig/$defs/0"
},
"minItems": 1,
"maxItems": 300
}
},
"required": [
"path",
"meta"
],
"additionalProperties": false
}
}
},
"DemoCharts": {
"type": "object",
"properties": {
"days": {
"type": "array",
"items": {
"type": "string"
}
},
"orders": {
"type": "array",
"items": {
"type": "number"
}
},
"visits": {
"type": "array",
"items": {
"type": "number"
}
},
"sources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "number"
}
},
"required": [
"key",
"value"
]
}
},
"lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"name",
"values"
]
}
}
},
"required": [
"days",
"orders",
"visits",
"sources",
"lines"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"DemoPeople": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"age": {
"type": "number"
},
"address": {
"type": "string"
},
"createDate": {
"type": "string"
},
"email": {
"type": "string"
}
},
"required": [
"id",
"name",
"age",
"address",
"createDate",
"email"
]
}
},
"total": {
"type": "integer",
"minimum": 0
}
},
"required": [
"items",
"total"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"DemoRequest": {
"type": "object",
"properties": {
"ticket": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"id",
"title",
"status"
]
},
"cities": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"temperature": {
"type": "number"
},
"humidity": {
"type": "number"
}
},
"required": [
"temperature",
"humidity"
]
}
}
},
"required": [
"ticket",
"cities"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"DemoOrders": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number"
},
"orderNo": {
"type": "string"
},
"productId": {
"type": "string"
},
"status": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"orgId": {
"type": "string"
},
"ownerId": {
"type": "string"
},
"warehouseId": {
"type": "string"
},
"amount": {
"type": "number"
},
"invoiced": {
"type": "boolean"
},
"delivery": {
"type": "string"
},
"deliveryAt": {
"type": "number"
},
"deliveryTime": {
"type": "string"
},
"product": {
"type": "string"
},
"statusLabel": {
"type": "string"
},
"organization": {
"type": "string"
},
"owner": {
"type": "string"
},
"warehouse": {
"type": "string"
},
"deliveryLabel": {
"type": "string"
}
},
"required": [
"id",
"orderNo",
"productId",
"status",
"createdAt",
"orgId",
"ownerId",
"warehouseId",
"amount",
"invoiced",
"delivery",
"deliveryAt",
"deliveryTime",
"product",
"statusLabel",
"organization",
"owner",
"warehouse",
"deliveryLabel"
]
}
},
"total": {
"type": "integer",
"minimum": 0
}
},
"required": [
"items",
"total"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"DemoOwners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"label": {
"type": "string"
}
},
"required": [
"value",
"label"
]
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"DemoOrderQuery": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": 1
},
"pageSize": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"keyword": {
"type": "string",
"maxLength": 120
},
"status": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 80
}
},
{
"type": "null"
}
]
},
"createdFrom": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"createdTo": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
]
},
"orgId": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "null"
}
]
},
"ownerId": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "null"
}
]
},
"productId": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "null"
}
]
},
"warehouseId": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "null"
}
]
},
"minAmount": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"invoiced": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"delivery": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "null"
}
]
},
"deliveryFrom": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"deliveryTo": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"deliveryTime": {
"anyOf": [
{
"type": "string",
"format": "time"
},
{
"type": "null"
}
]
}
},
"required": []
},
"locale": {
"type": "string"
},
"fail": {
"type": "boolean"
}
},
"required": [
"query",
"locale"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"DemoOwnerQuery": {
"type": "object",
"properties": {
"orgId": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"keyword": {
"type": "string",
"maxLength": 120
},
"locale": {
"type": "string"
},
"fail": {
"type": "boolean"
}
},
"required": [
"orgId",
"keyword",
"locale"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"DemoPeopleQuery": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": 1
},
"pageSize": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"name": {
"type": "string",
"maxLength": 80
},
"email": {
"type": "string",
"maxLength": 120
},
"sortAge": {
"enum": [
"ascend",
"descend"
],
"type": "string"
},
"fail": {
"type": "boolean"
}
},
"required": [],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"DemoChartsQuery": {
"type": "object",
"properties": {
"refresh": {
"type": "boolean"
}
},
"required": [],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"DemoSearchOptionsQuery": {
"type": "object",
"properties": {
"locale": {
"type": "string"
}
},
"required": [],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"DemoSearchOptions": {
"type": "object",
"properties": {
"statuses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"label": {
"type": "string"
}
},
"required": [
"value",
"label"
]
}
},
"organizations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"label": {
"type": "string"
}
},
"required": [
"value",
"label"
]
}
},
"productCategories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"label": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"label": {
"type": "string"
}
},
"required": [
"value",
"label"
]
}
}
},
"required": [
"value",
"label",
"children"
]
}
},
"warehouseRegions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"label": {
"type": "string"
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"label": {
"type": "string"
}
},
"required": [
"value",
"label"
]
}
}
},
"required": [
"value",
"label",
"children"
]
}
},
"deliveries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"label": {
"type": "string"
}
},
"required": [
"value",
"label"
]
}
}
},
"required": [
"statuses",
"organizations",
"productCategories",
"warehouseRegions",
"deliveries"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"DemoRoutePerson": {
"type": "object",
"properties": {
"key": {
"type": "integer",
"minimum": 0
},
"name": {
"type": "string"
},
"address": {
"type": "string"
},
"phone": {
"type": "string"
}
},
"required": [
"key",
"name",
"address",
"phone"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"DemoRoutePeopleQuery": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"minimum": 1
},
"pageSize": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"name": {
"type": "string",
"maxLength": 80
}
},
"required": [],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"DemoRoutePeople": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "integer",
"minimum": 0
},
"name": {
"type": "string"
},
"address": {
"type": "string"
},
"phone": {
"type": "string"
}
},
"required": [
"key",
"name",
"address",
"phone"
]
}
},
"total": {
"type": "integer",
"minimum": 0
}
},
"required": [
"items",
"total"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
},
"Error": {
"type": "object",
"properties": {
"code": {
"type": "number"
},
"msg": {
"type": "string"
},
"data": {
"type": "null"
},
"error": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"fields": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"key"
]
}
},
"required": [
"code",
"msg",
"data"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}
},
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer"
},
"browserSession": {
"type": "apiKey",
"in": "cookie",
"name": "__Host-ray-session",
"description": "Bundled server only. Send X-Ray-Session: cookie on same-origin requests. Loopback HTTP uses ray-session."
}
}
},
"paths": {
"/admin/demo/people": {
"get": {
"operationId": "getDemoPeople",
"summary": "getDemoPeople",
"description": "Public endpoint.",
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/DemoPeople"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "pageSize",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "name",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 80
}
},
{
"name": "email",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 120
}
},
{
"name": "sortAge",
"in": "query",
"required": false,
"schema": {
"enum": [
"ascend",
"descend"
],
"type": "string"
}
},
{
"name": "fail",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
}
]
}
},
"/admin/demo/route-people": {
"get": {
"operationId": "getRouteDemoPeople",
"summary": "getRouteDemoPeople",
"description": "Public endpoint.",
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/DemoRoutePeople"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "pageSize",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "name",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 80
}
}
]
}
},
"/admin/demo/route-people/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 0
}
}
],
"get": {
"operationId": "getRouteDemoPerson",
"summary": "getRouteDemoPerson",
"description": "Public endpoint.",
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/DemoRoutePerson"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/admin/demo/search-options": {
"get": {
"operationId": "getSearchOptions",
"summary": "getSearchOptions",
"description": "Public endpoint.",
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/DemoSearchOptions"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "locale",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
}
]
}
},
"/admin/demo/request": {
"get": {
"operationId": "getRequestFixture",
"summary": "getRequestFixture",
"description": "Public endpoint.",
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/DemoRequest"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/admin/demo/charts": {
"get": {
"operationId": "getDemoCharts",
"summary": "getDemoCharts",
"description": "Public endpoint.",
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/DemoCharts"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "refresh",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
}
]
}
},
"/admin/demo/orders/search": {
"post": {
"operationId": "searchDemoOrders",
"summary": "searchDemoOrders",
"description": "Public endpoint.",
"security": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DemoOrderQuery"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/DemoOrders"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/admin/demo/owners/search": {
"post": {
"operationId": "searchDemoOwners",
"summary": "searchDemoOwners",
"description": "Public endpoint.",
"security": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DemoOwnerQuery"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/DemoOwners"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/admin/auth/login": {
"post": {
"operationId": "login",
"summary": "login",
"description": "Returns a Bearer token by default. The bundled server omits it and sets an HttpOnly cookie when X-Ray-Session is cookie.",
"security": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginInput"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"anyOf": [
{
"$ref": "#/components/schemas/LoginResult"
},
{
"$ref": "#/components/schemas/BrowserLoginResult"
}
]
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "X-Ray-Session",
"in": "header",
"schema": {
"const": "cookie"
}
}
]
}
},
"/admin/auth/session": {
"get": {
"operationId": "getSession",
"summary": "getSession",
"description": "Requires an active session.",
"security": [
{
"bearerAuth": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/Session"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/admin/auth/logout": {
"post": {
"operationId": "logout",
"summary": "logout",
"description": "Requires an active session.",
"security": [
{
"bearerAuth": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"type": "null"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/admin/auth/profile": {
"get": {
"operationId": "getProfile",
"summary": "getProfile",
"description": "Requires an active session.",
"security": [
{
"bearerAuth": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/AccountProfile"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"patch": {
"operationId": "updateProfile",
"summary": "updateProfile",
"description": "Requires an active session.",
"security": [
{
"bearerAuth": []
},
{
"browserSession": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfileInput"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/AccountProfile"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/admin/auth/password": {
"patch": {
"operationId": "changePassword",
"summary": "changePassword",
"description": "Requires an active session.",
"security": [
{
"bearerAuth": []
},
{
"browserSession": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangePassword"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"type": "null"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/admin/route-config": {
"get": {
"operationId": "getRouteConfig",
"summary": "getRouteConfig",
"description": "Authorized navigation snapshot for the current session; returns an empty routes array without routes:read. Request view=editor with routes:write to read the complete saved configuration.",
"security": [
{
"bearerAuth": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/RouteConfig"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "view",
"in": "query",
"required": false,
"schema": {
"const": "editor"
}
}
]
},
"put": {
"operationId": "updateRouteConfig",
"summary": "updateRouteConfig",
"description": "Required permission: routes:write.",
"security": [
{
"bearerAuth": []
},
{
"browserSession": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RouteConfig"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/RouteConfig"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/admin/users/options": {
"get": {
"operationId": "getUserOptions",
"summary": "getUserOptions",
"description": "Required permission: users:read.",
"security": [
{
"bearerAuth": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/UserOptions"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/admin/users/{id}/credential": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"put": {
"operationId": "setUserCredential",
"summary": "setUserCredential",
"description": "Required permission: users:credentials.",
"security": [
{
"bearerAuth": []
},
{
"browserSession": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CredentialInput"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"type": "null"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/admin/users": {
"get": {
"operationId": "listUsers",
"summary": "listUsers",
"description": "Required permission: users:read.",
"security": [
{
"bearerAuth": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/UserList"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1
}
},
{
"name": "pageSize",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
{
"name": "name",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 60
}
},
{
"name": "username",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 32
}
},
{
"name": "email",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 120
}
},
{
"name": "departmentId",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 80
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"enum": [
"enabled",
"disabled"
],
"type": "string"
}
},
{
"name": "role",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 80
}
}
]
},
"post": {
"operationId": "createUser",
"summary": "createUser",
"description": "Required permission: users:create.",
"security": [
{
"bearerAuth": []
},
{
"browserSession": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserInput"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/User"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/admin/users/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"get": {
"operationId": "getUser",
"summary": "getUser",
"description": "Required permission: users:read.",
"security": [
{
"bearerAuth": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/User"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"put": {
"operationId": "updateUser",
"summary": "updateUser",
"description": "Required permission: users:update.",
"security": [
{
"bearerAuth": []
},
{
"browserSession": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserInput"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/User"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/admin/users/batch-delete": {
"post": {
"operationId": "deleteUsers",
"summary": "deleteUsers",
"description": "Required permission: users:delete.",
"security": [
{
"bearerAuth": []
},
{
"browserSession": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Ids"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/Changed"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/admin/users/status": {
"patch": {
"operationId": "updateUserStatus",
"summary": "updateUserStatus",
"description": "Required permission: users:status.",
"security": [
{
"bearerAuth": []
},
{
"browserSession": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusInput"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/Changed"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/admin/users/reset": {
"post": {
"operationId": "resetDemoUsers",
"summary": "resetDemoUsers",
"description": "Required permission: users:reset.",
"security": [
{
"bearerAuth": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"msg",
"data"
],
"properties": {
"code": {
"const": 200
},
"msg": {
"type": "string"
},
"data": {
"$ref": "#/components/schemas/Changed"
}
}
}
}
}
},
"400": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "See error.key for a stable machine-readable reason.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
}
}
}