openapi: 3.1.0
info:
  title: Web Users
  version: '1'

components:
  schemas:
    TypeWebUserName:
      type: string
    
    WebUserElement:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/TypeWebUserName'
        platformUserId:
          $ref: './openapi.yaml#/components/schemas/TypeUserIdObject'
        crossplatformUserId:
          $ref: './openapi.yaml#/components/schemas/TypeUserIdObject'
      required:
        - name
        - platformUserId
        - crossplatformUserId

    WebUserList:
      type: array
      items:
        $ref: '#/components/schemas/WebUserElement'


  requestBodies:
    WebUserBodyIn:
      content:
        application/json:
          schema:
            type: object
            properties:
              password:
                type: string
                format: password
              platformUserId:
                $ref: './openapi.yaml#/components/schemas/TypeUserIdObject'
              crossplatformUserId:
                $ref: './openapi.yaml#/components/schemas/TypeUserIdObject'
            required:
              - password
              - platformUserId
      required: true


  parameters:
    WebUserNamePathParameter:
      name: userName
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/TypeWebUserName'


paths:
  /api/webusers:
    get:
      tags:
        - Permissions
      summary: Web user list
      description: Fetch a list of all web users
      operationId: WebUsers.get
      responses:
        200:
          description: List of web users
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/WebUserList'
                  meta:
                    $ref: './openapi.yaml#/components/schemas/ResultEnvelopeMeta'
                required:
                  - data
                  - meta
        403:
          $ref: './openapi.yaml#/components/responses/Unauthorized'
      security:
        - apiTokenName: [ ]
          apiTokenSecret: [ ]
        - sessionCookie: [ ]


  /api/webusers/{userName}:
    #    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: Web user create
      description: Create or update a web user
      operationId: WebUsers.post.id
      parameters:
        - $ref: '#/components/parameters/WebUserNamePathParameter'
      requestBody:
        $ref: '#/components/requestBodies/WebUserBodyIn'
      responses:
        201:
          description: User created or updated
          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
        400:
          description: Invalid request body, errorCode will be one of 'NO_USERNAME', 'NO_OR_INVALID_PASSWORD', 'NO_PLATFORM_USER_ID', 'INVALID_PLATFORM_USER_ID' or 'INVALID_CROSSPLATFORM_USER_ID'
          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
        403:
          $ref: './openapi.yaml#/components/responses/Unauthorized'
      security:
        - apiTokenName: [ ]
          apiTokenSecret: [ ]
        - sessionCookie: [ ]
    
    delete:
      tags:
        - Permissions
      summary: Web user delete
      description: Delete a single web user
      operationId: WebUsers.delete.id
      parameters:
        - $ref: '#/components/parameters/WebUserNamePathParameter'
      responses:
        204:
          description: Deleted user
          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
        400:
          description: Invalid request body, errorCode will be 'NO_USERNAME'
          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
        404:
          description: User not found
          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
        403:
          $ref: './openapi.yaml#/components/responses/Unauthorized'
      security:
        - apiTokenName: [ ]
          apiTokenSecret: [ ]
        - sessionCookie: [ ]