mint/openapi/public/assets/protocol/resources/auto/v2-webhook.yaml

# 由 openapi/scripts/generate.php 生成，请勿手改；补充写到 overrides/v2-webhook.yaml
get:
  summary: '列出 webhook'
  tags:
    - webhook
  operationId: get_api_v2_webhook
  description: 实现：`WebHookController@index`
  parameters:
    -
      name: view
      in: query
      schema:
        type: string
        enum:
          - channel
    -
      name: id
      in: query
      schema:
        type: string
    -
      name: order
      in: query
      schema:
        type: string
        default: updated_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 }, res_type: { type: string }, res_id: { type: integer }, url: { type: string }, receiver: { type: string }, event: { type: string }, status: { type: integer }, fail: { type: string }, success: { type: string }, created_at: { type: string }, updated_at: { type: string } }
                  count:
                    type: integer
    401:
      $ref: '../../main.yaml#/components/responses/Unauthorized'
    422:
      $ref: '../../main.yaml#/components/responses/ValidationError'
post:
  summary: '新建 webhook'
  tags:
    - webhook
  operationId: post_api_v2_webhook
  description: 实现：`WebHookController@store`
  requestBody:
    required: true
    content:
      application/json:
        schema:
          type: object
          properties:
            res_type:
              type: string
              description: 规则：required
            res_id:
              type: string
              description: 规则：required
            url:
              type: string
              description: 规则：required
            receiver:
              type: string
              description: 规则：required
            event:
              type: string
            status:
              type: string
              default: active
          required:
            - res_type
            - res_id
            - url
            - receiver
  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
                  res_type:
                    type: string
                  res_id:
                    type: integer
                  url:
                    type: string
                  receiver:
                    type: string
                  event:
                    type: string
                  status:
                    type: integer
                  fail:
                    type: string
                  success:
                    type: string
                  created_at:
                    type: string
                  updated_at:
                    type: string
    401:
      $ref: '../../main.yaml#/components/responses/Unauthorized'
    422:
      $ref: '../../main.yaml#/components/responses/ValidationError'