definma-api/oas/user.yaml

/users:
  get:
    summary: lists all users
    description: 'Auth: basic, levels: admin'
    tags:
      - /user
    security:
      - BasicAuth: []
    responses:
      200:
        description: user API key
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: 'oas.yaml#/components/schemas/User'
      401:
        $ref: 'oas.yaml#/components/responses/401'
      403:
        $ref: 'oas.yaml#/components/responses/403'
      500:
        $ref: 'oas.yaml#/components/responses/500'
/user:
  get:
    summary: list own user details
    description: 'Auth: basic, levels: read, write, maintain, admin'
    tags:
      - /user
    security:
      - BasicAuth: []
    responses:
      200:
        description: user details
        content:
          application/json:
            schema:
              $ref: 'oas.yaml#/components/schemas/User'
      401:
        $ref: 'oas.yaml#/components/responses/401'
      403:
        $ref: 'oas.yaml#/components/responses/403'
      500:
        $ref: 'oas.yaml#/components/responses/500'
  put:
    summary: change user details
    description: 'Auth: basic, levels: read, write, maintain, admin'
    tags:
      - /user
    security:
      - BasicAuth: []
    requestBody:
      required: true
      content:
        application/json:
          schema:
            allOf:
              - $ref: 'oas.yaml#/components/schemas/_Id'
              - $ref: 'oas.yaml#/components/schemas/UserName'
              - $ref: 'oas.yaml#/components/schemas/Email'
            properties:
              pass:
                type: string
                writeOnly: true
                example: Abc123!#
              location:
                type: string
                example: Rng
              device_name:
                type: string
                example: Alpha II
    responses:
      200:
        description: user details
        content:
          application/json:
            schema:
              $ref: 'oas.yaml#/components/schemas/User'
      400:
        $ref: 'oas.yaml#/components/responses/400'
      401:
        $ref: 'oas.yaml#/components/responses/401'
      403:
        $ref: 'oas.yaml#/components/responses/403'
      500:
        $ref: 'oas.yaml#/components/responses/500'
  delete:
    summary: delete user
    description: 'Auth: basic, levels: read, write, maintain, admin'
    tags:
      - /user
    security:
      - BasicAuth: []
    responses:
      200:
        $ref: 'oas.yaml#/components/responses/Ok'
      401:
        $ref: 'oas.yaml#/components/responses/401'
      500:
        $ref: 'oas.yaml#/components/responses/500'
/user/{name}:
  parameters:
    - $ref: 'oas.yaml#/components/parameters/Name'
  get:
    summary: list user details
    description: 'Auth: basic, levels: admin'
    tags:
      - /user
    security:
      - BasicAuth: []
    responses:
      200:
        description: user details
        content:
          application/json:
            schema:
              $ref: 'oas.yaml#/components/schemas/User'
      401:
        $ref: 'oas.yaml#/components/responses/401'
      403:
        $ref: 'oas.yaml#/components/responses/403'
      404:
        $ref: 'oas.yaml#/components/responses/404'
      500:
        $ref: 'oas.yaml#/components/responses/500'
  put:
    summary: change user details
    description: 'Auth: basic, levels: admin'
    tags:
      - /user
    security:
      - BasicAuth: []
    requestBody:
      required: true
      content:
        application/json:
          schema:
            $ref: 'oas.yaml#/components/schemas/User'
    responses:
      200:
        description: user details
        content:
          application/json:
            schema:
              $ref: 'oas.yaml#/components/schemas/User'
      400:
        $ref: 'oas.yaml#/components/responses/400'
      401:
        $ref: 'oas.yaml#/components/responses/401'
      403:
        $ref: 'oas.yaml#/components/responses/403'
      404:
        $ref: 'oas.yaml#/components/responses/404'
      500:
        $ref: 'oas.yaml#/components/responses/500'
  delete:
    summary: delete user
    description: 'Auth: basic, levels: admin'
    tags:
      - /user
    security:
      - BasicAuth: []
    responses:
      200:
        $ref: 'oas.yaml#/components/responses/Ok'
      401:
        $ref: 'oas.yaml#/components/responses/401'
      403:
        $ref: 'oas.yaml#/components/responses/403'
      404:
        $ref: 'oas.yaml#/components/responses/404'
      500:
        $ref: 'oas.yaml#/components/responses/500'
/user/key:
  get:
    summary: get API key for the user
    description: 'Auth: basic, levels: read, write, maintain, dev, admin'
    tags:
      - /user
    security:
      - BasicAuth: []
    responses:
      200:
        description: user details
        content:
          application/json:
            schema:
              properties:
                key:
                  type: string
                  example: 5ea0450ed851c30a90e70899
      401:
        $ref: 'oas.yaml#/components/responses/401'
      500:
        $ref: 'oas.yaml#/components/responses/500'
/user/new:
  post:
    summary: add new user
    description: 'Auth: basic, levels: admin'
    tags:
      - /user
    security:
      - BasicAuth: []
    requestBody:
      required: true
      content:
        application/json:
          schema:
            required:
              - email
              - name
              - pass
              - level
              - location
              - device_name
            allOf:
              - $ref: 'oas.yaml#/components/schemas/User'
    responses:
      200:
        description: user details
        content:
          application/json:
            schema:
              $ref: 'oas.yaml#/components/schemas/User'
      400:
        $ref: 'oas.yaml#/components/responses/400'
      401:
        $ref: 'oas.yaml#/components/responses/401'
      403:
        $ref: 'oas.yaml#/components/responses/403'
      500:
        $ref: 'oas.yaml#/components/responses/500'
/user/passreset:
  post:
    summary: reset password and send mail to restore
    description: 'Auth: none'
    tags:
      - /user
    security: []
    requestBody:
      required: true
      description: mail saved in user profile to provide authentication
      content:
        application/json:
          schema:
            allOf:
              - $ref: 'oas.yaml#/components/schemas/UserName'
              - $ref: 'oas.yaml#/components/schemas/Email'
    responses:
      200:
        $ref: 'oas.yaml#/components/responses/Ok'
      404:
        $ref: 'oas.yaml#/components/responses/404'
      500:
        $ref: 'oas.yaml#/components/responses/500'