swagger.yaml

swagger: '2.0'
info:
  description: This is a simple API
  version: 1.0.0
  title: Back(H)and API
  contact:
    email: mail@example.com
  license:
    name: Apache 2.0
    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
host: api.example.com
basePath: /Hockey-Tipp/Back_H_and/1.0.0
tags:
  - name: Admin only
    description: Secured Admin-only calls
  - name: Standard
    description: Operations available to everyone
  - name: Game
    description: Operations touching games
  - name: Game Tipp
    description: Operations touching game tipps
  - name: Game Result
    description: Operations touching game results
  - name: Season
    description: Operations touching seasons
  - name: Season Tipp
    description: Operations touching season tipps
  - name: Season Result
    description: Operations touching season results
  - name: Playoff Series
    description: Operations touching playoff series
  - name: Tippers
    description: Operations touching tippers
  - name: Admins
    description: Operations touching admins
  - name: Playoff Series Result
    description: Operations touching playoff series result
  - name: Teams
    description: Operations touching teams
  - name: Playoff Game
    description: Operations touching playoff games
  - name: Playoff Series Tipp
    description: Operations touching playoff series tipps
  - name: Analysis
    description: Operations giving different analysis options
schemes:
  - https
paths:
  /login:
    post:
      tags:
        - Standard
      summary: path to login on API
      description: >
        Post to this path to authenticate yourself at the API. You will receive
        a JWT Token you can use to authenticate yourself for future use in this
        session.
      operationId: login
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: authStuff
          description: 'auth stuff tbd --> Basic Auth, OAuth, ...?'
          required: true
          schema:
            $ref: '#/definitions/AuthReq'
      responses:
        '200':
          description: Authentication OK
          schema:
            $ref: '#/definitions/AuthRes'
        '400':
          description: Bad request
        '403':
          description: Not Authorized
  /tippers:
    get:
      tags:
        - Standard
        - Tippers
      summary: get all tippers
      description: >
        Gets all tippers. Filters and limiting can be applied through described
        GET paramaters. When providing the ownOnlyFlag option in the query only
        the own account will be returned
      operationId: getTippers
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: skip
          in: query
          description: number of records to skip for pagination
          required: false
          type: integer
          minimum: 0
          format: int32
        - name: limit
          in: query
          description: maximum number of records to return
          required: false
          type: integer
          maximum: 50
          minimum: 0
          format: int32
        - name: filter
          in: query
          description: >-
            filter string (similar to OData convention but only simple
            conditions)
          required: false
          type: string
          maxLength: 140
        - name: ownOnly
          in: query
          description: filter for only your own profile
          required: false
          type: boolean
        - name: includeInactive
          in: query
          description: include inactive tippers in selection
          required: false
          type: boolean
      responses:
        '200':
          description: search results matching criteria
          schema:
            type: array
            items:
              $ref: '#/definitions/Tipper'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
    post:
      tags:
        - Admin only
        - Tippers
      summary: create new tipper
      description: |
        Endpoint to create tippers. Protected and only available to admins.
      operationId: createTipper
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: tipper
          description: tipper info to add
          required: true
          schema:
            $ref: '#/definitions/Tipper'
      responses:
        '201':
          description: season created
          schema:
            $ref: '#/definitions/Tipper'
        '400':
          description: 'invalid input, object invalid'
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
  /tippers/{tipper}:
    get:
      tags:
        - Standard
        - Tippers
      summary: gets single tipper by ID
      description: |
        By passing in the appropriate options, you can find a single tipper
      operationId: getTipper
      produces:
        - application/json
      parameters:
        - name: tipper
          in: path
          description: tipper ID
          required: true
          type: string
      responses:
        '200':
          description: single tipper entity
          schema:
            $ref: '#/definitions/Tipper'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
    delete:
      tags:
        - Standard
        - Tippers
      summary: deletes tipper instance
      description: |
        Deletes Tipper. Only admins and oneself can delete a tipper account 
      operationId: deleteTipper
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: tipper
          in: path
          description: tipper ID
          required: true
          type: string
      responses:
        '204':
          description: Tipper deleted
        '400':
          description: invalid input
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
    patch:
      tags:
        - Standard
        - Tippers
      summary: updates tipper info
      description: |
        Updates Tipper. Only admins and oneself can update a tipper account 
      operationId: updateTipper
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: tipper
          in: path
          description: tipper ID
          required: true
          type: string
        - in: body
          name: tipper
          description: tipper entity to be updated
          required: true
          schema:
            $ref: '#/definitions/Tipper'
      responses:
        '204':
          description: tipper updated
        '400':
          description: 'invalid input, object invalid'
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
  /admins:
    get:
      tags:
        - Standard
        - Admins
      summary: get all admins
      description: >
        Gets all admins. Filters and limiting can be applied through described
        GET paramaters.
      operationId: getAdmins
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: skip
          in: query
          description: number of records to skip for pagination
          required: false
          type: integer
          minimum: 0
          format: int32
        - name: limit
          in: query
          description: maximum number of records to return
          required: false
          type: integer
          maximum: 50
          minimum: 0
          format: int32
        - name: filter
          in: query
          description: >-
            filter string (similar to OData convention but only simple
            conditions)
          required: false
          type: string
          maxLength: 140
      responses:
        '200':
          description: search results matching criteria
          schema:
            type: array
            items:
              $ref: '#/definitions/Admin'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
    post:
      tags:
        - Admin only
        - Admins
      summary: create new admin
      description: |
        Endpoint to create admins. Protected and only available to admins.
      operationId: createAdmin
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: admin
          description: admin info to add
          required: true
          schema:
            $ref: '#/definitions/Admin'
      responses:
        '201':
          description: season created
          schema:
            $ref: '#/definitions/Admin'
        '400':
          description: 'invalid input, object invalid'
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
  /admins/{tipper}:
    get:
      tags:
        - Admin only
        - Admins
      summary: gets single admin by ID
      description: |
        By passing in the appropriate options, you can find a single admin
      operationId: getAdmin
      produces:
        - application/json
      parameters:
        - name: tipper
          in: path
          description: tipper ID of admin
          required: true
          type: string
      responses:
        '200':
          description: single admin entity
          schema:
            $ref: '#/definitions/Admin'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
    delete:
      tags:
        - Admin only
        - Admins
      summary: deletes admin instance
      description: |
        Deletes Admin. 
      operationId: deleteAdmin
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: tipper
          in: path
          description: tipper ID of admin
          required: true
          type: string
      responses:
        '204':
          description: Admin deleted
        '400':
          description: invalid input
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
    patch:
      tags:
        - Admin only
        - Admins
      summary: updates admin info
      description: |
        Updates Admin.  
      operationId: updateAdmin
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: tipper
          in: path
          description: tipper ID of admin
          required: true
          type: string
        - in: body
          name: admin
          description: admin entity to be updated
          required: true
          schema:
            $ref: '#/definitions/Admin'
      responses:
        '204':
          description: admin updated
        '400':
          description: 'invalid input, object invalid'
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
  /teams:
    get:
      tags:
        - Standard
        - Teams
      summary: get all teams
      description: >
        Gets all teams. Filters and limiting can be applied through described
        GET paramaters. 
      operationId: getTeams
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: skip
          in: query
          description: number of records to skip for pagination
          required: false
          type: integer
          minimum: 0
          format: int32
        - name: limit
          in: query
          description: maximum number of records to return
          required: false
          type: integer
          maximum: 50
          minimum: 0
          format: int32
        - name: filter
          in: query
          description: >-
            filter string (similar to OData convention but only simple
            conditions)
          required: false
          type: string
          maxLength: 140
      responses:
        '200':
          description: search results matching criteria
          schema:
            type: array
            items:
              $ref: '#/definitions/Team'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
    post:
      tags:
        - Admin only
        - Teams
      summary: create new team
      description: |
        Endpoint to create teams. Protected and only available to admins.
      operationId: createTeam
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: team
          description: team info to add
          required: true
          schema:
            $ref: '#/definitions/Team'
      responses:
        '201':
          description: team created
          schema:
            $ref: '#/definitions/Team'
        '400':
          description: 'invalid input, object invalid'
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
  /teams/{team}:
    get:
      tags:
        - Standard
        - Teams
      summary: gets single team by ID
      description: |
        By passing in the appropriate options, you can find a single team
      operationId: getTeam
      produces:
        - application/json
      parameters:
        - name: team
          in: path
          description: team ID
          required: true
          type: string
      responses:
        '200':
          description: single team entity
          schema:
            $ref: '#/definitions/Team'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
    delete:
      tags:
        - Admin only
        - Teams
      summary: deletes team instance
      description: |
        Deletes Team. 
      operationId: deleteTeam
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: team
          in: path
          description: team ID
          required: true
          type: string
      responses:
        '204':
          description: Team deleted
        '400':
          description: invalid input
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
    patch:
      tags:
        - Admin only
        - Teams
      summary: updates team info
      description: Updates Team.
      operationId: updateTeam
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: team
          in: path
          description: team ID
          required: true
          type: string
        - in: body
          name: tipper
          description: tipper entity to be updated
          required: true
          schema:
            $ref: '#/definitions/Team'
      responses:
        '204':
          description: team updated
        '400':
          description: 'invalid input, object invalid'
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
  /seasons:
    get:
      tags:
        - Standard
        - Season
      summary: get all seasons
      description: >
        Gets all seasons. Filters and limiting can be applied through described
        GET paramaters. Standard filters such as current season or gameday may
        be applied when no filter is given.
      operationId: getSeasons
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: skip
          in: query
          description: number of records to skip for pagination
          required: false
          type: integer
          minimum: 0
          format: int32
        - name: limit
          in: query
          description: maximum number of records to return
          required: false
          type: integer
          maximum: 50
          minimum: 0
          format: int32
        - name: filter
          in: query
          description: >-
            filter string (similar to OData convention but only simple
            conditions)
          required: false
          type: string
          maxLength: 140
      responses:
        '200':
          description: search results matching criteria
          schema:
            type: array
            items:
              $ref: '#/definitions/Season'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
    post:
      tags:
        - Admin only
        - Season
      summary: create new season
      description: |
        Endpoint to create season. Protected and only available to admins.
      operationId: createSeason
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: body
          name: season
          description: Season info to add
          required: true
          schema:
            $ref: '#/definitions/Season'
      responses:
        '201':
          description: season created
          schema:
            $ref: '#/definitions/Season'
        '400':
          description: 'invalid input, object invalid'
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
  /seasons/{endYear}:
    get:
      tags:
        - Standard
        - Season
      summary: gets single season by end year
      description: |
        By passing in the appropriate options, you can find a single season
      operationId: getSeason
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
      responses:
        '200':
          description: single season entity
          schema:
            $ref: '#/definitions/Season'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: game not found
    delete:
      tags:
        - Admin only
        - Season
      summary: deletes season instance
      description: Deletes Season
      operationId: deleteSeason
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
      responses:
        '204':
          description: Season deleted
        '400':
          description: invalid input
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: Season not found
    patch:
      tags:
        - Admin only
        - Season
      summary: updates season info
      description: Updates Season info
      operationId: updateSeason
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - in: body
          name: season
          description: Season entity to be updated
          required: true
          schema:
            $ref: '#/definitions/Season'
      responses:
        '204':
          description: season updated
        '400':
          description: 'invalid input, object invalid'
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: season not found
  '/seasons/{endYear}/tipps':
    get:
      tags:
        - Standard
        - Season
        - Season Tipp
      summary: gets all season tipps for the specified season
      description: >
        Find all season tipps for a season. It is possible to only get your own
        tipp by providing the appropiate query option
      operationId: getSeasonTipps
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: ownOnlyFlag
          in: query
          description: filter for only your own season tipp on this season
          required: false
          type: boolean
      responses:
        '200':
          description: array of season tipp entities
          schema:
            type: array
            items:
              $ref: '#/definitions/SeasonTipp'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: season not found / no season tipps found
    post:
      tags:
        - Standard
        - Season
        - Season Tipp
      summary: shortcut to create season tipp for this season
      description: |
        Create a single season tipp for this season
      operationId: createSeasonTipp
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - in: body
          name: tipp
          description: Season Tipp info to add
          required: true
          schema:
            $ref: '#/definitions/SeasonTipp'
      responses:
        '201':
          description: Created successfully
          schema:
            $ref: '#/definitions/SeasonTipp'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: season not found
  '/seasons/{endYear}/tipps/{tipper}':
    get:
      tags:
        - Standard
        - Season Tipp
        - Season
      summary: gets single season tipp by end year
      description: |
        By passing in the appropriate options, you can find a single season tipp
      operationId: getSeasonTipp
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: tipper
          in: path
          description: tipper giving the tipp
          required: true
          type: string
      responses:
        '200':
          description: single season tipp entity
          schema:
            $ref: '#/definitions/SeasonTipp'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
    delete:
      tags:
        - Standard
        - Season Tipp
        - Season
      summary: deletes season tipp instance
      description: Deletes Season Tipp
      operationId: deleteSeasonTipp
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: tipper
          in: path
          description: tipper giving the tipp
          required: true
          type: string
      responses:
        '204':
          description: Season tipp deleted
        '400':
          description: invalid input
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
    patch:
      tags:
        - Standard
        - Season
        - Season Tipp
      summary: updates season tipp info
      description: Updates Season Tipp info
      operationId: updateSeasonTipp
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: tipper
          in: path
          description: tipper giving the tipp
          required: true
          type: string
        - in: body
          name: tipp
          description: Season tipp entity to be updated
          required: true
          schema:
            $ref: '#/definitions/SeasonTipp'
      responses:
        '204':
          description: season updated
        '400':
          description: 'invalid input, object invalid'
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
  '/seasons/{endYear}/result':
    get:
      tags:
        - Standard
        - Season
        - Season Result
      summary: gets the season result for the specified season
      description: |
        Find the season result for a season. 
      operationId: getSeasonResult
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
      responses:
        '200':
          description: single season result entity
          schema:
            $ref: '#/definitions/SeasonResult'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: season not found / no season result found
    post:
      tags:
        - Admin only
        - Season
        - Season Result
      summary: shortcut to create season result for this season
      description: |
        Create a single season result for this season
      operationId: createSeasonResult
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - in: body
          name: result
          description: Season result info to add
          required: true
          schema:
            $ref: '#/definitions/SeasonResult'
      responses:
        '201':
          description: Created successfully
          schema:
            $ref: '#/definitions/SeasonResult'
        '400':
          description: bad input parameter
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: season not found
    delete:
      tags:
        - Admin only
        - Season Result
        - Season
      summary: deletes season result instance
      description: Deletes Season Result
      operationId: deleteSeasonResult
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
      responses:
        '204':
          description: Season tipp deleted
        '400':
          description: invalid input
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
    patch:
      tags:
        - Admin only
        - Season
        - Season Result
      summary: updates season result info
      description: Updates Season Result
      operationId: updateSeasonResult
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - in: body
          name: result
          description: Season result entity to be updated
          required: true
          schema:
            $ref: '#/definitions/SeasonResult'
      responses:
        '204':
          description: season updated
        '400':
          description: 'invalid input, object invalid'
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
  /seasons/{endYear}/standings/{type}:
    get:
      tags:
        - Analysis
      summary: gets different season standings
      description: |
        Gets season standings of different types. 
        Overall: Array including all currently available data. This includes main round points, playoff series points and playoff game points as well as the current bonus point situation. --> displays data as if the season would stop today.
        Playoffs: Array containing all playoff points for all tippers 
        Series Tipps: Array giving playoff series points standings for all tippers
        Main Round: Array giving main round standings (points, jackpots, gameday victories, adler points, personal best gameday, missed tipps) for all tippers
        Inactive tippers will not be included.
      operationId: getOverallStandings
      produces: 
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: type
          in: path
          description: standings type (overall, playoffs, seriestipps, mainround)
          required: true
          type: string
      responses:
        200:
          description: array of standings for all tippers
          schema:
            type: array
            items:
              $ref: '#/definitions/Standing'
        400:
          description: bad input parameter
        403:
          description: Not Authorized
        404:
          description: not found
  /seasons/{endYear}/standings/{type}/tippers/{tipper}:
    get:
      tags:
        - Analysis
        - Season
      summary: gets overall season standings for single tipper
      description: |
        Gets season standings of different types for specified tipper. 
        Overall: Entity including all currently available data. This includes main round points, playoff series points and playoff game points as well as the current bonus point situation. --> displays data as if the season would stop today.
        Playoffs: Entity containing all playoff points for this tipper 
        Series Tipps: Entity giving playoff series points standings for this tipper
        Main Round: Entity giving main round standings (points, jackpots, gameday victories, adler points, personal best gameday, missed tipps) for this tipper
      operationId: getStandingForTipper
      produces: 
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: type
          in: path
          description: standings type (overall, playoffs, seriestipps, mainround)
          required: true
          type: string
        - name: tipper
          in: path
          description: id of tipper
          required: true
          type: string
      responses:
        200:
          description: standing for this tipper
          schema:
            $ref: '#/definitions/Standing'
        400:
          description: bad input parameter
        403:
          description: Not Authorized
        404:
          description: not found
  '/seasons/{endYear}/playoffs':
    get:
      tags:
        - Standard
        - Playoff Series
        - Season
      summary: gets all playoff series for the specified season
      description: |
        Find all playoff series for a season. 
      operationId: getAllPlayoffSeries
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
      responses:
        '200':
          description: array of playoff series entities
          schema:
            type: array
            items:
              $ref: '#/definitions/PlayoffSeries'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
  '/seasons/{endYear}/playoffs/{round}/series':
    get:
      tags:
        - Standard
        - Playoff Series
      summary: gets all playoff series for this round
      description: >
        By passing in the appropriate options, you can find all playoff series
        for this round
      operationId: getPlayoffSeriesOfRound
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
      responses:
        '200':
          description: single playoff series entity
          schema:
            type: array
            items:
              $ref: '#/definitions/PlayoffSeries'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: playoff series not found
    post:
      tags:
        - Admin only
        - Season
        - Playoff Series
      summary: create a playoff series for this season
      description: |
        Create a single playoff series for this season
      operationId: createPlayoffSeries
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - in: body
          name: series
          description: playoff series info to add
          required: true
          schema:
            $ref: '#/definitions/PlayoffSeries'
      responses:
        '201':
          description: Created successfully
          schema:
            $ref: '#/definitions/PlayoffSeries'
        '400':
          description: bad input parameter
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: season not found
  '/seasons/{endYear}/playoffs/{round}/series/{homeTeam}':
    get:
      tags:
        - Standard
        - Playoff Series
      summary: gets single playoff series
      description: >
        By passing in the appropriate options, you can find a single playoff
        series
      operationId: getPlayoffSeriesById
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
      responses:
        '200':
          description: single playoff series entity
          schema:
            $ref: '#/definitions/PlayoffSeries'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: playoff series not found
    delete:
      tags:
        - Playoff Series
        - Admin only
      summary: deletes plyaoff series instance
      description: Deletes playoff series
      operationId: deletePlayoffSeries
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
      responses:
        '204':
          description: Playoff series deleted
        '400':
          description: invalid input
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: Playoff series not found
    patch:
      tags:
        - Admin only
        - Playoff Series
      summary: updates playoff series info
      description: Updates Playoff Series info
      operationId: updatePlayoffSeries
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - in: body
          name: series
          description: Playoff series entity to be updated
          required: true
          schema:
            $ref: '#/definitions/PlayoffSeries'
      responses:
        '204':
          description: playoff series updated
        '400':
          description: 'invalid input, object invalid'
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: playoff series not found
  '/seasons/{endYear}/playoffs/{round}/series/{homeTeam}/result':
    get:
      tags:
        - Standard
        - Playoff Series
        - Playoff Series Result
      summary: gets the playoff series result
      description: |
        Find the result for a playoff series. 
      operationId: getPlayoffSeriesResult
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
      responses:
        '200':
          description: single playoff series result entity
          schema:
            $ref: '#/definitions/SeriesResult'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
    post:
      tags:
        - Standard
        - Playoff Series
        - Playoff Series Result
      summary: create result for this playoff series
      description: |
        Create a single result for this playoff series
      operationId: createPlayoffSeriesResult
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - in: body
          name: result
          description: Playoff series result info to add
          required: true
          schema:
            $ref: '#/definitions/SeriesResult'
      responses:
        '201':
          description: Created successfully
          schema:
            $ref: '#/definitions/SeriesResult'
        '400':
          description: bad input parameter
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
    delete:
      tags:
        - Standard
        - Playoff Series
        - Playoff Series Result
      summary: deletes playoff series result instance
      description: Deletes Playoff Series Result
      operationId: deletePlayoffSeriesResult
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
      responses:
        '204':
          description: Playoff Series result deleted
        '400':
          description: invalid input
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
    patch:
      tags:
        - Standard
        - Playoff Series
        - Playoff Series Result
      summary: updates playoff series result info
      description: Updates Playoff Series Result
      operationId: updatePlayoffSeriesResult
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - in: body
          name: result
          description: Season result entity to be updated
          required: true
          schema:
            $ref: '#/definitions/SeriesResult'
      responses:
        '204':
          description: playoff series result updated
        '400':
          description: 'invalid input, object invalid'
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
  '/seasons/{endYear}/playoffs/{round}/series/{homeTeam}/tipps':
    get:
      tags:
        - Standard
        - Playoff Series
        - Playoff Series Tipp
      summary: gets all playoff series tipps for the specified playoff series
      description: >
        Find all tipps for a playoff series. It is possible to only get your own
        tipp by providing the appropiate query option
      operationId: getPlayoffSeriesTipps
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - name: ownOnlyFlag
          in: query
          description: filter for only your own season tipp on this season
          required: false
          type: boolean
      responses:
        '200':
          description: array of playoff series tipp entities
          schema:
            type: array
            items:
              $ref: '#/definitions/PlayoffTipp'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
    post:
      tags:
        - Standard
        - Playoff Series
        - Playoff Series Tipp
      summary: create playoff series tipp for this playoff series
      description: |
        Create a single playoff series tipp for this playoff series
      operationId: createPlayoffSereisTipp
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - in: body
          name: tipp
          description: Playoff Series Tipp info to add
          required: true
          schema:
            $ref: '#/definitions/PlayoffTipp'
      responses:
        '201':
          description: Created successfully
          schema:
            $ref: '#/definitions/PlayoffTipp'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
  '/seasons/{endYear}/playoffs/{round}/series/{homeTeam}/tipps/{tipper}':
    get:
      tags:
        - Standard
        - Playoff Series
        - Playoff Series Tipp
      summary: gets single playoff series tipp
      description: >
        By passing in the appropriate options, you can find a single playoff
        series tipp
      operationId: getPlayoffSeriesTipp
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - name: tipper
          in: path
          description: tipper ID to identify single tipp
          required: true
          type: string
      responses:
        '200':
          description: single playoff series tipp entity
          schema:
            $ref: '#/definitions/PlayoffTipp'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
    delete:
      tags:
        - Standard
        - Playoff Series
        - Playoff Series Tipp
      summary: deletes playoff series tipp instance
      description: Deletes Playoff Series Tipp
      operationId: deletePlayoffSeriesTipp
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - name: tipper
          in: path
          description: tipper ID to identify single tipp
          required: true
          type: string
      responses:
        '204':
          description: Playoff series tipp deleted
        '400':
          description: invalid input
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
    patch:
      tags:
        - Standard
        - Playoff Series
        - Playoff Series Tipp
      summary: updates playoff series tipp info
      description: Updates Playoff Series Tipp info
      operationId: updatePlayoffSeriesTipp
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - name: tipper
          in: path
          description: tipper ID to identify single tipp
          required: true
          type: string
        - in: body
          name: tipp
          description: Game tipp entity to be updated
          required: true
          schema:
            $ref: '#/definitions/PlayoffTipp'
      responses:
        '204':
          description: playoff series tipp updated
        '400':
          description: 'invalid input, object invalid'
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
  '/seasons/{endYear}/playoffs/{round}/series/{homeTeam}/games':
    get:
      tags:
        - Standard
        - Playoff Series
        - Playoff Game
        - Game
      summary: gets the games for the specified playoff series
      description: |
        Find the games for a playoff series. 
      operationId: getPlayoffSeriesGames
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
      responses:
        '200':
          description: array of game entities
          schema:
            type: array
            items:
              $ref: '#/definitions/Game'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
    post:
      tags:
        - Admin only
        - Game
        - Playoff Series
        - Playoff Game
      summary: create a playoff game for this series
      description: |
        Create a single playoff game for this series
      operationId: createPlayoffGame
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - in: body
          name: game
          description: playoff series info to add
          required: true
          schema:
            $ref: '#/definitions/Game'
      responses:
        '201':
          description: Created successfully
          schema:
            $ref: '#/definitions/Game'
        '400':
          description: bad input parameter
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: season not found
  '/seasons/{endYear}/playoffs/{round}/series/{homeTeam}/games/{number}':
    get:
      tags:
        - Standard
        - Playoff Series
        - Playoff Game
        - Game
      summary: gets single playoff game
      description: >
        By passing in the appropriate options, you can find a single playoff
        game
      operationId: getPlayoffGame
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - name: number
          in: path
          description: number of game in playoff series
          required: true
          type: string
      responses:
        '200':
          description: single game entity
          schema:
            $ref: '#/definitions/Game'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
    delete:
      tags:
        - Standard
        - Playoff Series
        - Playoff Game
        - Game
      summary: deletes playoff game instance
      description: Deletes Playoff Game
      operationId: deletePlayoffGame
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - name: number
          in: path
          description: number of game in playoff series
          required: true
          type: string
      responses:
        '204':
          description: Playoff Game deleted
        '400':
          description: invalid input
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
    patch:
      tags:
        - Standard
        - Playoff Series
        - Playoff Game
        - Game
      summary: updates playoff game info
      description: Updates Playoff Game info
      operationId: updatePlayoffGame
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - name: number
          in: path
          description: number of game in playoff series
          required: true
          type: string
        - in: body
          name: game
          description: Inventory item to add
          required: true
          schema:
            $ref: '#/definitions/Game'
      responses:
        '204':
          description: game updated
        '400':
          description: 'invalid input, object invalid'
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: game not found
  '/seasons/{endYear}/playoffs/{round}/series/{homeTeam}/games/{number}/tipps':
    get:
      tags:
        - Standard
        - Playoff Game
        - Game Tipp
      summary: gets all playoff game tipps for the specified game
      description: >
        Find all tipps for a playoff game. It is possible to only get your own
        tipp by providing the appropiate query option
      operationId: getPlayoffGameTipps
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - name: number
          in: path
          description: number of game in playoff series
          required: true
          type: string
        - name: ownOnlyFlag
          in: query
          description: filter for only your own season tipp on this season
          required: false
          type: boolean
      responses:
        '200':
          description: array of game tipp entities
          schema:
            type: array
            items:
              $ref: '#/definitions/GameTipp'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
    post:
      tags:
        - Standard
        - Playoff Game
        - Game Tipp
      summary: create game tipp for this playoff game
      description: |
        Create a single game tipp for this playoff game
      operationId: createPlayoffGameTipp
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - name: number
          in: path
          description: number of game in playoff series
          required: true
          type: string
        - in: body
          name: tipp
          description: Season Tipp info to add
          required: true
          schema:
            $ref: '#/definitions/GameTipp'
      responses:
        '201':
          description: Created successfully
          schema:
            $ref: '#/definitions/GameTipp'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
  '/seasons/{endYear}/playoffs/{round}/series/{homeTeam}/games/{number}/tipps/{tipper}':
    get:
      tags:
        - Standard
        - Playoff Game
        - Game Tipp
      summary: gets single playoff game tipp
      description: >
        By passing in the appropriate options, you can find a single playoff
        game tipp
      operationId: getPlayoffGameTipp
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - name: number
          in: path
          description: number of game in playoff series
          required: true
          type: string
        - name: tipper
          in: path
          description: tipper ID to identify single tipp
          required: true
          type: string
      responses:
        '200':
          description: single season tipp entity
          schema:
            $ref: '#/definitions/GameTipp'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
    delete:
      tags:
        - Standard
        - Playoff Game
        - Game Tipp
      summary: deletes palyoff game tipp instance
      description: Deletes Playoff Game Tipp
      operationId: deletePlayoffGameTipp
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - name: number
          in: path
          description: number of game in playoff series
          required: true
          type: string
        - name: tipper
          in: path
          description: tipper ID to identify single tipp
          required: true
          type: string
      responses:
        '204':
          description: Playoff game tipp deleted
        '400':
          description: invalid input
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
    patch:
      tags:
        - Standard
        - Playoff Game
        - Game Tipp
      summary: updates playoff game tipp info
      description: Updates Playoff Game Tipp info
      operationId: updatePlayoffGameTipp
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - name: number
          in: path
          description: number of game in playoff series
          required: true
          type: string
        - name: tipper
          in: path
          description: tipper ID to identify single tipp
          required: true
          type: string
        - in: body
          name: tipp
          description: Game tipp entity to be updated
          required: true
          schema:
            $ref: '#/definitions/GameTipp'
      responses:
        '204':
          description: season updated
        '400':
          description: 'invalid input, object invalid'
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
  '/seasons/{endYear}/playoffs/{round}/series/{homeTeam}/games/{number}/result':
    get:
      tags:
        - Standard
        - Playoff Game
        - Game Result
      summary: gets the game result for the specified playoff game
      description: |
        Find the game result for a playoff game. 
      operationId: getPlayoffGameResult
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - name: number
          in: path
          description: number of game in playoff series
          required: true
          type: string
      responses:
        '200':
          description: single game result entity
          schema:
            $ref: '#/definitions/GameResult'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
    post:
      tags:
        - Standard
        - Playoff Game
        - Game Result
      summary: create game result for this playoff game
      description: |
        Create a single game result for this playoff game
      operationId: createPlayoffGameResult
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - name: number
          in: path
          description: number of game in playoff series
          required: true
          type: string
        - in: body
          name: result
          description: Season result info to add
          required: true
          schema:
            $ref: '#/definitions/GameResult'
      responses:
        '201':
          description: Created successfully
          schema:
            $ref: '#/definitions/GameResult'
        '400':
          description: bad input parameter
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
    delete:
      tags:
        - Standard
        - Playoff Game
        - Game Result
      summary: deletes playoff game result instance
      description: Deletes Playoff Game Result
      operationId: deletePlayoffGameResult
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - name: number
          in: path
          description: number of game in playoff series
          required: true
          type: string
      responses:
        '204':
          description: Playoff Game result deleted
        '400':
          description: invalid input
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
    patch:
      tags:
        - Standard
        - Playoff Game
        - Game Result
      summary: updates playoff game result info
      description: Updates Playoff Game Result
      operationId: updatePlayoffGameResult
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: round
          in: path
          description: 'playoff round (PP, QF, SF, FF)'
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify playoff series
          required: true
          type: string
        - name: number
          in: path
          description: number of game in playoff series
          required: true
          type: string
        - in: body
          name: result
          description: Season result entity to be updated
          required: true
          schema:
            $ref: '#/definitions/GameResult'
      responses:
        '204':
          description: playoff game updated
        '400':
          description: 'invalid input, object invalid'
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
  '/seasons/{endYear}/gameday/{gameday}/games':
    get:
      tags:
        - Standard
        - Season
        - Game
      summary: gets the games for the specified season
      description: |
        Find the games for a season. 
      operationId: getSeasonGames
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: gameday
          in: path
          description: gameday in the main round of the season
          required: true
          type: string
      responses:
        '200':
          description: array of game entities
          schema:
            type: array
            items:
              $ref: '#/definitions/Game'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
    post:
      tags:
        - Admin only
        - Season
        - Game
      summary: create game for this season on the specified game day
      description: |
        Create a single game for this season on the specified game day
      operationId: createSeasonGame
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: gameday
          in: path
          description: gameday in the main round of the season
          required: true
          type: string
        - in: body
          name: game
          description: Game info to add
          required: true
          schema:
            $ref: '#/definitions/Game'
      responses:
        '201':
          description: Created successfully
          schema:
            $ref: '#/definitions/Game'
        '400':
          description: bad input parameter
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
  '/seasons/{endYear}/gameday/{gameday}/games/{homeTeam}':
    get:
      tags:
        - Standard
        - Game
      summary: 'gets single game by season, gameday, home team'
      description: |
        By passing in the appropriate options, you can find a single season game
      operationId: getSeasonGame
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: gameday
          in: path
          description: gameday in the main round of the season
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify a game on this gameday
          required: true
          type: string
      responses:
        '200':
          description: single game entity
          schema:
            $ref: '#/definitions/Game'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
    delete:
      tags:
        - Admin only
        - Game
      summary: deletes game instance
      description: Deletes Game
      operationId: deleteSeasonGame
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: gameday
          in: path
          description: gameday in the main round of the season
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify a game on this gameday
          required: true
          type: string
      responses:
        '204':
          description: Game deleted
        '400':
          description: invalid input
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
    patch:
      tags:
        - Admin only
        - Game
      summary: updates game info
      description: Updates Game info
      operationId: updateGame
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: gameday
          in: path
          description: gameday in the main round of the season
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify a game on this gameday
          required: true
          type: string
        - in: body
          name: game
          description: Inventory item to add
          required: true
          schema:
            $ref: '#/definitions/Game'
      responses:
        '204':
          description: game updated
        '400':
          description: 'invalid input, object invalid'
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
  '/seasons/{endYear}/gameday/{gameday}/games/{homeTeam}/tipps':
    get:
      tags:
        - Standard
        - Game
        - Game Tipp
      summary: gets all season game tipps for the specified game
      description: >
        Find all tipps for a season game. It is possible to only get your own
        tipp by providing the appropiate query option
      operationId: getSeasonGameTipps
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: gameday
          in: path
          description: gameday in the main round of the season
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify a game on this gameday
          required: true
          type: string
        - name: ownOnlyFlag
          in: query
          description: filter for only your own season tipp on this season
          required: false
          type: boolean
      responses:
        '200':
          description: array of game tipp entities
          schema:
            type: array
            items:
              $ref: '#/definitions/GameTipp'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
    post:
      tags:
        - Standard
        - Game
        - Game Tipp
      summary: create game tipp for this season game
      description: |
        Create a single game tipp for this season game
      operationId: createSeasonGameTipp
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: gameday
          in: path
          description: gameday in the main round of the season
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify a game on this gameday
          required: true
          type: string
        - in: body
          name: tipp
          description: Season Tipp info to add
          required: true
          schema:
            $ref: '#/definitions/GameTipp'
      responses:
        '201':
          description: Created successfully
          schema:
            $ref: '#/definitions/GameTipp'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
  '/seasons/{endYear}/gameday/{gameday}/games/{homeTeam}/tipps/{tipper}':
    get:
      tags:
        - Standard
        - Game
        - Game Tipp
      summary: gets single season game tipp
      description: >
        By passing in the appropriate options, you can find a single season game
        tipp
      operationId: getSeasonGameTipp
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: gameday
          in: path
          description: gameday in the main round of the season
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify a game on this gameday
          required: true
          type: string
        - name: tipper
          in: path
          description: tipper ID to identify single tipp
          required: true
          type: string
      responses:
        '200':
          description: single season tipp entity
          schema:
            $ref: '#/definitions/GameTipp'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: not found
    delete:
      tags:
        - Standard
        - Game
        - Game Tipp
      summary: deletes season game tipp instance
      description: Deletes Season Game Tipp
      operationId: deleteSeasonGameTipp
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: gameday
          in: path
          description: gameday in the main round of the season
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify a game on this gameday
          required: true
          type: string
        - name: tipper
          in: path
          description: tipper ID to identify single tipp
          required: true
          type: string
      responses:
        '204':
          description: Season game tipp deleted
        '400':
          description: invalid input
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
    patch:
      tags:
        - Standard
        - Game
        - Game Tipp
      summary: updates season game tipp info
      description: Updates Season Game Tipp info
      operationId: updateSeasonGameTipp
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: gameday
          in: path
          description: gameday in the main round of the season
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify a game on this gameday
          required: true
          type: string
        - name: tipper
          in: path
          description: tipper ID to identify single tipp
          required: true
          type: string
        - in: body
          name: tipp
          description: Game tipp entity to be updated
          required: true
          schema:
            $ref: '#/definitions/GameTipp'
      responses:
        '204':
          description: season updated
        '400':
          description: 'invalid input, object invalid'
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
  '/seasons/{endYear}/gameday/{gameday}/games/{homeTeam}/result':
    get:
      tags:
        - Standard
        - Game Result
        - Game
      summary: gets all tipps for the specified game
      description: |
        Get result for a game.
      operationId: getSeasonGameResult
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: gameday
          in: path
          description: gameday in the main round of the season
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify a game on this gameday
          required: true
          type: string
      responses:
        '200':
          description: single result entity
          schema:
            $ref: '#/definitions/GameResult'
        '400':
          description: bad input parameter
        '403':
          description: Not Authorized
        '404':
          description: game not found / no result found
    post:
      tags:
        - Admin only
        - Game Result
        - Game
      summary: create result for this game
      description: |
        Create a single result for this game
      operationId: createSeasonGameResult
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: gameday
          in: path
          description: gameday in the main round of the season
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify a game on this gameday
          required: true
          type: string
        - in: body
          name: result
          description: Tipp info to add
          required: true
          schema:
            $ref: '#/definitions/GameResult'
      responses:
        '201':
          description: Created successfully
          schema:
            $ref: '#/definitions/GameResult'
        '400':
          description: bad input parameter
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: Game not found
    delete:
      tags:
        - Standard
        - Game
        - Game Result
      summary: deletes season game result instance
      description: Deletes Season Game Result
      operationId: deleteSeasonGameResult
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: gameday
          in: path
          description: gameday in the main round of the season
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify a game on this gameday
          required: true
          type: string
      responses:
        '204':
          description: Season Game result deleted
        '400':
          description: invalid input
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
    patch:
      tags:
        - Standard
        - Playoff Game
        - Game Result
      summary: updates playoff game result info
      description: Updates Season Game Result
      operationId: updateSeasonGameResult
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: endYear
          in: path
          description: end year of season
          required: true
          type: string
        - name: gameday
          in: path
          description: gameday in the main round of the season
          required: true
          type: string
        - name: homeTeam
          in: path
          description: home team to uniquely identify a game on this gameday
          required: true
          type: string
        - in: body
          name: result
          description: Season result entity to be updated
          required: true
          schema:
            $ref: '#/definitions/GameResult'
      responses:
        '204':
          description: season game result updated
        '400':
          description: 'invalid input, object invalid'
        '401':
          description: Forbidden
        '403':
          description: Not Authorized
        '404':
          description: not found
definitions:
  Game:
    properties:
      season:
        $ref: '#/definitions/SeasonYear'
      gameday:
        type: integer
        maximum: 52
        minimum: 1
        example: 10
      round:
        $ref: '#/definitions/Round'
      number:
        type: integer
        maximum: 7
        minimum: 1
        example: 2
      homeTeam:
        $ref: '#/definitions/TeamId'
      puckdrop:
        $ref: '#/definitions/Timestamp'
      awayTeam:
        $ref: '#/definitions/TeamId'
      playoffFlag:
        type: boolean
        example: false
      adlerFlag:
        type: boolean
        example: true
      _self:
        $ref: '#/definitions/selfURL'
    example:
      playoffFlag: false
      puckdrop: '2018-08-29T09:12:33.001Z'
      away: MAN
      adlerFlag: true
      season: '2019'
      _self: 'https://api.example.com/season(2018)'
      gameday: 34
      home: MAN
  GameResult:
    properties:
      season:
        $ref: '#/definitions/SeasonYear'
      gameday:
        type: integer
        maximum: 52
        minimum: 1
        example: 10
      round:
        $ref: '#/definitions/Round'
      number:
        type: integer
        maximum: 7
        minimum: 1
        example: 2
      homeTeam:
        $ref: '#/definitions/TeamId'
      home:
        type: integer
        example: 4
        minimum: 0
      away:
        type: integer
        example: 1
        minimum: 0
      gameEnd:
        type: string
        enum:
          - REG
          - EXT
          - PEN
      _self:
        $ref: '#/definitions/selfURL'
    example:
      away: 1
      _self: 'https://api.example.com/season(2018)'
      home: 4
      gameEnd: REG
  GameTipp:
    properties:
      season:
        $ref: '#/definitions/SeasonYear'
      gameday:
        type: integer
        maximum: 52
        minimum: 1
        example: 10
      round:
        $ref: '#/definitions/Round'
      number:
        type: integer
        maximum: 7
        minimum: 1
        example: 2
      homeTeam:
        $ref: '#/definitions/TeamId'
      tipper:
        $ref: '#/definitions/TipperId'
      home:
        type: integer
        example: 4
        minimum: 0
      away:
        type: integer
        example: 1
        minimum: 0
      gameEnd:
        type: string
        enum:
          - REG
          - EXT
          - PEN
      savedAt:
        $ref: '#/definitions/Timestamp'
      comment:
        type: string
        maxLength: 140
      _self:
        $ref: '#/definitions/selfURL'
    example:
      away: 1
      savedAt: '2018-08-29T09:12:33.001Z'
      comment: comment
      _self: 'https://api.example.com/season(2018)'
      tipper: mettler1938
      home: 4
      gameEnd: REG
  Season:
    properties:
      endYear:
        $ref: '#/definitions/SeasonYear'
      startDate:
        $ref: '#/definitions/Date'
      mainRoundEnd:
        $ref: '#/definitions/Date'
      _self:
        $ref: '#/definitions/selfURL'
    example:
      _self: 'https://api.example.com/season(2018)'
      endYear: '2019'
      startDate: '2018-06-01T00:00:00.000Z'
      mainRoundEnd: '2018-06-01T00:00:00.000Z'
  SeasonResult:
    properties:
      season:
        $ref: '#/definitions/SeasonYear'
      champion:
        $ref: '#/definitions/TeamId'
      mainRound:
        $ref: '#/definitions/TeamId'
      adlerFinish:
        type: integer
        example: 1
      adlerScore:
        type: integer
        example: 101
      adlerWLratio:
        type: number
        example: 75%
      _self:
        $ref: '#/definitions/selfURL'
    example:
      adlerScore: 101
      mainRound: MAN
      season: '2019'
      adlerWLratio: 75%
      adlerFinish: 1
      _self: 'https://api.example.com/season(2018)'
      champion: MAN
  SeasonTipp:
    properties:
      tipper:
        $ref: '#/definitions/TipperId'
      season:
        $ref: '#/definitions/SeasonYear'
      champion:
        $ref: '#/definitions/TeamId'
      mainRound:
        $ref: '#/definitions/TeamId'
      adlerFinish:
        type: integer
        example: 1
      adlerScore:
        type: integer
        example: 101
      adlerWLratio:
        type: number
        example: 76%
      savedAt:
        $ref: '#/definitions/Timestamp'
      _self:
        $ref: '#/definitions/selfURL'
    example:
      adlerScore: 101
      mainRound: MAN
      season: '2019'
      adlerWLratio: 76%
      savedAt: '2018-08-29T09:12:33.001Z'
      adlerFinish: 1
      tipper: mettler1938
      champion: MAN
  PlayoffSeries:
    properties:
      season:
        $ref: '#/definitions/SeasonYear'
      round:
        $ref: '#/definitions/Round'
      homeTeam:
        $ref: '#/definitions/TeamId'
      awayTeam:
        $ref: '#/definitions/TeamId'
      puckdrop:
        $ref: '#/definitions/Timestamp'
      _self:
        $ref: '#/definitions/selfURL'
    example:
      away: MAN
      puckdrop: '2018-08-29T09:12:33.001Z'
      round: SF
      season: '2019'
      _self: 'https://api.example.com/season(2018)'
      home: MAN
  PlayoffTipp:
    properties:
      season:
        $ref: '#/definitions/SeasonYear'
      round:
        $ref: '#/definitions/Round'
      homeTeam:
        $ref: '#/definitions/TeamId'
      tipper:
        $ref: '#/definitions/TipperId'
      home:
        type: integer
        example: 4
        minimum: 0
        maximum: 4
      away:
        type: integer
        example: 1
        minimum: 0
        maximum: 4
      savedAt:
        $ref: '#/definitions/Timestamp'
      _self:
        $ref: '#/definitions/selfURL'
  SeriesResult:
    properties:
      season:
        $ref: '#/definitions/SeasonYear'
      round: 
        $ref: '#/definitions/Round'
      homeTeam:
        $ref: '#/definitions/TeamId'
      home:
        type: integer
        example: 4
        minimum: 0
        maximum: 4
      away:
        type: integer
        example: 1
        minimum: 0
        maximum: 4
      _self:
        $ref: '#/definitions/selfURL'
  Admin:
    properties:
      id:
        $ref: '#/definitions/TipperId'
      from:
        $ref: '#/definitions/Date'
      to:
        $ref: '#/definitions/Date'
      _self:
        $ref: '#/definitions/selfURL'
  Tipper:
    properties:
      id:
        $ref: '#/definitions/TipperId'
      name:
        type: string
        example: Yannick
        maxLength: 100
      _self:
        $ref: '#/definitions/selfURL'
  Team:
    properties:
      id:
        $ref: '#/definitions/TeamId'
      fullName:
        type: string
        example: Adler Mannheim
        maxLength: 50
      home:
        type: string
        example: SAP Arena
        maxLength: 100
      bunchOfWankersFlag:
        type: boolean
        example: false
      _self:
        $ref: '#/definitions/selfURL'
  Standing:
    properties:
      tipper: 
        $ref: '#/definitions/TipperId'
      season:
        $ref: '#/definitions/SeasonYear'
      gameday:
        type: integer
        example: 11
        maximum: 52
        minimum: 1
        description: only valid for gameday standings
      victory:
        type: boolean
        description: only valid for gameday standings
      points:
        type: integer
        minimum: 0
        maximum: 42
        example: 21
      adlerPoints:
        type: integer
        minimum: 0
        maximum: 6
        example: 4
        description: only valid for gameday standings
      jackpots:
        type: integer
        minimum: 0
        maximum: 7
        example: 2
        description: only valid for gameday and playoff standings
      personalBest:
        type: integer
        minimum: 0
        example: 21
        description: only valid for gameday standings
      missedTipps:
        type: integer
        minimum: 0
        maximum: 7
      seriesPoints:
        type: integer
        minimum: 0
        description: only valid for total standings
      mainRoundPoints:
        type: integer
        minimum: 0
        description: only valid for total standings
  AuthReq:
    properties:
      authStuff:
        type: string
    example:
      authStuff: authStuff
  AuthRes:
    properties:
      jwtToken:
        type: string
    example:
      jwtToken: jwtToken
  Round:
    type: string
    example: SF
    enum:
      - PP
      - QF
      - SF
      - FF
  SeasonYear:
    type: integer
    example: '2019'
  TipperId:
    type: string
    example: mettler1938
  TeamId:
    type: string
    example: MAN
  Date:
    type: string
    format: date
    example: '2018-06-01T00:00:00.000Z'
  Timestamp:
    type: string
    format: date-time
    description: Time the tipp was saved - relevant for evaluation of eligibility
    example: '2018-08-29T09:12:33.001Z'
  selfURL:
    type: string
    format: url
    description: URL pointing to self to make resolution of sub paths possible
    example: 'https://api.example.com/season(2018)'