v2-dict-info.yaml 2.2 KB

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