configuration.yaml 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  1. UiDictionaries:
  2. get:
  3. operationId: getUiDictionaries
  4. summary: 查询统一UI展示字典
  5. description: 返回启动时加载的只读展示标签;不提供配置路径或写操作。
  6. parameters:
  7. - $ref: '../components/parameters.yaml#/XRequestId'
  8. responses:
  9. '200':
  10. description: 完整UI展示字典
  11. headers:
  12. X-Request-Id:
  13. description: 与响应体requestId相同
  14. schema:
  15. type: string
  16. format: uuid
  17. content:
  18. application/json:
  19. schema:
  20. $ref: '../components/schemas.yaml#/UiDictionariesResponse'
  21. '401':
  22. $ref: '../components/responses.yaml#/AuthenticationError'
  23. '500':
  24. $ref: '../components/responses.yaml#/InternalError'
  25. LoginBackground:
  26. get:
  27. operationId: getLoginBackground
  28. summary: 查询登录界面自定义背景图
  29. description: >-
  30. 返回服务端运行目录下的 background.jpg 或 background.png(jpg优先);
  31. 携带 theme 查询参数(blue/red/green)时优先返回 background-{theme}.jpg/png,
  32. 主题背景图不存在时回落通用 background.jpg/png(契约1.31);
  33. 运行目录不存在背景图文件时返回404,前端回退默认纯色背景。
  34. 接口公开(登录前无凭证可访问),允许浏览器缓存60秒。
  35. security: []
  36. parameters:
  37. - $ref: '../components/parameters.yaml#/XRequestId'
  38. - name: theme
  39. in: query
  40. required: false
  41. description: 主题键(契约1.31);白名单外的取值按未提供处理,回落通用背景图。
  42. schema:
  43. type: string
  44. enum: [blue, red, green]
  45. responses:
  46. '200':
  47. description: 背景图片二进制
  48. headers:
  49. X-Request-Id:
  50. description: 与请求发送的X-Request-Id一致
  51. schema:
  52. type: string
  53. format: uuid
  54. content:
  55. image/jpeg:
  56. schema:
  57. type: string
  58. format: binary
  59. image/png:
  60. schema:
  61. type: string
  62. format: binary
  63. '404':
  64. description: 运行目录下不存在背景图文件
  65. content:
  66. application/json:
  67. schema:
  68. $ref: '../components/schemas.yaml#/ErrorResponse'
  69. '500':
  70. $ref: '../components/responses.yaml#/InternalError'
  71. # 契约1.62 登录页文案:大标题与底部小字(sys_setting 键值表
  72. # login.title / login.footer 行,行不存在=未设置,前端回落内置默认)。
  73. LoginBranding:
  74. get:
  75. operationId: getLoginBranding
  76. summary: 读取登录页文案(大标题与底部小字)
  77. description: >-
  78. 契约1.62。接口公开(登录前无凭证可访问,登录页与登录背景图同模式);
  79. 响应data={title,footerText},null=未设置(前端回落内置默认文案)。
  80. security: []
  81. parameters:
  82. - $ref: '../components/parameters.yaml#/XRequestId'
  83. responses:
  84. '200':
  85. description: 登录页文案(null=未设置)
  86. headers:
  87. X-Request-Id:
  88. description: 与响应体requestId相同
  89. schema:
  90. type: string
  91. format: uuid
  92. content:
  93. application/json:
  94. schema:
  95. type: object
  96. additionalProperties: false
  97. required: [title, footerText]
  98. properties:
  99. title: {type: [string, 'null'], description: 登录页大标题,最长64字,null=未设置}
  100. footerText: {type: [string, 'null'], description: 登录页底部小字,最长200字,null=未设置}
  101. '500':
  102. $ref: '../components/responses.yaml#/InternalError'
  103. put:
  104. operationId: updateLoginBranding
  105. summary: 保存登录页文案
  106. description: >-
  107. 契约1.62。manage_system管理位;请求体必含且仅含title与footerText
  108. (传null或空白即清除、恢复默认;非字符串返回400 INVALID_ARGUMENT
  109. 「{字段}必须是字符串」;title超过64字返回400「登录页大标题不能超过64字」、
  110. footerText超过200字返回400「登录页底部小字不能超过200字」);两文案分别
  111. upsert至sys_setting的login.title/login.footer行;响应回显{title,footerText};
  112. 审计LOGIN_BRANDING_UPDATE(targetType=SYSTEM,targetName=login-branding)。
  113. security:
  114. - BearerAuth: []
  115. parameters:
  116. - $ref: '../components/parameters.yaml#/XRequestId'
  117. requestBody:
  118. required: true
  119. content:
  120. application/json:
  121. schema:
  122. type: object
  123. additionalProperties: false
  124. required: [title, footerText]
  125. properties:
  126. title: {type: [string, 'null'], description: 登录页大标题,null/空白即恢复默认}
  127. footerText: {type: [string, 'null'], description: 登录页底部小字,null/空白即恢复默认}
  128. responses:
  129. '200':
  130. description: 已保存(data回显两文案)
  131. content:
  132. application/json:
  133. schema:
  134. type: object
  135. additionalProperties: false
  136. required: [title, footerText]
  137. properties:
  138. title: {type: [string, 'null'], description: 保存后的登录页大标题}
  139. footerText: {type: [string, 'null'], description: 保存后的登录页底部小字}
  140. '400': {$ref: '../components/responses.yaml#/InvalidArgument'}
  141. '401': {$ref: '../components/responses.yaml#/AuthenticationError'}
  142. '403': {$ref: '../components/responses.yaml#/Forbidden'}
  143. '500': {$ref: '../components/responses.yaml#/InternalError'}