v2-pali-search-data.yaml 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  1. # 由 openapi/scripts/generate.php 生成,请勿手改;补充写到 overrides/v2-pali-search-data.yaml
  2. get:
  3. summary: '列出 pali-search-data'
  4. tags:
  5. - pali-search-data
  6. operationId: get_api_v2_pali_search_data
  7. description: 实现:`SearchPaliDataController@index`
  8. parameters:
  9. -
  10. name: book
  11. in: query
  12. schema:
  13. type: string
  14. -
  15. name: page_size
  16. in: query
  17. schema:
  18. type: string
  19. -
  20. name: start
  21. in: query
  22. schema:
  23. type: string
  24. -
  25. name: search
  26. in: query
  27. description: 搜索关键字
  28. schema:
  29. type: string
  30. -
  31. name: order
  32. in: query
  33. description: 排序字段
  34. schema:
  35. type: string
  36. -
  37. name: dir
  38. in: query
  39. description: 排序方向
  40. schema:
  41. type: string
  42. enum:
  43. - desc
  44. - asc
  45. -
  46. name: limit
  47. in: query
  48. description: 每页记录数
  49. schema:
  50. type: number
  51. -
  52. name: offset
  53. in: query
  54. description: 从第几条记录开始提取
  55. schema:
  56. type: number
  57. responses:
  58. 200:
  59. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  60. content:
  61. application/json:
  62. schema:
  63. type: object
  64. properties:
  65. ok:
  66. type: boolean
  67. message:
  68. type: string
  69. data:
  70. type: object
  71. properties:
  72. rows:
  73. type: array
  74. items:
  75. type: object
  76. count:
  77. type: integer
  78. 401:
  79. $ref: '../../main.yaml#/components/responses/Unauthorized'
  80. 422:
  81. $ref: '../../main.yaml#/components/responses/ValidationError'
  82. post:
  83. summary: '新建 pali-search-data'
  84. tags:
  85. - pali-search-data
  86. operationId: post_api_v2_pali_search_data
  87. description: 实现:`SearchPaliDataController@store`
  88. responses:
  89. 200:
  90. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  91. content:
  92. application/json:
  93. schema:
  94. type: object
  95. properties:
  96. ok:
  97. type: boolean
  98. message:
  99. type: string
  100. data:
  101. type: object
  102. 401:
  103. $ref: '../../main.yaml#/components/responses/Unauthorized'
  104. 422:
  105. $ref: '../../main.yaml#/components/responses/ValidationError'