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

# 由 openapi/scripts/generate.php 生成，请勿手改；补充写到 overrides/v2-course.yaml
get:
  summary: '列出 course'
  tags:
    - course
  operationId: get_api_v2_course
  description: 实现：`CourseController@index`
  parameters:
    -
      name: view
      in: query
      schema:
        type: string
        enum:
          - new
          - open
          - close
          - create
          - study
          - teach
    -
      name: studio
      in: query
      schema:
        type: string
    -
      name: search
      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
  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 }, title: { type: string }, subtitle: { type: string }, summary: { type: string }, sign_up_message: { type: string }, teacher: { type: string }, course_count: { type: integer }, publicity: { type: string }, start_at: { type: string }, end_at: { type: string }, sign_up_start_at: { type: string }, sign_up_end_at: { type: string }, content: { type: string }, content_type: { type: string }, cover: { type: string }, channel_id: { type: integer }, join: { type: string }, number: { type: string }, request_exp: { type: string }, studio: { type: string }, created_at: { type: string }, updated_at: { type: string }, member_count: { type: integer }, members: { type: string }, my_role: { type: string }, cover_url: { type: string }, anthology_id: { type: integer }, anthology_title: { type: string }, anthology_owner: { type: string }, channel_name: { type: string }, channel_owner: { type: string }, my_status: { type: string }, my_status_id: { type: integer }, count_progressing: { type: string } }
                  count:
                    type: integer
    401:
      $ref: '../../main.yaml#/components/responses/Unauthorized'
    422:
      $ref: '../../main.yaml#/components/responses/ValidationError'
post:
  summary: '新建 course'
  tags:
    - course
  operationId: post_api_v2_course
  description: 实现：`CourseController@store`
  requestBody:
    required: false
    content:
      application/json:
        schema:
          type: object
          properties:
            studio:
              type: string
            title:
              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
                  title:
                    type: string
                  subtitle:
                    type: string
                  summary:
                    type: string
                  sign_up_message:
                    type: string
                  teacher:
                    type: string
                  course_count:
                    type: integer
                  publicity:
                    type: string
                  start_at:
                    type: string
                  end_at:
                    type: string
                  sign_up_start_at:
                    type: string
                  sign_up_end_at:
                    type: string
                  content:
                    type: string
                  content_type:
                    type: string
                  cover:
                    type: string
                  channel_id:
                    type: integer
                  join:
                    type: string
                  number:
                    type: string
                  request_exp:
                    type: string
                  studio:
                    type: string
                  created_at:
                    type: string
                  updated_at:
                    type: string
                  member_count:
                    type: integer
                  members:
                    type: string
                  my_role:
                    type: string
                  cover_url:
                    type: string
                  anthology_id:
                    type: integer
                  anthology_title:
                    type: string
                  anthology_owner:
                    type: string
                  channel_name:
                    type: string
                  channel_owner:
                    type: string
                  my_status:
                    type: string
                  my_status_id:
                    type: integer
                  count_progressing:
                    type: string
    401:
      $ref: '../../main.yaml#/components/responses/Unauthorized'
    422:
      $ref: '../../main.yaml#/components/responses/ValidationError'