document-management/backend/openapi/openapi.yaml

openapi: 3.0.3
info:
  title: 方案计划文档管理系统 API
  version: 1.72.0
  description: DMS第一阶段接口；Q3-B正文检索、原文件预览、1.6 LibreOffice离线文档转换与PDF预览、1.7 机构用户维护与详细说明、1.8 角色管理与权限矩阵、1.9 方案关联关系、1.10 部门IP登录限制、1.11 统一门户跳转登录与子案挂载、1.12 正文提取状态可见与重新解析、1.13 登录界面自定义背景图、1.17 管理类权限矩阵化（管理位挂角色）、1.19 调阅授权收敛（限时用户调阅+审批单凭证）、1.21 安全加固（访问令牌有效期配置化默认1小时、敏感操作二次认证X-DMS-Reauth-Token、应用层信封加密KEK/DEK）、1.22 数据备份定版（全量/增量链、rsync异机/本机目录、定时与手动、进度与历史、离线恢复CLI）、1.23 系统管理（manage_system/manage_audit_log管理位、CPU内存监控与趋势、存储占用、转换器状态、一键体检、系统信息、运行参数、运行日志、预览缓存清理、强制下线、备份目标测试）、1.24 门户设密自选机构（SET_PASSWORD响应内嵌机构列表，setup-password可选organizationId）、1.25 本地单点登录代理（仅Java版POST /auth/portal/proxy-verify，REST直连本机代理GET /middle/token/get.json取token、经用户服务POST /auth/user/getUserBasicInfo验身份，响应同门户验签双阶段，前端打开页面静默探测失败回落登录页）、1.26 监控信息展示开关（DMS_SYSTEM_MONITOR_ENABLED缺省false，system/info响应新增monitoringEnabled，false时前端隐藏系统管理页维护操作之上的监控区块）、1.27 列表拖动重排（机构/用户/角色列表PUT reorder接口，槽位置换语义+步长10重编号sort_no，新增审计动作REORDER_ORGANIZATION/REORDER_USER/REORDER_ROLE，sys_user新增sort_no列）、1.28 IP条目范围形式（ipValue新增「起IP-止IP」范围录入，两端同为IPv4或IPv6且起≤止，规范化存储，登录IP校验支持范围闭区间命中）、1.29 页面空闲自动登出与机构树默认语义（登录/设密响应data新增idleLogoutMinutes，取DMS_IDLE_LOGOUT_MINUTES缺省5分钟、0表示关闭，前端监测鼠标/键盘/滚动等活动超时自动退出；organizations/tree不传status时返回全部机构含停用）、1.30 用户级管理范围（sys_user新增managed_org_id三态：null=全局、0=SELF跟随本人所在机构、机构ID=固定锚点；createUser/updateUser请求新增可选managedOrgId字段（create缺省落SELF、update缺省保持原值），UserSummary.managedOrgId改回用户级三态；实际生效范围以生效角色锚点为准，角色锚点"SELF"语义改为「跟随用户的管理范围设置」）、1.32 登录图片验证码（安全需求4，GET /auth/captcha签发data URL图片132×44、4位字符、120秒过期一次性消费；DMS_CAPTCHA_ENABLED缺省true，开启时登录请求体扩为五键captchaId/captchaCode，校验先于用户查询与锁定检查，错误返回400 INVALID_CAPTCHA）、1.33 超级管理员隐藏与机构树管理范围裁剪（安全需求7/8，DMS_ALLOW_ADMIN_LOGIN缺省true，false时内置admin登录按用户名不存在处理报错一致、用户列表隐藏、创建同名用户400"不能创建该名称的用户"；organizations/tree按请求者生效管理范围裁剪，锚点管理员仅返回管理范围子树、全局管理员不受限）、1.34 站内通知（sys_notification表，GET /notifications当前用户通知列表id倒序、GET /notifications/unread-count未读数、POST /notifications/read-all全部已读、POST /notifications/{id}/handle待办同意或拒绝（仅action=PENDING且归属本人，处理完置READ并记handledAt）；通知为审批流等待办的呈现通道，当前版本由后续审批流写入）、1.35 菜单显示方式（allowedModules按角色权限矩阵与管理位纯权限推导，与用户类别无关、不查文档存在性：管理类列任一或分类管理位→方案管理替代方案浏览，浏览类列任一→方案浏览，审计/系统/机构用户管理位独立渲染页签，全空兜底方案浏览，内置admin恒全量四页签）、1.36 操作位完全拆分（allowedActions与写路径鉴权各操作位独立判定，查看不再是其他位前置：矩阵操作位命中即独立下发与放行，下载位由矩阵或调阅ACL独立命中不再要求同时可查看，附件聚合任一主案命中下载即可，查看类能力仍按查看权拦截）、1.37 调阅申请审批流（调阅授权由手工配置改为申请-审批：POST /documents/{id}/borrow-requests提交申请（multipart：request part JSON字符串{entries,expiresAt}+可选file part PDF审批单，一批用户共用一张，敏感操作需二次认证）、GET /borrow-requests/{id}申请详情（申请人本人或文档授权位可见）、GET /borrow-requests/{id}/voucher审批单下载；NotificationSummary新增bizId指向申请单，APPROVAL待办经notifications/{id}/handle联动审批、任一审批人处理即定，同意逐条目落地doc_permission；新增审计动作BORROW_REQUEST_CREATE/APPROVE/REJECT）、1.38 一次一码轮换（安全需求：写操作防重放，仅Java版实现，开关DMS_TOKEN_ROTATION_ENABLED缺省true；GET/HEAD读请求沿用原授权码不轮换不比对，POST/PUT/DELETE/PATCH写请求严格比对sys_user.session_jti=JWT jti，业务成功后轮换新授权码经响应头X-DMS-Access-Token返回、旧码写操作立即失效返回401 SESSION_ROTATED；新码继承原码剩余有效期与全部身份声明，并发写由服务端CAS保证乱序下客户端拿到最新码；session_jti为NULL（存量会话/开关关闭期间登录/Python版签发）跳过比对与轮换自然过渡；登录与门户设密完成响应data新增tokenRotation布尔回显）、1.39 禁用用户名密码登录（安全管控，仅Java版实现，开关DMS_PASSWORD_LOGIN_DISABLED双版同名缺省false：开启后POST /auth/login对全部用户含内置admin最前置403 FORBIDDEN「用户名密码登录已被禁用，请使用单点登录」，守卫先于验证码校验与用户查询、不消耗验证码、不泄露账号存在；门户验签与本地SSO代理登录不受影响为仅存入口；GET /auth/captcha响应data新增必返passwordLoginDisabled布尔回显，前端据此隐藏登录页账号密码表单仅显示单点登录提示）、1.40 验证码缺省关闭（DMS_CAPTCHA_ENABLED缺省值由true改为false，键名与接受值不变：未显式配置的部署登录页不再显示图片验证码、登录请求回归三键，显式设true不受影响；前端按captcha响应enabled决定显隐无需变更）、1.41 权限细分调整（方案权限矩阵新增附件四权限位canAttachmentUpload/canAttachmentEdit/canAttachmentView/canAttachmentDownload仅OWN行可设置，迁移0039/V25并同批将protect_unbind_attachment并入protect_bind_attachment；附件上传POST /attachments与batch-import改矩阵附件上传位判定ADMIN恒可；附件编辑PUT /attachments/{id}改ADMIN或矩阵附件编辑位；附件查看下载不再跟随主案权限——矩阵附件位OR叠加挂载聚合，配置附件位即使主案无权限也可查看下载；UserSummary新增permAttachmentLibrary/permAttachmentUpload会话位；方案锁挂载与解除挂载合并为单一「挂载」位protectedActions收敛6项，解挂仍传UNBIND_ATTACHMENT码按挂载位判定）、1.42 附件密级开放（共享资料创建metadata新增必填securityLevel（上传/批量导入/编辑三入口一致，前端公开级为常态缺省显式提交），编辑请求UpdateAttachmentRequest同增必填securityLevel可调整密级；上传鉴权canAttachmentUpload按目标密级取OWN行——上传SECRET附件需SECRET行上传位；附件访问判定按附件自身密级取矩阵OWN行与密级前置维持；编辑调密级跨域变更复用主案域迁移路径（绝密要求KEK、原件预览缓存随密级搬迁）；updateAttachmentMeta落库新增security_level列，无表结构变更无新增路径）、1.43 附件权限收口（附件四权限判定中ADMIN类别恒可收口为仅内置超管username=admin恒可，受限ADMIN（自定义管理类角色）与USER同口径按矩阵附件位判定未配置即无能力；附件查看/下载不再跟随挂载主案权限——evaluateAttachmentAccess与attachmentAllowedActions移除挂载聚合路径仅按附件密级取OWN行附件位（对齐1.41需求原话"不再跟随主方案"）；附件删除维持ADMIN类别专属受限ADMIN的allowedActions下发DELETE位；UserSummary会话位permAttachmentLibrary/permAttachmentUpload去掉ADMIN类别恒true仅超管恒true或矩阵位命中，前端共享资料库页签仅按permAttachmentLibrary渲染；写路径错误消息统一为"无权{操作}该共享附件：角色权限未授予该操作"）、1.44 附件删除权限位（RolePermissionRow布尔位扩为13个新增canAttachmentDelete，迁移V26为sys_role_permission加can_attachment_delete列仅OWN行可设置OTHER行服务端拒真；附件删除不再按ADMIN类别专属——仅内置超管恒可，受限ADMIN与USER同按附件密级取OWN行删除位判定，allowedActions按位下发DELETE；permAttachmentLibrary会话位计数纳入删除位）、1.45 用户与机构只读接口放开（GET /users与GET /organizations/tree不再要求ADMIN类别任意登录用户可调；普通用户USER调用户列表不传机构静默收敛本人部门子树、显式请求子树外机构403「无权限查看该机构的用户」，机构树恒返回本人部门为根子树、无部门空树；ADMIN维持既有管理范围收敛；返回DTO不变；调阅申请弹窗添加调阅人直接复用两个通用接口）、1.46 多角色架构与席位用户类型（sys_user_role多对多挂载表，登录两轮制可选roleId+roleSelectionRequired选择步骤响应、会话锁定单角色JWT新增roleId claim，用户创建编辑roleId改roleIds数组并新增seatName席位与userType用户类型NORMAL/COMMANDER首长，UserSummary新增roles挂载简表/seatName/userType，挂载diff变化联动authVersion+1旧Token失效，角色成员接口操作挂载表关联）、1.47 用户名与姓名同语义（登录username支持姓名唯一命中回退、重名歧义按401凭证错误不可区分；新建编辑姓名应用层唯一校验409「姓名已存在」不加库约束；迁移V28/0041内置admin姓名改超级管理员；强制下线响应新增realName；前端显示用户名处一律显示姓名）、1.48 方案权限矩阵三维化（sys_role_permission行键扩为一级分类×种类×密级×部门范围，新增top_category_id（NULL=共享资料库行组）与doc_kind（MAIN/附件四类型）列，迁移V29/0042存量按一级分类同权展开；GET/PUT /roles/{id}/permissions行结构新增topCategoryId/docKind，行数动态=期望键集（常规分类30行、仅主案分类10行、共享资料库20行），读时归一化补0行、保存缺失行补插、重复脏行409；判定：主案按顶级分类MAIN行、已挂载附件按挂载主案顶级分类附件行任一命中、未挂载附件走共享资料库行组；「扁平模式」更名「仅主案模式」字段不变）、1.49 登录界面重置密码审批流（POST /auth/reset-password-requests登录前公开提交，按用户类型路由审批角色：首长→安全管理员、其他→系统管理员（DMS_RESET_PASSWORD_APPROVER_ROLE_COMMANDER/NORMAL可配），PASSWORD_RESET通知待办先到先得审批，通过后清密码回首次登录态经单点登录重新设密；用户管理重置密码对首长403收口）、1.50 姓名概念退出界面（登录页与重置密码弹窗提示收敛为「请输入用户名」，后端仍兼容姓名解析存量用户、接口不变；用户维护列表「姓名」列更名「用户名」且展示realName不再单独展示姓名列；用户表单移除姓名项，新建realName由用户名同步写入（接口仍必填、唯一校验不变），编辑提交保持原值）、1.51 用户名即姓名（全站界面不再体现姓名概念与英文账号：用户列表筛选、共享资料搜索、调阅/授权人员选择搜索提示统一为「用户名」，顶栏信息面板「姓名：」更名「用户名：」、审计列头「用户名 / 姓名」改「用户名」，调阅人员列表不附显账号、门户独立密码界面回显realName、重置密码待办文案去掉账号；新建用户录入姓名同值写入username与realName（无字符集限制，中文可用）、1.52 席位输入提示（用户表单席位输入框placeholder由「选填，展示于右上角用户信息」改为「请输入席位」，仅前端文案，接口不变），接口不变，存量英文username保留作登录兼容）、1.53 密码即角色（sys_user_role新增password_hash列（V31/0044），N个角色密码与N个挂载角色一一对应，登录输入哪个角色的密码即直接以该角色进入无需显式选择；挂载≥2角色必须恰一个「使用用户密码」（password=null）、其余独立密码两两互异且不等于用户级密码（400 PASSWORD_CONFLICT「各角色密码不能相同，且不能与用户密码相同」）；登录匹配顺序：先遍历挂载行非空哈希命中即进、未命中回退用户级密码（恰一个null挂载行→以该角色进），挂载行全NULL多角色=存量过渡态维持1.46角色选择；创建/编辑用户与门户设密（verify SET_PASSWORD响应多角色时新增roles、setup-password新增可选rolePasswords）新增rolePasswords分配——编辑仅挂载变化时受理（≥2全量重新分配、≤1清空挂载行密码），未变提交400「挂载角色未变化，无需重新分配角色密码」；管理员重置密码与1.49自助重置审批通过同步清空全部挂载行密码回过渡态）、1.54 审批相关设置（sys_setting通用键值表：调阅说明存borrow.notice行≤4000字、调阅审批单模板borrow.template行元数据+PDF落盘settings/borrow-template.pdf固定路径；GET /borrow-settings与GET /borrow-settings/template任意登录用户可读可下载（null/404=未设置）、PUT /borrow-settings与POST、DELETE /borrow-settings/template走manage_system位（仅PDF、≤DMS_MAX_FILE_SIZE、上传覆盖替换），写操作审计BORROW_SETTINGS_UPDATE，调阅对话框展示说明并提供模板下载）、1.55 高级检索四维度（documents/attachments列表新增keywordScope（TITLE标题缺省兼容/CONTENT正文/ALL标题或正文任一命中，作用于keyword匹配范围，keyword为空时忽略；聚合检索aggregateHits仅支持TITLE否则400 INVALID_ARGUMENT）与organizationId（选中机构含下级子树过滤，子树为空返回空集），前端数据密级由多选securityLevels改单选securityLevel（后端多选保留兼容）；数据分类复用categoryId（前端按一级分类含子树过滤）与attachmentType四类型；正文命中片段在CONTENT/ALL时回落以keyword生成contentSnippet；新增GET /organizations/filter-options返回第orgFilterLevel级启用机构选项{orgFilterLevel,organizations}（任意登录用户、按sort_no升序null最后，级别DMS_SEARCH_ORG_FILTER_LEVEL缺省2））、1.62 登录页文案可配置（GET /api/v1/config/login-branding公开读取登录界面大标题与底部小字{title,footerText}（null=未设置，前端回落内置默认「方案数据管理系统」/「© 方案数据管理系统 · 版权所有 · 严禁扩散」，登录页/门户启动页/认证过渡页三界面共用）；PUT同路径要求manage_system管理位，请求体{title,footerText}（null/空白即清除恢复默认、非字符串400「{字段}必须是字符串」、title≤64字footerText≤200字超长400），两文案分别upsert至sys_setting的login.title/login.footer行、审计LOGIN_BRANDING_UPDATE；系统管理页新增「登录页文案」维护区块）、1.65 本地重设密（密码被重置审批清空的用户本地登录不再403，验证码/锁定/IP守卫照常通过后无论输入什么密码都返回与门户验签SET_PASSWORD同构的设密载荷SetupPasswordPhaseData（票据一次性5分钟有效），前端进入与单点登录首次设密同一界面重新设密、设密提交复用portal/setup-password接口；审计reason=PASSWORD_RESET留痕）、1.66 界面与流程五项优化（左侧一级分类Tab十色循环配色（红蓝绿橙紫青棕粉灰深十色，超出按页签序号取模循环），选中实底白字、未选中同色浅底同色深字；调阅申请提交不再要求二次认证X-DMS-Reauth-Token（审批动作仍保留），审批单PDF必传——缺失或空文件返回400 INVALID_ARGUMENT「调阅申请必须上传审批单（PDF）」，前端空文件先拦截提示；高级检索数据分类筛选拆两行——第一行「主体方案」（planOnly=true，仅主案与子案）与四类共享资料attachmentType，第二行为flatMode仅主案模式一级分类（categoryId，选中即只下方案路对应分类），两行下拉均不附加「全部」选项时以空值表示全部；高级检索提供单位筛选拆两行——GET /organizations/filter-options响应新增childOrganizations（第N+1级启用机构清单，required），第一行organizations为第N级机构、第二行childOrganizations为第N+1级机构（N=DMS_SEARCH_ORG_FILTER_LEVEL缺省2），第二行不附加「全部」；查看页不再展示提取正文全文，输入关键词后在原正文区显示命中上下文摘要列表（命中词前后各约30字符、不足开头结尾以…省略、标注第N处命中），点击条目按全局命中序号跳转至正文/PDF对应位置）、1.72 调阅审批单图片支持（审批单凭证由仅PDF扩为PDF+图片jpg/jpeg/png/gif/bmp/webp——授权条目凭证上传与调阅申请file part共用stageVoucher白名单扩展（415 UNSUPPORTED_FILE_TYPE「审批单凭证只允许PDF或图片文件」），魔数校验复用UploadStorage.validate，落盘{domain}/voucher/{uuid}.{真实扩展名}、StagedUpload MIME按MIME_TYPES映射，下载两处（授权凭证/申请审批单）Content-Type按扩展名映射application/pdf或对应image/*（VoucherService.voucherMediaType，BorrowRequestService复用）；调阅申请空文件400文案改「调阅申请必须上传审批单（PDF 或图片）」；前端文件选择accept扩image/*、删除上传处两处提示说明）
servers:
  - url: /
paths:
  /api/v1/health:
    get:
      operationId: getDmsHealth
      summary: DMS健康检查
      security: []
      parameters:
        - $ref: './components/parameters.yaml#/XRequestId'
      responses:
        '200':
          $ref: './components/responses.yaml#/HealthSuccess'
        '500':
          $ref: './components/responses.yaml#/InternalError'
  /api/v1/auth/captcha:
    $ref: './paths/auth.yaml#/Captcha'
  /api/v1/auth/login:
    $ref: './paths/auth.yaml#/Login'
  /api/v1/auth/logout:
    $ref: './paths/auth.yaml#/Logout'
  /api/v1/auth/reauth:
    $ref: './paths/auth.yaml#/Reauth'
  /api/v1/auth/portal/verify:
    $ref: './paths/auth.yaml#/PortalVerify'
  /api/v1/auth/portal/proxy-verify:
    $ref: './paths/auth.yaml#/PortalProxyVerify'
  /api/v1/auth/portal/setup-password:
    $ref: './paths/auth.yaml#/PortalSetupPassword'
  /api/v1/users/me:
    $ref: './paths/users.yaml#/CurrentUser'
  /api/v1/users/me/ui-theme:
    $ref: './paths/users.yaml#/CurrentUserUiTheme'
  /api/v1/organizations/tree:
    $ref: './paths/organizations.yaml#/OrganizationTree'
  /api/v1/organizations:
    $ref: './paths/organizations.yaml#/Organizations'
  /api/v1/organizations/{id}:
    $ref: './paths/organizations.yaml#/Organization'
  /api/v1/organizations/{id}/ip-assignments:
    $ref: './paths/organizations.yaml#/OrganizationIpAssignments'
  /api/v1/organizations/reorder:
    $ref: './paths/organizations.yaml#/OrganizationsReorder'
  /api/v1/organizations/filter-options:
    $ref: './paths/organizations.yaml#/OrganizationFilterOptions'
  /api/v1/ip-entries:
    $ref: './paths/ip-entries.yaml#/IpEntries'
  /api/v1/ip-entries/{id}:
    $ref: './paths/ip-entries.yaml#/IpEntry'
  /api/v1/users:
    $ref: './paths/users.yaml#/Users'
  /api/v1/users/{id}:
    $ref: './paths/users.yaml#/User'
  /api/v1/users/{id}/reset-password:
    $ref: './paths/users.yaml#/UserResetPassword'
  /api/v1/users/reorder:
    $ref: './paths/users.yaml#/UsersReorder'
  /api/v1/roles:
    $ref: './paths/roles.yaml#/Roles'
  /api/v1/roles/{id}:
    $ref: './paths/roles.yaml#/Role'
  /api/v1/roles/{id}/permissions:
    $ref: './paths/roles.yaml#/RolePermissions'
  /api/v1/roles/{id}/users:
    $ref: './paths/roles.yaml#/RoleUsers'
  /api/v1/roles/reorder:
    $ref: './paths/roles.yaml#/RolesReorder'
  /api/v1/notifications:
    $ref: './paths/notifications.yaml#/Notifications'
  /api/v1/notifications/unread-count:
    $ref: './paths/notifications.yaml#/NotificationsUnreadCount'
  /api/v1/notifications/read-all:
    $ref: './paths/notifications.yaml#/NotificationsReadAll'
  /api/v1/notifications/{id}/handle:
    $ref: './paths/notifications.yaml#/NotificationHandle'
  /api/v1/documents/{id}/borrow-requests:
    $ref: './paths/borrow-requests.yaml#/BorrowRequestCreate'
  /api/v1/borrow-requests/{id}:
    $ref: './paths/borrow-requests.yaml#/BorrowRequestDetail'
  /api/v1/borrow-requests/{id}/voucher:
    $ref: './paths/borrow-requests.yaml#/BorrowRequestVoucher'
  /api/v1/borrow-settings:
    $ref: './paths/borrow-settings.yaml#/BorrowSettings'
  /api/v1/borrow-settings/template:
    $ref: './paths/borrow-settings.yaml#/BorrowTemplate'
  /api/v1/config/ui-dictionaries:
    $ref: './paths/configuration.yaml#/UiDictionaries'
  /api/v1/config/login-background:
    $ref: './paths/configuration.yaml#/LoginBackground'
  /api/v1/config/login-branding:
    $ref: './paths/configuration.yaml#/LoginBranding'
  /api/v1/categories/tree:
    $ref: './paths/categories.yaml#/CategoryTree'
  /api/v1/categories:
    $ref: './paths/categories.yaml#/Categories'
  /api/v1/categories/reorder:
    $ref: './paths/categories.yaml#/CategoriesReorder'
  /api/v1/categories/{id}:
    $ref: './paths/categories.yaml#/Category'
  /api/v1/documents:
    $ref: './paths/documents.yaml#/Documents'
  /api/v1/documents/tags:
    $ref: './paths/documents.yaml#/DocumentsTags'
  /api/v1/documents/reorder:
    $ref: './paths/documents.yaml#/DocumentsReorder'
  /api/v1/documents/{id}:
    $ref: './paths/documents.yaml#/Document'
  /api/v1/documents/{id}/re-extract:
    $ref: './paths/documents.yaml#/DocumentReExtract'
  /api/v1/documents/{id}/move:
    $ref: './paths/documents.yaml#/DocumentMove'
  /api/v1/documents/batch-import:
    $ref: './paths/documents.yaml#/DocumentBatchImport'
  /api/v1/documents/{id}/preview:
    $ref: './paths/documents.yaml#/DocumentPreview'
  /api/v1/documents/{id}/download:
    $ref: './paths/documents.yaml#/DocumentDownload'
  /api/v1/main-plans/{id}/sub-plans:
    $ref: './paths/documents.yaml#/SubPlans'
  /api/v1/main-plans/{id}/sub-plans/bind:
    $ref: './paths/documents.yaml#/MainPlanSubPlanBinding'
  /api/v1/main-plans/{id}/sub-plans/{subPlanId}:
    $ref: './paths/documents.yaml#/MainPlanSubPlan'
  /api/v1/attachments:
    $ref: './paths/documents.yaml#/Attachments'
  /api/v1/attachments/{id}:
    $ref: './paths/documents.yaml#/Attachment'
  /api/v1/attachments/batch-import:
    $ref: './paths/documents.yaml#/AttachmentBatchImport'
  /api/v1/attachments/{id}/main-plans:
    $ref: './paths/documents.yaml#/AttachmentMainPlans'
  /api/v1/main-plans/{id}/attachments:
    $ref: './paths/documents.yaml#/MainPlanAttachments'
  /api/v1/main-plans/{id}/attachments/bind:
    $ref: './paths/documents.yaml#/MainPlanAttachmentBinding'
  /api/v1/main-plans/{id}/attachments/reorder:
    $ref: './paths/documents.yaml#/MainPlanAttachmentsReorder'
  /api/v1/main-plans/{id}/attachments/{attachmentId}:
    $ref: './paths/documents.yaml#/MainPlanAttachment'
  /api/v1/main-plans/{id}/attachments/{bindingId}/move:
    $ref: './paths/documents.yaml#/MainPlanAttachmentMove'
  /api/v1/documents/{id}/description:
    $ref: './paths/documents.yaml#/DocumentDescription'
  /api/v1/documents/{id}/permissions:
    $ref: './paths/documents.yaml#/DocumentPermissions'
  /api/v1/documents/{id}/permissions/entries/{entryId}/voucher:
    $ref: './paths/documents.yaml#/DocumentPermissionVoucher'
  /api/v1/documents/{id}/password:
    $ref: './paths/documents.yaml#/DocumentPassword'
  /api/v1/documents/relation-presets:
    $ref: './paths/documents.yaml#/DocumentRelationPresets'
  /api/v1/documents/{id}/relations:
    $ref: './paths/documents.yaml#/DocumentRelations'
  /api/v1/audit/logs:
    $ref: './paths/audit.yaml#/AuditLogs'
  /api/v1/statistics/documents:
    $ref: './paths/audit.yaml#/DocumentStatistics'
  /api/v1/audit/statistics/trend:
    $ref: './paths/audit.yaml#/AuditTrendStatistics'
  /api/v1/audit/statistics/actions:
    $ref: './paths/audit.yaml#/AuditActionStatistics'
  /api/v1/audit/statistics/users:
    $ref: './paths/audit.yaml#/AuditUserStatistics'
  /api/v1/recycle-bin/documents:
    $ref: './paths/recycle-bin.yaml#/RecycleBinDocuments'
  /api/v1/recycle-bin/documents/{id}/restore:
    $ref: './paths/recycle-bin.yaml#/RestoreRecycleBinDocument'
  /api/v1/backup/config:
    $ref: './paths/backup.yaml#/BackupConfig'
  /api/v1/backup/jobs:
    $ref: './paths/backup.yaml#/BackupJobs'
  /api/v1/backup/jobs/current:
    $ref: './paths/backup.yaml#/BackupJobCurrent'
  /api/v1/backup/jobs/current/cancel:
    $ref: './paths/backup.yaml#/BackupJobCancel'
  /api/v1/backup/test-target:
    $ref: './paths/backup.yaml#/BackupTestTarget'
  /api/v1/system/metrics/current:
    $ref: './paths/system.yaml#/SystemMetricsCurrent'
  /api/v1/system/metrics/history:
    $ref: './paths/system.yaml#/SystemMetricsHistory'
  /api/v1/system/process:
    $ref: './paths/system.yaml#/SystemProcess'
  /api/v1/system/storage-usage:
    $ref: './paths/system.yaml#/SystemStorageUsage'
  /api/v1/system/converter:
    $ref: './paths/system.yaml#/SystemConverter'
  /api/v1/system/health:
    $ref: './paths/system.yaml#/SystemHealth'
  /api/v1/system/info:
    $ref: './paths/system.yaml#/SystemInfo'
  /api/v1/system/runtime-config:
    $ref: './paths/system.yaml#/SystemRuntimeConfig'
  /api/v1/system/logs:
    $ref: './paths/system.yaml#/SystemLogs'
  /api/v1/system/logs/download:
    $ref: './paths/system.yaml#/SystemLogsDownload'
  /api/v1/system/maintenance/preview-cache:
    $ref: './paths/system.yaml#/SystemMaintenancePreviewCache'
  /api/v1/system/users/{user_id}/force-offline:
    $ref: './paths/system.yaml#/SystemForceOffline'
components:
  securitySchemes:
    BearerAuth:
      $ref: './components/security-schemes.yaml#/BearerAuth'
  schemas:
    StringId:
      $ref: './components/schemas.yaml#/StringId'
    UtcDateTime:
      $ref: './components/schemas.yaml#/UtcDateTime'
    PageResult:
      $ref: './components/schemas.yaml#/PageResult'
    ErrorResponse:
      $ref: './components/schemas.yaml#/ErrorResponse'
    LoginRequest:
      $ref: './components/schemas.yaml#/LoginRequest'
    LoginResponse:
      $ref: './components/schemas.yaml#/LoginResponse'
    UserSummary:
      $ref: './components/schemas.yaml#/UserSummary'
    OrganizationNode:
      $ref: './components/schemas.yaml#/OrganizationNode'
    UserPageResponse:
      $ref: './components/schemas.yaml#/UserPageResponse'
    CategoryNode:
      $ref: './components/schemas.yaml#/CategoryNode'
    CreateCategoryRequest:
      $ref: './components/schemas.yaml#/CreateCategoryRequest'
    UpdateCategoryRequest:
      $ref: './components/schemas.yaml#/UpdateCategoryRequest'
    DocumentSummary:
      $ref: './components/schemas.yaml#/DocumentSummary'
    DocumentDetail:
      $ref: './components/schemas.yaml#/DocumentDetail'
    AttachmentBindingSummary:
      $ref: './components/schemas.yaml#/AttachmentBindingSummary'
    BindAttachmentsRequest:
      $ref: './components/schemas.yaml#/BindAttachmentsRequest'
    BindAttachmentsResponse:
      $ref: './components/schemas.yaml#/BindAttachmentsResponse'
    UnbindAttachmentResponse:
      $ref: './components/schemas.yaml#/UnbindAttachmentResponse'
    ReorderDocumentsRequest:
      $ref: './components/schemas.yaml#/ReorderDocumentsRequest'
    ReorderDocumentsResponse:
      $ref: './components/schemas.yaml#/ReorderDocumentsResponse'
    ReorderAttachmentsRequest:
      $ref: './components/schemas.yaml#/ReorderAttachmentsRequest'
    ReorderAttachmentsResponse:
      $ref: './components/schemas.yaml#/ReorderAttachmentsResponse'
    PermissionEntry:
      $ref: './components/schemas.yaml#/PermissionEntry'
    SavePermissionsRequest:
      $ref: './components/schemas.yaml#/SavePermissionsRequest'
    PermissionDetailResponse:
      $ref: './components/schemas.yaml#/PermissionDetailResponse'
    PermissionVoucherResultResponse:
      $ref: './components/schemas.yaml#/PermissionVoucherResultResponse'
    PermissionVoucherDeleteResultResponse:
      $ref: './components/schemas.yaml#/PermissionVoucherDeleteResultResponse'
    AuditLogSummary:
      $ref: './components/schemas.yaml#/AuditLogSummary'
    AuditLogPageResponse:
      $ref: './components/schemas.yaml#/AuditLogPageResponse'
    DocumentStatisticsResponse:
      $ref: './components/schemas.yaml#/DocumentStatisticsResponse'
    AuditTrendResponse:
      $ref: './components/schemas.yaml#/AuditTrendResponse'
    AuditActionStatisticsResponse:
      $ref: './components/schemas.yaml#/AuditActionStatisticsResponse'
    AuditUserStatisticsResponse:
      $ref: './components/schemas.yaml#/AuditUserStatisticsResponse'
    DeletedBySnapshot:
      $ref: './components/schemas.yaml#/DeletedBySnapshot'
    RecycleBinDocumentSummary:
      $ref: './components/schemas.yaml#/RecycleBinDocumentSummary'
    RecycleBinDocumentPageResponse:
      $ref: './components/schemas.yaml#/RecycleBinDocumentPageResponse'
    RestoreDocumentRequest:
      $ref: './components/schemas.yaml#/RestoreDocumentRequest'
    RestoreDocumentResult:
      $ref: './components/schemas.yaml#/RestoreDocumentResult'
    RestoreDocumentResponse:
      $ref: './components/schemas.yaml#/RestoreDocumentResponse'
    DictionaryOption:
      $ref: './components/schemas.yaml#/DictionaryOption'
    UiDictionaries:
      $ref: './components/schemas.yaml#/UiDictionaries'
    UiDictionariesResponse:
      $ref: './components/schemas.yaml#/UiDictionariesResponse'
    RoleCode:
      $ref: './components/schemas.yaml#/RoleCode'
    AllowedModule:
      $ref: './components/schemas.yaml#/AllowedModule'
    DocumentType:
      $ref: './components/schemas.yaml#/DocumentType'
    DocumentStatus:
      $ref: './components/schemas.yaml#/DocumentStatus'
    SecurityLevel:
      $ref: './components/schemas.yaml#/SecurityLevel'
    AttachmentType:
      $ref: './components/schemas.yaml#/AttachmentType'
    AllowedAction:
      $ref: './components/schemas.yaml#/AllowedAction'
    CategoryType:
      $ref: './components/schemas.yaml#/CategoryType'
    EnabledStatus:
      $ref: './components/schemas.yaml#/EnabledStatus'
    AuditResult:
      $ref: './components/schemas.yaml#/AuditResult'
    AuditAction:
      $ref: './components/schemas.yaml#/AuditAction'
    AuditTarget:
      $ref: './components/schemas.yaml#/AuditTarget'
    CreateOrganizationRequest:
      $ref: './components/schemas.yaml#/CreateOrganizationRequest'
    UpdateOrganizationRequest:
      $ref: './components/schemas.yaml#/UpdateOrganizationRequest'
    OrganizationResponse:
      $ref: './components/schemas.yaml#/OrganizationResponse'
    DeleteOrganizationResponse:
      $ref: './components/schemas.yaml#/DeleteOrganizationResponse'
    CreateUserRequest:
      $ref: './components/schemas.yaml#/CreateUserRequest'
    UpdateUserRequest:
      $ref: './components/schemas.yaml#/UpdateUserRequest'
    ResetUserPasswordRequest:
      $ref: './components/schemas.yaml#/ResetUserPasswordRequest'
    DeleteUserResponse:
      $ref: './components/schemas.yaml#/DeleteUserResponse'
    ResetPasswordResponse:
      $ref: './components/schemas.yaml#/ResetPasswordResponse'
    DocumentTagsResponse:
      $ref: './components/schemas.yaml#/DocumentTagsResponse'
    DeptScope:
      $ref: './components/schemas.yaml#/DeptScope'
    RoleSummary:
      $ref: './components/schemas.yaml#/RoleSummary'
    RolePageResponse:
      $ref: './components/schemas.yaml#/RolePageResponse'
    CreateRoleRequest:
      $ref: './components/schemas.yaml#/CreateRoleRequest'
    UpdateRoleRequest:
      $ref: './components/schemas.yaml#/UpdateRoleRequest'
    RoleResponse:
      $ref: './components/schemas.yaml#/RoleResponse'
    DeleteRoleResponse:
      $ref: './components/schemas.yaml#/DeleteRoleResponse'
    RolePermissionRow:
      $ref: './components/schemas.yaml#/RolePermissionRow'
    RoleMatrixListResponse:
      $ref: './components/schemas.yaml#/RoleMatrixListResponse'
    UpdateRolePermissionsRequest:
      $ref: './components/schemas.yaml#/UpdateRolePermissionsRequest'
    RolePermissionsResponse:
      $ref: './components/schemas.yaml#/RolePermissionsResponse'
    RoleUsersResponse:
      $ref: './components/schemas.yaml#/RoleUsersResponse'
    UpdateRoleUsersRequest:
      $ref: './components/schemas.yaml#/UpdateRoleUsersRequest'
    IpEntrySummary:
      $ref: './components/schemas.yaml#/IpEntrySummary'
    IpEntryPageResponse:
      $ref: './components/schemas.yaml#/IpEntryPageResponse'
    CreateIpEntryRequest:
      $ref: './components/schemas.yaml#/CreateIpEntryRequest'
    UpdateIpEntryRequest:
      $ref: './components/schemas.yaml#/UpdateIpEntryRequest'
    IpEntryResponse:
      $ref: './components/schemas.yaml#/IpEntryResponse'
    DeleteIpEntryResponse:
      $ref: './components/schemas.yaml#/DeleteIpEntryResponse'
    BackupConfigView:
      $ref: './components/schemas.yaml#/BackupConfigView'
    UpdateBackupConfigRequest:
      $ref: './components/schemas.yaml#/UpdateBackupConfigRequest'
    BackupConfigResponse:
      $ref: './components/schemas.yaml#/BackupConfigResponse'
    BackupJobStartRequest:
      $ref: './components/schemas.yaml#/BackupJobStartRequest'
    BackupProgress:
      $ref: './components/schemas.yaml#/BackupProgress'
    BackupJobStartResponse:
      $ref: './components/schemas.yaml#/BackupJobStartResponse'
    BackupCurrentJob:
      $ref: './components/schemas.yaml#/BackupCurrentJob'
    BackupJobCurrentResponse:
      $ref: './components/schemas.yaml#/BackupJobCurrentResponse'
    BackupCancelResponse:
      $ref: './components/schemas.yaml#/BackupCancelResponse'
    BackupHistoryEntry:
      $ref: './components/schemas.yaml#/BackupHistoryEntry'
    BackupHistoryResponse:
      $ref: './components/schemas.yaml#/BackupHistoryResponse'
    OrgIpAssignmentListResponse:
      $ref: './components/schemas.yaml#/OrgIpAssignmentListResponse'
    UpdateOrgIpAssignmentsRequest:
      $ref: './components/schemas.yaml#/UpdateOrgIpAssignmentsRequest'
    OrgIpAssignmentsResponse:
      $ref: './components/schemas.yaml#/OrgIpAssignmentsResponse'
    DocumentRelationPreset:
      $ref: './components/schemas.yaml#/DocumentRelationPreset'
    DocumentRelationPresetsResponse:
      $ref: './components/schemas.yaml#/DocumentRelationPresetsResponse'
    DocumentRelationItem:
      $ref: './components/schemas.yaml#/DocumentRelationItem'
    DocumentRelationsResponse:
      $ref: './components/schemas.yaml#/DocumentRelationsResponse'
    UpdateDocumentRelationsRequest:
      $ref: './components/schemas.yaml#/UpdateDocumentRelationsRequest'
    DocumentRelationsSaveResponse:
      $ref: './components/schemas.yaml#/DocumentRelationsSaveResponse'
security:
  - BearerAuth: []