Rocket.Chat REST API OAS 3.0.0

openapi.yaml

openapi: 3.0.0
info:
  description: defaultDescription
  version: "0.1"
  title: defaultTitle
paths:
  /api/v1/info:
    get:
      responses:
        "200":
          description: Definition generated from Swagger Inspector
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Model1"
  /api/v1/login:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Model0"
        x-examples:
          application/json: '{ "user": "fliptrail", "password": "password" }'
      responses:
        "200":
          description: Definition generated from Swagger Inspector
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Model2"
  /api/v1/me:
    get:
      parameters:
        - name: X-Auth-Token
          in: header
          description: Generated header parameter. Example value
            ='spYg3odimGXv2spGA6Q9mcdIbTKDXqBNmD3Va2pCe4N'
          required: false
          example: spYg3odimGXv2spGA6Q9mcdIbTKDXqBNmD3Va2pCe4N
          schema:
            type: string
        - name: X-User-Id
          in: header
          description: Generated header parameter. Example value ='yBNXbgGeogEH6wqXT'
          required: false
          example: yBNXbgGeogEH6wqXT
          schema:
            type: string
      responses:
        "200":
          description: Definition generated from Swagger Inspector
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Model3"
  /api/v1/directory:
    get:
      parameters:
        - name: workspace
          in: query
          required: false
          example: local
          schema:
            type: string
        - name: text
          in: query
          required: false
          example: rocket
          schema:
            type: string
        - name: type
          in: query
          required: false
          example: users
          schema:
            type: string
        - name: X-Auth-Token
          in: header
          description: Generated header parameter. Example value
            ='spYg3odimGXv2spGA6Q9mcdIbTKDXqBNmD3Va2pCe4N'
          required: false
          example: spYg3odimGXv2spGA6Q9mcdIbTKDXqBNmD3Va2pCe4N
          schema:
            type: string
        - name: X-User-Id
          in: header
          description: Generated header parameter. Example value ='yBNXbgGeogEH6wqXT'
          required: false
          example: yBNXbgGeogEH6wqXT
          schema:
            type: string
      responses:
        "200":
          description: Definition generated from Swagger Inspector
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Model4"
components:
  schemas:
    Model0:
      properties:
        user:
          type: string
        password:
          type: string
    Info:
      properties:
        version:
          type: string
    Model1:
      properties:
        info:
          $ref: "#/components/schemas/Info"
        success:
          type: boolean
    Emails:
      properties:
        address:
          type: string
        verified:
          type: boolean
    Preferences:
      properties:
        enableAutoAway:
          type: boolean
        idleTimeLimit:
          type: integer
          format: int32
        desktopNotificationDuration:
          type: integer
          format: int32
        audioNotifications:
          type: string
        desktopNotifications:
          type: string
        mobileNotifications:
          type: string
        unreadAlert:
          type: boolean
        useEmojis:
          type: boolean
        convertAsciiEmoji:
          type: boolean
        autoImageLoad:
          type: boolean
        saveMobileBandwidth:
          type: boolean
        collapseMediaByDefault:
          type: boolean
        hideUsernames:
          type: boolean
        hideRoles:
          type: boolean
        hideFlexTab:
          type: boolean
        hideAvatars:
          type: boolean
        sidebarGroupByType:
          type: boolean
        sidebarViewMode:
          type: string
        sidebarHideAvatar:
          type: boolean
        sidebarShowUnread:
          type: boolean
        sidebarShowFavorites:
          type: boolean
        sendOnEnter:
          type: string
        messageViewMode:
          type: integer
          format: int32
        emailNotificationMode:
          type: string
        roomCounterSidebar:
          type: boolean
        newRoomNotification:
          type: string
        newMessageNotification:
          type: string
        muteFocusedConversations:
          type: boolean
        notificationsSoundVolume:
          type: integer
          format: int32
        sidebarShowDiscussion:
          type: boolean
    Settings:
      properties:
        preferences:
          $ref: "#/components/schemas/Preferences"
    Me:
      properties:
        _id:
          type: string
        name:
          type: string
        emails:
          type: array
          items:
            $ref: "#/components/schemas/Emails"
        status:
          type: string
        statusConnection:
          type: string
        username:
          type: string
        utcOffset:
          type: number
          format: double
        active:
          type: boolean
        language:
          type: string
        roles:
          type: array
          items:
            type: string
        settings:
          $ref: "#/components/schemas/Settings"
    Data:
      properties:
        userId:
          type: string
        authToken:
          type: string
        me:
          $ref: "#/components/schemas/Me"
    Model2:
      properties:
        status:
          type: string
        data:
          $ref: "#/components/schemas/Data"
    Model3_Emails:
      properties:
        address:
          type: string
        verified:
          type: boolean
    Model3_Settings_Preferences:
      properties:
        enableAutoAway:
          type: boolean
        idleTimeLimit:
          type: integer
          format: int32
        desktopNotificationDuration:
          type: integer
          format: int32
        audioNotifications:
          type: string
        desktopNotifications:
          type: string
        mobileNotifications:
          type: string
        unreadAlert:
          type: boolean
        useEmojis:
          type: boolean
        convertAsciiEmoji:
          type: boolean
        autoImageLoad:
          type: boolean
        saveMobileBandwidth:
          type: boolean
        collapseMediaByDefault:
          type: boolean
        hideUsernames:
          type: boolean
        hideRoles:
          type: boolean
        hideFlexTab:
          type: boolean
        hideAvatars:
          type: boolean
        sidebarGroupByType:
          type: boolean
        sidebarViewMode:
          type: string
        sidebarHideAvatar:
          type: boolean
        sidebarShowUnread:
          type: boolean
        sidebarShowFavorites:
          type: boolean
        sendOnEnter:
          type: string
        messageViewMode:
          type: integer
          format: int32
        emailNotificationMode:
          type: string
        roomCounterSidebar:
          type: boolean
        newRoomNotification:
          type: string
        newMessageNotification:
          type: string
        muteFocusedConversations:
          type: boolean
        notificationsSoundVolume:
          type: integer
          format: int32
        sidebarShowDiscussion:
          type: boolean
    Model3_Settings:
      properties:
        preferences:
          $ref: "#/components/schemas/Model3_Settings_Preferences"
    Model3:
      properties:
        _id:
          type: string
        name:
          type: string
        emails:
          type: array
          items:
            $ref: "#/components/schemas/Model3_Emails"
        status:
          type: string
        statusConnection:
          type: string
        username:
          type: string
        utcOffset:
          type: number
          format: double
        active:
          type: boolean
        language:
          type: string
        roles:
          type: array
          items:
            type: string
        settings:
          $ref: "#/components/schemas/Model3_Settings"
        success:
          type: boolean
    U:
      properties:
        _id:
          type: string
        username:
          type: string
        name:
          type: string
    LastMessage:
      properties:
        _id:
          type: string
        rid:
          type: string
        msg:
          type: string
        ts:
          type: string
        u:
          $ref: "#/components/schemas/U"
        mentions:
          type: array
          items:
            {}
        channels:
          type: array
          items:
            {}
        _updatedAt:
          type: string
    Result:
      properties:
        _id:
          type: string
        name:
          type: string
        usersCount:
          type: integer
          format: int32
        ts:
          type: string
        lastMessage:
          $ref: "#/components/schemas/LastMessage"
    Model4:
      properties:
        result:
          type: array
          items:
            $ref: "#/components/schemas/Result"
        count:
          type: integer
          format: int32
        offset:
          type: integer
          format: int32
        total:
          type: integer
          format: int32
        success:
          type: boolean