restapi.yaml

openapi: 3.0.0
servers:
  - url: 'http://localhost:8080/api/v2'
    description: 'Base Karcioszki Java server'
    variables: {}
info:
  version: 2.0.0
  title: Karcioszki REST APIv2
paths:
  /players/{username}:
    post:
      tags:
        - Players API
      parameters:
        - name: username
          in: 'path'
          required: true
          schema:
            type: string
      responses:
        '200':
          description: "Create user"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Player'
  /packages:
    get:
      description: "Get list of all created Word Packages"
      tags:
        - Word Package API
      parameters:
        - name: public
          in: 'query'
          required: false
          schema:
            type: string
        - name: private
          in: 'query'
          required: false
          schema:
            type: string
      responses:
        '200':
          description: "Get all packages"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WordsPackageDTO'
    post:
      tags:
        - Word Package API
      requestBody:
        description: Word Package creation
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WordsPackage'
      responses:
        '201':
          description: 'Created'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WordsPackageDTO'
    put:
      tags:
        - Word Package API
      requestBody:
        description: Word Package creation
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WordsPackage'
      responses:
        '200':
          description: 'Updated'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WordsPackage'
  /packages/{id}:
    post:
      tags:
        - Word Package API
      parameters:
        - name: id
          in: 'path'
          required: true
          schema:
            type: number
      requestBody:
        description: Private package password
        required: false
        content:
          application/json:
            schema:
              type: string
      responses:
        '204':
          description: "No content"
        '200':
          description: "Package data"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WordsPackageDTO'
        '403':
          description: "Wrong access password"
    delete:
      tags:
        - Word Package API
      parameters:
        - name: id
          in: 'path'
          required: true
          schema:
            type: number
      responses:
        '200':
          description: "Package data"
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type:
                      string
  /game:
    get:
      tags:
        - GameRunner Controller API
      responses:
        '200':
          description: "Get all game List"
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GameRunnerHubDTO'
  /game/create:
    post:
      tags:
        - GameRunner Controller API
      parameters:
        - name: pid
          in: 'query'
          required: true
          schema:
            type: number
        - name: n
          in: 'query'
          required: true
          schema:
            type: string
        - name: lim
          in: 'query'
          required: true
          schema:
            type: number
      responses:
        '200':
          description: "Get all game List"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GameRunnerDTO'
  /game/{id}:
    get:
      tags:
        - GameRunner Controller API
      parameters:
        - name: id
          in: 'path'
          required: true
          schema:
            type: number
        - name: p
          in: 'query'
          required: true
          schema:
            type: string
      responses:
        '200':
          description: "Join Game"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GameRunnerDTO'
    delete:
      tags:
        - GameRunner Controller API
      parameters:
        - name: id
          in: 'path'
          required: true
          schema:
            type: number
        - name: p
          in: 'query'
          required: true
          schema:
            type: string
      responses:
        '200':
          description: "Leave Game"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GameRunnerDTO'
  /game/{id}/start:
    get:
      tags:
        - GameRunner Controller API
      parameters:
        - name: id
          in: 'path'
          required: true
          schema:
            type: number
      responses:
        '200':
          description: "Join Game"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GameRunnerDTO'
        '423':
          description: "Start locked"
  /game/{id}/move/{moves}:
    get:
      description: "Set number of moves for active team"
      tags:
        - GameRunner Controller API
      parameters:
        - name: id
          in: 'path'
          required: true
          schema:
            type: number
        - name: moves
          in: 'path'
          required: true
          schema:
            type: number
      responses:
        '200':
          description: ""
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GameRunnerDTO'
  /game/{id}/{cardId}:
    get:
      tags:
        - GameRunner Controller API
      parameters:
        - name: id
          in: 'path'
          required: true
          schema:
            type: number
        - name: cardId
          in: 'path'
          required: true
          schema:
            type: number
      responses:
        '200':
          description: "Join Game"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GameRunnerDTO'

        '423':
          description: "Start locked"


components:
  schemas:
    Player:
      type: object
      properties:
        id:
          type: number
        username:
          type: string
    GameRunnerHubDTO:
      type: object
      properties:
        id:
          type: number
        name:
          type: string
        wordPackage:
          $ref: '#/components/schemas/WordsPackageDTO'
    GameRunnerDTO:
      type: object
      properties:
        id:
          type: number
        name:
          type: string
        state:
          type: object
        wordPackage:
          $ref: '#/components/schemas/WordsPackageDTO'
        players:
          type: array
          items:
            type: object
        cards:
          type: array
          items:
            type: object
        remainingRedCards:
          type: number
        remainingBlueCards:
          type: number
    WordsPackageDTO:
      type: object
      properties:
        id:
          type: number
        author:
          type: string
        packageName:
          type: string
        coverImage:
          type: string
        cards:
          type: array
          items:
            type: string
        privatePackage:
          type: boolean
    WordsPackage:
      type: object
      properties:
        id:
          type: number
        author:
          type: string
        packageName:
          type: string
        editPassword:
          type: string
        coverImage:
          type: string
        cards:
          type: array
          items:
            type: string
        privatePackage:
          type: boolean
        privatePassword:
          type: string
security: []
tags: []