# 由 openapi/scripts/generate.php 生成，请勿手改；补充写到 overrides/v2-relation.yaml
get:
  summary: 'Supports optional filters: case, search, name, from, to, match, category.'
  tags:
    - relation
  operationId: get_api_v2_relation
  description: |-
    When the `vocabulary` parameter is present, returns the full unfiltered
    list from cache (suitable for populating UI dropdowns / autocomplete).

    实现：`RelationController@index`
  parameters:
    -
      name: vocabulary
      in: query
      schema:
        type: boolean
    -
      name: search
      in: query
      description: 搜索关键字
      schema:
        type: string
    -
      name: order
      in: query
      description: 排序字段
      schema:
        type: string
    -
      name: dir
      in: query
      description: 排序方向
      schema:
        type: string
        enum:
          - desc
          - asc
    -
      name: limit
      in: query
      description: 每页记录数
      schema:
        type: number
    -
      name: offset
      in: query
      description: 从第几条记录开始提取
      schema:
        type: number
  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
                  count:
                    type: integer
    401:
      $ref: '../../main.yaml#/components/responses/Unauthorized'
    422:
      $ref: '../../main.yaml#/components/responses/ValidationError'
post:
  summary: 'Requires authentication. Invalidates the vocabulary cache on success.'
  tags:
    - relation
  operationId: post_api_v2_relation
  description: 实现：`RelationController@store`
  requestBody:
    required: true
    content:
      application/json:
        schema:
          type: object
          properties:
            name:
              type: string
              description: 规则：required
            case:
              type: string
            category:
              type: string
          required:
            - name
  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
                  name:
                    type: string
                  case:
                    type: string
                  from:
                    type: string
                  to:
                    type: string
                  match:
                    type: string
                  category:
                    type: string
                  created_at:
                    type: string
                  updated_at:
                    type: string
                  editor:
                    type: string
                  category_channel:
                    type: string
                  channelId:
                    type: string
                  word:
                    type: string
                  meaning:
                    type: string
                  name_channel:
                    type: string
    401:
      $ref: '../../main.yaml#/components/responses/Unauthorized'
    422:
      $ref: '../../main.yaml#/components/responses/ValidationError'