v2-channel-name-name.yaml 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. # 由 openapi/scripts/generate.php 生成,请勿手改;补充写到 overrides/v2-channel-name-name.yaml
  2. get:
  3. summary: '按名称获取 channel'
  4. tags:
  5. - channel-name
  6. operationId: get_api_v2_channel_name_name_
  7. description: 实现:`ChannelController@showByName`
  8. parameters:
  9. -
  10. name: name
  11. in: path
  12. required: true
  13. schema:
  14. type: string
  15. description: 'channel 名称'
  16. responses:
  17. 200:
  18. description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
  19. content:
  20. application/json:
  21. schema:
  22. type: object
  23. properties:
  24. ok:
  25. type: boolean
  26. message:
  27. type: string
  28. data:
  29. type: object
  30. properties:
  31. uid:
  32. type: string
  33. name:
  34. type: string
  35. summary:
  36. type: string
  37. nullable: true
  38. type:
  39. type: string
  40. studio:
  41. type: object
  42. properties:
  43. id: { type: string }
  44. nickName: { type: string }
  45. realName: { type: string }
  46. studioName: { type: string }
  47. nullable: true
  48. lang:
  49. type: string
  50. is_system:
  51. type: boolean
  52. status:
  53. type: integer
  54. created_at:
  55. type: string
  56. updated_at:
  57. type: string
  58. source_type:
  59. type: string
  60. nullable: true
  61. source_id:
  62. type: string
  63. nullable: true
  64. progress:
  65. type: number
  66. description: 仅在部分查询口径下返回。
  67. role:
  68. type: string
  69. description: 仅在部分查询口径下返回。
  70. 401:
  71. $ref: '../../main.yaml#/components/responses/Unauthorized'
  72. 422:
  73. $ref: '../../main.yaml#/components/responses/ValidationError'