openapi: 3.1.0
info:
  title: Blacklist
  version: '1'

components:
  schemas:
    BlacklistElement:
      type: object
      properties:
        name:
          type: string
          examples:
            - TheFunPimp
          description: Name of the banned player for display purposes. Can be empty.
        userId:
          $ref: './openapi.yaml#/components/schemas/TypeUserIdObject'
        bannedUntil:
          type: string
          format: date-time
        banReason:
          type: string
          examples:
            - Cheating not allowed!
      required:
        - name
        - userId
        - bannedUntil
        - banReason

    BlacklistList:
      type: array
      items:
        $ref: '#/components/schemas/BlacklistElement'


  requestBodies:
    BlacklistBodyIn:
      content:
        application/json:
          schema:
            type: object
            properties:
              x:
                type: integer
                examples:
                  - -43
              y:
                type: integer
                examples:
                  - 842
              icon:
                type: string
                format: uuid
                examples:
                  - https://upload.wikimedia.org/wikipedia/commons/thumb/1/11/Blue_question_mark_icon.svg/1200px-Blue_question_mark_icon.svg.png
            required:
              - x
              - y
      required: true


  parameters:
    UserIdPathParameter:
      name: id
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/TypeUserIdString'


paths:
  /api/blacklist:
    get:
      tags:
        - Permissions
      summary: Blacklist list
      description: Fetch a list of all blacklisted users
      operationId: blacklist.get
      responses:
        200:
          description: List of found markers
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/BlacklistList'
                  meta:
                    $ref: './openapi.yaml#/components/schemas/ResultEnvelopeMeta'
                required:
                  - data
                  - meta


  /api/blacklist/{id}:
#    get:
#      tags:
#        - Permissions
#      summary: Marker show
#      description: Fetch a single defined map marker
#      operationId: blacklist.get.id
#      parameters:
#        - $ref: '#/components/parameters/MarkerIdParameter'
#      responses:
#        200:
#          description: Single found marker
#          $ref: '#/components/responses/MarkersBodyOut'
#        404:
#          description: Marker ID not found, errorCode will be 'ID_NOT_FOUND'
#          $ref: '#/components/responses/HttpEmptyEnvelopedResponse'

    post:
      tags:
        - Permissions
      summary: Blacklist create
      description: Create or update a blacklist entry
      operationId: blacklist.post.id
      parameters:
        - $ref: '#/components/parameters/UserIdPathParameter'
      requestBody:
        $ref: '#/components/requestBodies/BlacklistBodyIn'
      responses:
        201:
          description: Marker with updated values
          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
        400:
          description: >-
            Invalid request body, errorCode will be one of 'NO_OR_INVALID_X',
            'NO_OR_INVALID_Y'
          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
        403:
          $ref: './openapi.yaml#/components/responses/Unauthorized'
      security:
        - apiTokenName: []
          apiTokenSecret: []
        - sessionCookie: []

    delete:
      tags:
        - Permissions
      summary: Blacklist delete
      description: Delete a single entry from the blacklist
      operationId: blacklist.delete.id
      parameters:
        - $ref: '#/components/parameters/UserIdPathParameter'
      responses:
        204:
          description: Deleted marker
          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
        404:
          description: Marker ID not found
          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
        403:
          $ref: './openapi.yaml#/components/responses/Unauthorized'
      security:
        - apiTokenName: []
          apiTokenSecret: []
        - sessionCookie: []