| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148 |
- # 由 openapi/scripts/generate.php 生成,请勿手改;补充写到 overrides/v2-notification.yaml
- get:
- summary: '列出 notification'
- tags:
- - notification
- operationId: get_api_v2_notification
- description: 实现:`NotificationController@index`
- parameters:
- -
- name: view
- in: query
- schema:
- type: string
- enum:
- - to
- -
- name: status
- in: query
- schema:
- type: string
- -
- name: order
- in: query
- schema:
- type: string
- default: created_at
- -
- name: dir
- in: query
- schema:
- type: string
- default: desc
- -
- name: offset
- in: query
- schema:
- type: string
- -
- name: limit
- 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:
- type: object
- properties: { id: { type: integer }, from: { type: string }, to: { type: string }, url: { type: string }, content: { type: string }, content_type: { type: string }, res_type: { type: string }, res_id: { type: integer }, status: { type: integer }, created_at: { type: string }, updated_at: { type: string }, 'pr data': { type: string }, channel: { type: string }, title: { type: string }, book_title: { type: string } }
- count:
- type: integer
- 401:
- $ref: '../../main.yaml#/components/responses/Unauthorized'
- 422:
- $ref: '../../main.yaml#/components/responses/ValidationError'
- post:
- summary: '新建 notification'
- tags:
- - notification
- operationId: post_api_v2_notification
- description: 实现:`NotificationController@store`
- requestBody:
- required: false
- content:
- application/json:
- schema:
- type: object
- properties:
- to:
- type: string
- url:
- type: string
- content:
- type: string
- res_type:
- type: string
- res_id:
- type: string
- channel:
- 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:
- id:
- type: integer
- from:
- type: string
- to:
- type: string
- url:
- type: string
- content:
- type: string
- content_type:
- type: string
- res_type:
- type: string
- res_id:
- type: integer
- status:
- type: integer
- created_at:
- type: string
- updated_at:
- type: string
- 'pr data':
- type: string
- channel:
- type: string
- title:
- type: string
- book_title:
- type: string
- 401:
- $ref: '../../main.yaml#/components/responses/Unauthorized'
- 422:
- $ref: '../../main.yaml#/components/responses/ValidationError'
|