aswi2021codebakers-gitlab/src/app/shared/api/openapi.yaml @ 464309d9

openapi: 3.0.1
info:
  title: SensLog
  description: 'ASWI semestral project of CodeBakers.'
  version: 1.0.0
externalDocs:
  description: Find out more about Swagger
  url: http://swagger.io
servers:
- url: http://localhost:4200

tags:
- name: login
  description: Login process
  externalDocs:
    description: Find out more
    url: https://www.senslog.org/api/v1/
- name: group
  description: Groups endpoints
paths:
  /senslog1/ControllerServlet:
    post:
      tags:
      - login
      summary: Authorize login
      operationId: login
      parameters:
        - in: query
          name: username
          schema:
            type: string
          description: User login
        - in: query
          name: password
          schema:
            type: string
          description: User password
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInfo'

  /senslog1/GroupService:
    get:
      tags:
      - group
      summary: Get groups
      operationId: getGroups
      parameters:
        - in: query
          name: Operation
          required: true
          schema:
            type: string
            default: GetGroups
            enum:
            - GetGroups
            - GetSuperGroups
            - GetSubGroups
          description: Group operation
        - in: query
          name: parent_group
          schema:
            type: integer
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Group'

components:
  schemas:
    UserInfo:
      type: object
      properties:
        sessionid:
          type: string
          example: rv6pe5o30091
        language:
          type: string
          example: en
        audio:
          type: boolean
          default: false

    Group:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        parent_group_id:
          type: integer
          format: int64
          example: 2
        group_name:
          type: string
          example: testGroup
        has_children:
          type: boolean
          default: false