| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156 |
- # 由 openapi/scripts/generate.php 生成,请勿手改;补充写到 overrides/v2-progress.yaml
- get:
- summary: '列出 progress'
- tags:
- - progress
- operationId: get_api_v2_progress
- description: 实现:`ProgressChapterController@index`
- parameters:
- -
- name: progress
- in: query
- schema:
- type: string
- -
- name: offset
- in: query
- schema:
- type: string
- -
- name: limit
- in: query
- schema:
- type: string
- -
- name: channel
- in: query
- schema:
- type: string
- -
- name: view
- in: query
- schema:
- type: string
- enum:
- - ids
- - studio
- - tag
- - chapter-tag
- - lang
- - channel-type
- - channel
- - chapter_channels
- - chapter
- - top
- - search
- - public
- -
- name: book
- in: query
- schema:
- type: string
- -
- name: par
- in: query
- schema:
- type: string
- -
- name: name
- in: query
- schema:
- type: string
- -
- name: public
- in: query
- schema:
- type: string
- -
- name: tags
- in: query
- schema:
- type: string
- -
- name: channel_type
- in: query
- schema:
- type: string
- -
- name: lang
- in: query
- schema:
- type: string
- -
- name: studio
- in: query
- schema:
- type: string
- -
- name: key
- in: query
- schema:
- type: string
- -
- name: order
- in: query
- schema:
- type: string
- -
- name: dir
- in: query
- schema:
- type: string
- -
- name: search
- in: query
- description: 搜索关键字
- schema:
- type: string
- responses:
- 200:
- description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
- content:
- application/json:
- schema:
- type: object
- properties:
- ok:
- type: boolean
- message:
- type: string
- data:
- type: object
- properties:
- rows:
- type: array
- items:
- anyOf: [{ type: object, description: view=chapter_channels, properties: { book: { type: integer }, para: { type: integer }, uid: { type: string }, channel_id: { type: string }, name: { type: string }, type: { type: string }, progress: { type: number }, updated_at: { type: string }, channel: { type: object, properties: { uid: { type: string }, name: { type: string }, type: { type: string } } } } }, { type: object, description: view=ids, properties: { id: { type: string } } }, { type: object, description: view=channel, properties: { channel_id: { type: string }, count: { type: integer }, studio: { type: object, properties: { id: { type: string }, nickName: { type: string }, realName: { type: string }, studioName: { type: string }, avatar: { type: string } } }, channel: { type: object, properties: { name: { type: string }, summary: { type: string, nullable: true }, lang: { type: string } } } } }]
- count:
- type: integer
- 401:
- $ref: '../../main.yaml#/components/responses/Unauthorized'
- 422:
- $ref: '../../main.yaml#/components/responses/ValidationError'
- post:
- summary: '新建 progress'
- tags:
- - progress
- operationId: post_api_v2_progress
- description: 实现:`ProgressChapterController@store`
- responses:
- 200:
- description: '成功。业务失败时 HTTP 仍可能为 200,以 ok 字段为准。'
- content:
- application/json:
- schema:
- type: object
- properties:
- ok:
- type: boolean
- message:
- type: string
- data:
- type: object
- 401:
- $ref: '../../main.yaml#/components/responses/Unauthorized'
- 422:
- $ref: '../../main.yaml#/components/responses/ValidationError'
|