swagger.yml

openapi: "3.0.2"
info:
  title: Dreamkast API
  version: "1.0.0"
  description: "This is a API definition of the Dreamakst. You can find a documentation of this API at http://api-docs.dev.cloudnativedays.jp/."
  license:
    name: "Apache 2.0"
    url: "http://www.apache.org/licenses/LICENSE-2.0.html"
servers:
  - url: http://localhost:8080/
  - url: http://api-mock.dev.cloudnativedays.jp/
  - url: http://dreamkast-api-mock.udcp.info/
paths:
  /api/v1/${eventAbbr}/my_profile:
    get:
      tags:
        - Profile
      parameters:
        - name: eventAbbr
          in: path
          description: ID of event
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Profile'
        '403':
          description: You don't logged in
  /api/v1/events/{eventAbbr}:
    get:
      tags:
        - Event
      parameters:
        - name: eventAbbr
          in: path
          description: ID of event
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Event'
        '400':
          description: Invalid [eventAbbr] supplied
        '404':
          description: Event not found
  /api/v1/tracks:
    get:
      tags:
        - Track
      parameters:
        - name: eventAbbr
          in: query
          description: abbr of event (e.g. cndt2020)
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Track'
        '400':
          description: Invalid [eventAbbr] supplied
        '404':
          description: Event not found
  
  /api/v1/tracks/{trackId}:
    get:
      tags:
        - Track
      parameters:
        - name: trackId
          in: path
          description: ID of track
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Track'
        '400':
          description: Invalid params supplied
        '404':
          description: Track not found
  /api/v1/tracks/{trackId}/viewer_count:
    get:
      tags:
        - Track
      parameters:
        - name: trackId
          in: path
          description: ID of track
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ViewerCount'
        '400':
          description: Invalid params supplied
        '404':
          description: Track not found
  /api/v1/talks:
    get:
      tags:
        - Talk
      parameters:
        - name: eventAbbr
          in: query
          description: abbr of event (e.g. cndt2020)
          required: true
          schema:
            type: string
        - name: trackId
          in: query
          description: ID of track
          required: false
          schema:
            type: string
        - name: conferenceDayIds
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Talk'
        '400':
          description: Invalid [eventAbbr] supplied
        '404':
          description: Event not found
  /api/v1/talks/{talkId}:
    get:
      tags:
        - Talk
      parameters:
        - name: talkId
          in: path
          description: ID of talk
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Talk'
        '400':
          description: Invalid params supplied
        '404':
          description: Talk not found
  /api/v1/talks/{talkId}/video_registration:
    get:
      tags:
        - VideoRegistration
      parameters:
        - name: talkId
          in: path
          description: ID of talk
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VideoRegistration'
        '400':
          description: Invalid params supplied
        '401':
          description: Unauthorized
        '404':
          description: Talk not found
    put:
      tags:
        - VideoRegistration
      parameters:
        - name: talkId
          in: path
          description: ID of talk
          required: true
          schema:
            type: string
      summary: Put VideoRegistration
      requestBody:
        description: Update video_registration
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VideoRegistration'
      responses:
        '200':
          description: OK
        '400':
          description: Invalid params supplied
        '401':
          description: Unauthorized
        '404':
          description: Talk not found
  /api/v1/chat_messages:
    get:
      tags:
        - ChatMessage
      parameters:
        - name: eventAbbr
          in: query
          description: abbr of event (e.g. cndt2020)
          required: true
          schema:
            type: string
        - name: roomId
          in: query
          description: ID of chat room
          required: true
          schema:
            type: string
        - name: roomType
          in: query
          description: Type of chat room
          required: true
          schema:
            type: string
        - name: createdFrom
          in: query
          description: YYYY-MM-DDThh:mm:ss+TZD (use UTC)
          required: false
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ChatMessage'
        '400':
          description: Invalid params supplied
        '404':
           description: ChatMessage not found
    post:
      tags:
        - ChatMessage
      summary: Post Chat Message
      requestBody:
        description: chat message to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChatMessage'
      responses:
        '201':
          description: CREATED
  /api/v1/chat_messages/{messageId}:
    put:
      tags:
        - ChatMessage
      summary: Update Chat Message
      parameters:
        - name: messageId
          in: path
          description: ID of ChatMessage
          required: true
          schema:
            type: string
      requestBody:
        description: chat message to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateChatMessage'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ChatMessage'
        '403':
          description: Don't have permission to update
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '400':
          description: Invalid params supplied
        '404':
           description: ChatMessage not found
  /api/v1/sponsors:
    get:
      tags:
        - Sponsor
      parameters:
        - name: eventAbbr
          in: query
          description: abbr of event (e.g. cndt2020)
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Sponsor'
        '400':
          description: Invalid params supplied
  /api/v1/booths/{boothId}:
    get:
      tags:
        - Booth
      parameters:
        - name: boothId
          in: path
          description: ID of booth
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Booth'
        '400':
          description: Invalid params supplied
        '404':
          description: Booth not found

components:
  schemas:
    Profile:
      type: object
      properties:
        id:
          type: number
        name:
          type: string
      required:
        - id
        - name
    Event:
      type: object
      additionalProperties: false
      properties:
        id:
          type: number
        name:
          type: string
        abbr:
          type: string
        status:
          type: string
        theme:
          type: string
        about:
          type: string
        privacy_policy:
          type: string
        privacy_policy_for_speaker:
          type: string
        copyright:
          type: string
        coc:
          type: string
        conferenceDays:
          type: array
          items:
            type: object
            properties:
              id:
                type: number
              date:
                type: string
      example:
        id: 2
        name: "CloudNative Days Spring 2020 ONLINE"
        abbr: "cndo2021"
        status: "closed"
        theme: "ともに踏み出すCloudNative祭"
        about: "『クラウドネイティブ』って何だっけ？ 私たち自身ずっと考えてきました。"
        privacy_policy: "プライバシーポリシーだよ"
        privacy_policy_for_speaker: "スピーカー向けのポリシーだよ"
        copyright: "CloudNative Days Committee"
        coc: "CoCだよ"
      required:
        - id
        - name
        - abbr
        - status
        - theme
        - about
        - privacy_policy
        - privacy_policy_for_speaker
        - copyright
        - coc
    Track:
      type: object
      additionalProperties: false
      properties:
        id:
          type: number
        name:
          type: string
        videoPlatform:
          type: string
        videoId:
          type: string
      example:
        id: 2
        name: "Track 2"
        videoPlatform: "vimeo"
        videoId: "453935827"
      required:
        - id
        - name
    ViewerCount:
      type: object
      additionalProperties: false
      properties:
        conference_id:
          type: number
        track_id:
          type: number
        talk_id:
          type: number
        viewer_count:
          type: number
      example:
        id: 4
        track_id: 20
        talk_id: 123
        viewer_count: 6
      required:
        - track_id
        - viewer_count
    Talk:
      type: object
      additionalProperties: false
      properties:
        id:
          type: number
        trackId:
          type: number
        videoPlatform:
          type: string
        videoId:
          type: string
        title:
          type: string
        abstract:
          type: string
        speakers:
          description: array of speakers name
          type: array
          items:
            type: object
            properties:
              id:
                type: number
              name:
                type: string
        dayId:
          type: number
        showOnTimetable:
          type: boolean
        startTime:
          type: string
        endTime:
          type: string
        talkDuration:
          type: number
        talkDifficulty:
          type: string
        talkCategory:
          type: string
        onAir:
          type: boolean
        documentUrl:
          type: string
        conferenceDayId:
          type: number
        conferenceDayDate:
          type: string
          format: date
      example:
        - id: 1
          trackId: 2
          videoPlatform: "vimeo"
          videoId: "453935827"
          title: "やんごとなき発表"
          abstract: "やんごとなき発表をします"
          speakers: "やんごとない人"
          dayId: 1
          showOnTimetable: true
          startTime: "Sat, 23 Jan 2021 09:00:00 GMT"
          endTime: "Sat, 23 Jan 2021 09:20:00 GMT"
          talkDuration: 40
          talkDifficulty: "moderate"
          talkCategory: "CI/CD"
          onAir: true
          documentUrl: "http://documents"
        - id: 2
          trackId: 2
          videoPlatform: "vimeo"
          videoId: "453935827"
          title: "めちゃすごい発表"
          abstract: "めちゃすごい発表をします"
          speakers: "めちゃすごい人"
          dayId: 1
          showOnTimetable: true
          startTime: "Sat, 23 Jan 2021 09:00:00 GMT"
          endTime: "Sat, 23 Jan 2021 09:20:00 GMT"
          talkDuration: 40
          talkDifficulty: "moderate"
          talkCategory: "CI/CD"
          onAir: true
          documentUrl: "http://documents"
      required:
        - id
        - trackId
        - videoId
        - title
        - abstract
        - speakers
        - dayId
        - showOnTimetable
        - startTime
        - endTime
        - talkDuration
        - talkDifficulty
        - talkCategory
    ChatMessage:
      type: object
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/ChatMessageProperties'
      required:
        - [eventAbbr]
        - roomId
        - body
        - messageType
      example:
        id: 2
        body: "foo bar"
        createdAt: "2021-01-30T10:06:33.938Z"
    UpdateChatMessage:
      type: object
      additionalProperties: false
      allOf:
        - $ref: '#/components/schemas/ChatMessageProperties'
      required:
        - [eventAbbr]
        - body
    ChatMessageProperties:
      type: object
      properties:
        id:
          type: number
        profileId:
          type: number
        speakerId:
          type: number
          nullable: true
        eventAbbr:
          type: string
        roomId:
          type: number
        roomType:
          type: string
        body:
          type: string
        createdAt:
          type: string
        messageType:
          type: string
          enum: [chat, qa]
        replyTo:
          type: number
          nullable: true
    Sponsor:
      type: object
      additionalProperties: false
      properties:
        id:
          type: number
        eventAbbr:
          type: string
        name:
          type: string
        abbr:
          type: string
        url:
          type: string
        logo_url:
          type: string
        sponsorType:
          type: array
          items:
            type: string
        booth:
          type: object
          properties:
            id:
              type: number
            opened:
              type: boolean
      example:
        - id: 1
          conference_id: 2
          name: スポンサー1株式会社
          abbr: sponsor1
          url: https://example.com/
          logo_url: cndo2021/trademark.png
        - id: 2
          conference_id: 2
          name: スポンサー2株式会社
          abbr: sponsor2
          url: https://example.com/
          logo_url: dummy.png
      required:
        - id
        - eventAbbr
        - name
        - abbr
        - url
        - logo_url
    Booth:
      type: object
      additionalProperties: false
      properties:
        id:
          type: number
        sponsorId:
          type: number
        sponsorName:
          type: string
        published:
          type: boolean
        description:
          type: string
        url:
          type: string
        abbr:
          type: string
        text:
          type: string
        logoUrl:
          type: string
        vimeoUrl:
          type: string
        miroUrl:
          type: string
        pdfUrls:
          type: array
          items:
            type: object
            properties:
              url:
                type: string
              title:
                type: string
        keyImageUrls:
          type: array
          items:
            type: string
      required:
        - id
        - sponsorId
        - sponsorName
        - published
        - description
        - abbr
        - text
        - logoUrl
        - vimeoUrl
        - miroUrl
        - pdfUrls
        - keyImageUrls
    VideoRegistration:
      type: object
      additionalProperties: false
      properties:
        url:
          type: string
        status:
          type: string
          enum: [unsubmitted, submitted, confirmed, invalid_format]
        statistics:
          type: object
        createdAt:
          type: string
        updatedAt:
          type: string
      required:
        - status
      example:
        status: "confirmed"
        url: "https://uploader.cloudnativedays.jp/hoge"
        statistics: {
            "file_name": "XX",
            "resolution_status": "OK",
            "resolution_type": "FHD",
            "aspect_status": "OK",
            "aspect_ratio": "16:9",
            "duration_status": "OK",
            "duration_description": "Appropriate media duration.",
            "size_status": "OK",
            "size_description": "Appropriate media size."
        }
        createdAt: "2022-04-30T10:06:33.938Z"
        updatedAt: "2022-05-30T22:02:11.123Z"