swagger: "2.0"
info:
  description: "Qorus Integration Engine(R) REST API"
  version: "1.0"
  title: "Qorus REST API"
  contact:
    email: "info@qoretechnologies.com"
host: "localhost"
basePath: "/api/public"
schemes:
- "https"
- "http"
produces:
- "text/x-yaml"
- "application/json"
consumes:
- "text/x-yaml"
- "application/json"
paths:
  /login:
    post:
      summary: "Noop in the Community Edition"
      description: "Noop in the Community Edition"
      operationId: "post-login"
      parameters:
      - in: "body"
        name: "body"
        description: "message body"
        required: true
        schema:
          $ref: "#/definitions/post-login-body"
      responses:
        "200":
          description: "Authentication info"
          schema:
            $ref: "#/definitions/QorusTokenInfo"
        "400":
          description: "invalid or missing arguments"
          schema: {}
  /info:
    get:
      summary: "Returns public information about the server"
      description: "@since"
      operationId: "get-info"
      parameters: []
      responses:
        "200":
          description: "information about the current Qorus instance"
          schema:
            $ref: "#/definitions/QorusPublicInfo"
definitions:
  post-login-body:
    type: "object"
    required:
    - "user"
    - "pass"
    properties:
      user:
        type: "string"
        description: "The username to log in"
      pass:
        type: "string"
        description: "The user's password"
  QorusTokenInfo:
    type: "object"
    required:
    - "token"
    properties:
      token:
        type: "string"
        description: "Always returns an empty string in the Community Edition"
  QorusPublicInfo:
    type: "object"
    required:
    - "instance-key"
    - "omq-version"
    - "omq-build"
    - "qore-version"
    - "omq-schema"
    - "noauth"
    - "edition"
    - "tz_region"
    - "tz_utc_offset"
    properties:
      instance-key:
        type: "string"
        description: "Qorus instance identifier"
      omq-version:
        type: "string"
        description: "Qorus executable version"
      omq-build:
        type: "string"
        description: "Qorus executable git hash"
      qore-version:
        type: "string"
        description: "Qore library version"
      omq-schema:
        type: "string"
        description: "Qorus system schema info"
      noauth:
        type: "boolean"
        description: "Always True in the Community Edition"
      edition:
        type: "string"
        description: "Community for Qorus Integration Engine(R) Community Edition"
      tz_region:
        type: "string"
        description: "the time zone region the server is running in"
      tz_utc_offset:
        type: "integer"
        format: "int64"
        description: "the UTC offset in seconds east of UTC; negative numbers indicate west of UTC"
