# Generated with protoc-gen-openapi # https://github.com/google/gnostic/tree/master/cmd/protoc-gen-openapi openapi: 3.0.3 info: title: "" version: 0.0.1 paths: /action/create: post: tags: - Auth description: |- ==================== Action CRUD ==================== Conditional: enable_action operationId: Auth_CreateAction requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.v1.CreateActionRequest' required: true responses: "200": description: OK content: {} /action/delete: delete: tags: - Auth operationId: Auth_DeleteAction parameters: - name: ids in: query schema: type: string responses: "200": description: OK content: {} /action/list: get: tags: - Auth operationId: Auth_FindAction parameters: - name: page.num in: query schema: type: string - name: page.size in: query schema: type: string - name: page.total in: query schema: type: string - name: page.disable in: query schema: type: boolean - name: code in: query schema: type: string - name: name in: query schema: type: string - name: word in: query schema: type: string - name: resource in: query schema: type: string - name: menu in: query schema: type: string - name: btn in: query schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/auth.v1.FindActionReply' /action/update: put: tags: - Auth operationId: Auth_UpdateAction requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.v1.UpdateActionRequest' required: true responses: "200": description: OK content: {} patch: tags: - Auth operationId: Auth_UpdateAction requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.v1.UpdateActionRequest' required: true responses: "200": description: OK content: {} /healthz: get: tags: - Health operationId: Health_Check responses: "200": description: OK content: {} /info: get: tags: - Auth operationId: Auth_Info responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/auth.v1.InfoReply' /logout: post: tags: - Auth operationId: Auth_Logout requestBody: content: application/json: {} required: true responses: "200": description: OK content: {} /permission: get: tags: - Auth description: Permission is used by nginx auth_request and the local permission middleware. operationId: Auth_Permission parameters: - name: resource in: query schema: type: string - name: method in: query schema: type: string - name: uri in: query schema: type: string responses: "200": description: OK content: {} /pub/captcha: get: tags: - Auth description: 'Conditional: enable_captcha' operationId: Auth_Captcha responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/auth.v1.CaptchaReply' /pub/login: post: tags: - Auth operationId: Auth_Login requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.v1.LoginRequest' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/auth.v1.LoginReply' /pub/register: post: tags: - Auth description: ==================== Auth (Public) ==================== operationId: Auth_Register requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.v1.RegisterRequest' required: true responses: "200": description: OK content: {} /pub/status: get: tags: - Auth operationId: Auth_Status parameters: - name: username in: query schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/auth.v1.StatusReply' /pwd/update: patch: tags: - Auth description: ==================== Auth (Private) ==================== operationId: Auth_Pwd requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.v1.PwdRequest' required: true responses: "200": description: OK content: {} /refresh: post: tags: - Auth operationId: Auth_Refresh requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.v1.RefreshRequest' required: true responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/auth.v1.LoginReply' /role/create: post: tags: - Auth description: ==================== Role CRUD ==================== operationId: Auth_CreateRole requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.v1.CreateRoleRequest' required: true responses: "200": description: OK content: {} /role/delete: delete: tags: - Auth operationId: Auth_DeleteRole parameters: - name: ids in: query schema: type: string responses: "200": description: OK content: {} /role/list: get: tags: - Auth operationId: Auth_FindRole parameters: - name: page.num in: query schema: type: string - name: page.size in: query schema: type: string - name: page.total in: query schema: type: string - name: page.disable in: query schema: type: boolean - name: name in: query schema: type: string - name: word in: query schema: type: string - name: action in: query schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/auth.v1.FindRoleReply' /role/update: put: tags: - Auth operationId: Auth_UpdateRole requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.v1.UpdateRoleRequest' required: true responses: "200": description: OK content: {} patch: tags: - Auth operationId: Auth_UpdateRole requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.v1.UpdateRoleRequest' required: true responses: "200": description: OK content: {} /user/delete: delete: tags: - Auth operationId: Auth_DeleteUser parameters: - name: ids in: query schema: type: string responses: "200": description: OK content: {} /user/group/create: post: tags: - Auth description: |- ==================== UserGroup CRUD ==================== Conditional: enable_user_group operationId: Auth_CreateUserGroup requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.v1.CreateUserGroupRequest' required: true responses: "200": description: OK content: {} /user/group/delete: delete: tags: - Auth operationId: Auth_DeleteUserGroup parameters: - name: ids in: query schema: type: string responses: "200": description: OK content: {} /user/group/list: get: tags: - Auth operationId: Auth_FindUserGroup parameters: - name: page.num in: query schema: type: string - name: page.size in: query schema: type: string - name: page.total in: query schema: type: string - name: page.disable in: query schema: type: boolean - name: name in: query schema: type: string - name: word in: query schema: type: string - name: action in: query schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/auth.v1.FindUserGroupReply' /user/group/update: put: tags: - Auth operationId: Auth_UpdateUserGroup requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.v1.UpdateUserGroupRequest' required: true responses: "200": description: OK content: {} patch: tags: - Auth operationId: Auth_UpdateUserGroup requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.v1.UpdateUserGroupRequest' required: true responses: "200": description: OK content: {} /user/list: get: tags: - Auth description: ==================== User CRUD ==================== operationId: Auth_FindUser parameters: - name: page.num in: query schema: type: string - name: page.size in: query schema: type: string - name: page.total in: query schema: type: string - name: page.disable in: query schema: type: boolean - name: startCreatedAt in: query schema: type: string - name: endCreatedAt in: query schema: type: string - name: startUpdatedAt in: query schema: type: string - name: endUpdatedAt in: query schema: type: string - name: username in: query schema: type: string - name: code in: query schema: type: string - name: platform in: query schema: type: string - name: locked in: query schema: type: boolean responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/auth.v1.FindUserReply' /user/update: put: tags: - Auth operationId: Auth_UpdateUser requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.v1.UpdateUserRequest' required: true responses: "200": description: OK content: {} patch: tags: - Auth operationId: Auth_UpdateUser requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.v1.UpdateUserRequest' required: true responses: "200": description: OK content: {} /whitelist/create: post: tags: - Auth description: |- ==================== Whitelist CRUD ==================== Conditional: enable_whitelist operationId: Auth_CreateWhitelist requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.v1.CreateWhitelistRequest' required: true responses: "200": description: OK content: {} /whitelist/delete: delete: tags: - Auth operationId: Auth_DeleteWhitelist parameters: - name: ids in: query schema: type: string responses: "200": description: OK content: {} /whitelist/list: get: tags: - Auth operationId: Auth_FindWhitelist parameters: - name: page.num in: query schema: type: string - name: page.size in: query schema: type: string - name: page.total in: query schema: type: string - name: page.disable in: query schema: type: boolean - name: category in: query schema: type: integer format: int32 - name: resource in: query schema: type: string responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/auth.v1.FindWhitelistReply' /whitelist/update: put: tags: - Auth operationId: Auth_UpdateWhitelist requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.v1.UpdateWhitelistRequest' required: true responses: "200": description: OK content: {} patch: tags: - Auth operationId: Auth_UpdateWhitelist requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.v1.UpdateWhitelistRequest' required: true responses: "200": description: OK content: {} components: schemas: auth.v1.Action: type: object properties: id: type: string code: type: string name: type: string word: type: string resource: type: string menu: type: string btn: type: string children: type: array items: $ref: '#/components/schemas/auth.v1.Action' description: 'Optional: tree structure when actions are returned hierarchically.' auth.v1.Captcha: type: object properties: id: type: string img: type: string auth.v1.CaptchaReply: type: object properties: captcha: $ref: '#/components/schemas/auth.v1.Captcha' auth.v1.CreateActionRequest: type: object properties: name: type: string word: type: string resource: type: string menu: type: string btn: type: string auth.v1.CreateRoleRequest: type: object properties: name: type: string word: type: string action: type: string auth.v1.CreateUserGroupRequest: type: object properties: users: type: array items: type: string name: type: string word: type: string action: type: string auth.v1.CreateWhitelistRequest: type: object properties: category: type: integer format: int32 resource: type: string auth.v1.FindActionReply: type: object properties: page: $ref: '#/components/schemas/params.Page' list: type: array items: $ref: '#/components/schemas/auth.v1.Action' auth.v1.FindRoleReply: type: object properties: page: $ref: '#/components/schemas/params.Page' list: type: array items: $ref: '#/components/schemas/auth.v1.Role' auth.v1.FindUserGroupReply: type: object properties: page: $ref: '#/components/schemas/params.Page' list: type: array items: $ref: '#/components/schemas/auth.v1.UserGroup' auth.v1.FindUserReply: type: object properties: page: $ref: '#/components/schemas/params.Page' list: type: array items: $ref: '#/components/schemas/auth.v1.User' auth.v1.FindWhitelistReply: type: object properties: page: $ref: '#/components/schemas/params.Page' list: type: array items: $ref: '#/components/schemas/auth.v1.Whitelist' auth.v1.InfoReply: type: object properties: id: type: string username: type: string code: type: string platform: type: string permission: $ref: '#/components/schemas/auth.v1.Permission' auth.v1.LoginReply: type: object properties: token: type: string expires: type: string auth.v1.LoginRequest: type: object properties: username: type: string password: type: string platform: type: string captchaId: type: string captchaAnswer: type: string auth.v1.Permission: type: object properties: resources: type: array items: type: string menus: type: array items: type: string btns: type: array items: type: string auth.v1.PwdRequest: type: object properties: username: type: string oldPassword: type: string newPassword: type: string auth.v1.RefreshRequest: type: object properties: token: type: string auth.v1.RegisterRequest: type: object properties: username: type: string password: type: string platform: type: string captchaId: type: string captchaAnswer: type: string auth.v1.Role: type: object properties: id: type: string name: type: string word: type: string action: type: string description: Comma-separated action codes. actions: type: array items: $ref: '#/components/schemas/auth.v1.Action' auth.v1.StatusReply: type: object properties: captcha: $ref: '#/components/schemas/auth.v1.Captcha' needCaptcha: type: boolean locked: type: boolean lockExpire: type: string auth.v1.UpdateActionRequest: type: object properties: id: type: string name: type: string word: type: string resource: type: string menu: type: string btn: type: string auth.v1.UpdateRoleRequest: type: object properties: id: type: string name: type: string word: type: string action: type: string auth.v1.UpdateUserGroupRequest: type: object properties: id: type: string name: type: string word: type: string action: type: string users: type: string description: Comma-separated list of user IDs. auth.v1.UpdateUserRequest: type: object properties: id: type: string username: type: string password: type: string platform: type: string locked: type: boolean lockExpire: type: string lockExpireTime: type: string description: lock_expire_time accepts datetime strings like "2026-01-31 00:00:00". action: type: string description: Comma-separated action codes. roleId: type: string auth.v1.UpdateWhitelistRequest: type: object properties: id: type: string category: type: integer format: int32 resource: type: string auth.v1.User: type: object properties: id: type: string createdAt: type: string updatedAt: type: string username: type: string code: type: string platform: type: string locked: type: boolean lastLogin: type: string lockExpire: type: string lockMsg: type: string actions: type: array items: $ref: '#/components/schemas/auth.v1.Action' roleId: type: string role: $ref: '#/components/schemas/auth.v1.Role' wrong: type: string auth.v1.UserGroup: type: object properties: id: type: string name: type: string word: type: string action: type: string description: Comma-separated action codes. actions: type: array items: $ref: '#/components/schemas/auth.v1.Action' users: type: array items: $ref: '#/components/schemas/auth.v1.User' auth.v1.Whitelist: type: object properties: id: type: string category: type: integer format: int32 resource: type: string params.Page: type: object properties: num: type: string size: type: string total: type: string disable: type: boolean tags: - name: Auth description: |- The auth service definition. Notes on conditional blocks: - This repo is a scaffold template; some RPCs/messages are gated by feature flags. - Conditionals are expressed via Go template blocks and also annotated with comments. - name: Health description: 'Conditional: enable_health_check'