recycle-bin.yaml 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. RecycleBinDocuments:
  2. get:
  3. operationId: listRecycleBinDocuments
  4. summary: 分页查询文档回收站
  5. parameters:
  6. - $ref: '../components/parameters.yaml#/XRequestId'
  7. - {name: keyword, in: query, schema: {type: string}}
  8. - name: documentType
  9. in: query
  10. schema: {type: string, enum: [MAIN, SUB_PLAN, ATTACHMENT]}
  11. - name: categoryId
  12. in: query
  13. schema: {$ref: '../components/schemas.yaml#/StringId'}
  14. - name: deletedFrom
  15. in: query
  16. schema: {type: string, format: date-time, pattern: 'Z$'}
  17. - name: deletedTo
  18. in: query
  19. schema: {type: string, format: date-time, pattern: 'Z$'}
  20. - {name: page, in: query, schema: {type: integer, minimum: 1, default: 1}}
  21. - name: pageSize
  22. in: query
  23. schema: {type: integer, minimum: 1, maximum: 100, default: 20}
  24. - name: sortField
  25. in: query
  26. schema:
  27. type: string
  28. enum: [deletedAt, documentName, documentType, updatedAt]
  29. default: deletedAt
  30. - name: sortDirection
  31. in: query
  32. schema: {type: string, enum: [asc, desc], default: desc}
  33. responses:
  34. '200':
  35. description: 回收站分页结果
  36. content:
  37. application/json:
  38. schema:
  39. $ref: '../components/schemas.yaml#/RecycleBinDocumentPageResponse'
  40. '400': {$ref: '../components/responses.yaml#/InvalidArgument'}
  41. '401': {$ref: '../components/responses.yaml#/AuthenticationError'}
  42. '403': {$ref: '../components/responses.yaml#/Forbidden'}
  43. '500': {$ref: '../components/responses.yaml#/InternalError'}
  44. RestoreRecycleBinDocument:
  45. post:
  46. operationId: restoreRecycleBinDocument
  47. summary: 恢复单条回收站文档
  48. parameters:
  49. - $ref: '../components/parameters.yaml#/XRequestId'
  50. - name: id
  51. in: path
  52. required: true
  53. schema: {$ref: '../components/schemas.yaml#/StringId'}
  54. requestBody:
  55. required: true
  56. content:
  57. application/json:
  58. schema:
  59. $ref: '../components/schemas.yaml#/RestoreDocumentRequest'
  60. responses:
  61. '200':
  62. description: 文档恢复成功
  63. content:
  64. application/json:
  65. schema:
  66. $ref: '../components/schemas.yaml#/RestoreDocumentResponse'
  67. '400': {$ref: '../components/responses.yaml#/InvalidArgument'}
  68. '401': {$ref: '../components/responses.yaml#/AuthenticationError'}
  69. '403': {$ref: '../components/responses.yaml#/Forbidden'}
  70. '404': {$ref: '../components/responses.yaml#/NotFound'}
  71. '409': {$ref: '../components/responses.yaml#/Conflict'}
  72. '415': {$ref: '../components/responses.yaml#/UnsupportedMedia'}
  73. '500': {$ref: '../components/responses.yaml#/InternalError'}