v2-studio.yaml 2.4 KB

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