v2-sent-history.yaml 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. # 由 openapi/scripts/generate.php 生成,请勿手改;补充写到 overrides/v2-sent-history.yaml
  2. get:
  3. summary: '列出 sent_history'
  4. tags:
  5. - sent_history
  6. operationId: get_api_v2_sent_history
  7. description: 实现:`SentHistoryController@index`
  8. parameters:
  9. -
  10. name: id
  11. in: query
  12. schema:
  13. type: string
  14. -
  15. name: fork
  16. in: query
  17. schema:
  18. type: string
  19. -
  20. name: order
  21. in: query
  22. schema:
  23. type: string
  24. default: created_at
  25. -
  26. name: dir
  27. in: query
  28. schema:
  29. type: string
  30. default: desc
  31. -
  32. name: offset
  33. in: query
  34. schema:
  35. type: string
  36. -
  37. name: limit
  38. in: query
  39. schema:
  40. type: string
  41. -
  42. name: search
  43. in: query
  44. description: 搜索关键字
  45. schema:
  46. type: string
  47. responses:
  48. 200:
  49. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  50. content:
  51. application/json:
  52. schema:
  53. type: object
  54. properties:
  55. ok:
  56. type: boolean
  57. message:
  58. type: string
  59. data:
  60. type: object
  61. properties:
  62. rows:
  63. type: array
  64. items:
  65. type: object
  66. properties: { id: { type: integer }, sent_uid: { type: string }, editor: { type: string }, content: { type: string }, landmark: { type: string }, pr_from: { type: string }, created_at: { type: string }, fork_from: { type: string }, fork_studio: { type: string }, accepter: { type: string } }
  67. count:
  68. type: integer
  69. 401:
  70. $ref: '../../main.yaml#/components/responses/Unauthorized'
  71. 422:
  72. $ref: '../../main.yaml#/components/responses/ValidationError'
  73. post:
  74. summary: '新建 sent_history'
  75. tags:
  76. - sent_history
  77. operationId: post_api_v2_sent_history
  78. description: 实现:`SentHistoryController@store`
  79. responses:
  80. 200:
  81. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  82. content:
  83. application/json:
  84. schema:
  85. type: object
  86. properties:
  87. ok:
  88. type: boolean
  89. message:
  90. type: string
  91. data:
  92. type: object
  93. 401:
  94. $ref: '../../main.yaml#/components/responses/Unauthorized'
  95. 422:
  96. $ref: '../../main.yaml#/components/responses/ValidationError'