v2-article-fts.yaml 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  1. # 由 openapi/scripts/generate.php 生成,请勿手改;补充写到 overrides/v2-article-fts.yaml
  2. get:
  3. summary: 'http://127.0.0.1:8000/api/v2/article-fts?id=df6c6609-6fc1-42d0-9ef1-535ef3e702c9&anthology=697c9169-cb9d-4a60-8848-92745e467bab&channesl=7fea264d-7a26-40f8-bef7-bc95102760fb'
  4. tags:
  5. - article-fts
  6. operationId: get_api_v2_article_fts
  7. description: 实现:`ArticleFtsController@index`
  8. parameters:
  9. -
  10. name: from
  11. in: query
  12. schema:
  13. type: string
  14. -
  15. name: anthology
  16. in: query
  17. schema:
  18. type: string
  19. -
  20. name: id
  21. in: query
  22. schema:
  23. type: string
  24. -
  25. name: channels
  26. in: query
  27. schema:
  28. type: string
  29. -
  30. name: key
  31. in: query
  32. schema:
  33. type: string
  34. -
  35. name: search
  36. in: query
  37. description: 搜索关键字
  38. schema:
  39. type: string
  40. -
  41. name: order
  42. in: query
  43. description: 排序字段
  44. schema:
  45. type: string
  46. -
  47. name: dir
  48. in: query
  49. description: 排序方向
  50. schema:
  51. type: string
  52. enum:
  53. - desc
  54. - asc
  55. -
  56. name: limit
  57. in: query
  58. description: 每页记录数
  59. schema:
  60. type: number
  61. -
  62. name: offset
  63. in: query
  64. description: 从第几条记录开始提取
  65. schema:
  66. type: number
  67. responses:
  68. 200:
  69. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  70. content:
  71. application/json:
  72. schema:
  73. type: object
  74. properties:
  75. ok:
  76. type: boolean
  77. message:
  78. type: string
  79. data:
  80. type: object
  81. properties:
  82. rows:
  83. type: array
  84. items:
  85. type: object
  86. count:
  87. type: integer
  88. 401:
  89. $ref: '../../main.yaml#/components/responses/Unauthorized'
  90. 422:
  91. $ref: '../../main.yaml#/components/responses/ValidationError'
  92. post:
  93. summary: '新建 article-fts'
  94. tags:
  95. - article-fts
  96. operationId: post_api_v2_article_fts
  97. description: 实现:`ArticleFtsController@store`
  98. responses:
  99. 200:
  100. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  101. content:
  102. application/json:
  103. schema:
  104. type: object
  105. properties:
  106. ok:
  107. type: boolean
  108. message:
  109. type: string
  110. data:
  111. type: object
  112. 401:
  113. $ref: '../../main.yaml#/components/responses/Unauthorized'
  114. 422:
  115. $ref: '../../main.yaml#/components/responses/ValidationError'