openapi: 3.0.3
info:
  title: iot_connect_sber
  version: 1.0.1784208637468
  description: Сервис iot_connect_sber
  license:
    name: CC BY-NC-ND 4.0
    url: https://gitlab.infra.rtkit.dev/openapi/key/raw/main/LICENCE.md
tags:
  - name: command(auth)
    description: Методы command. Требуют авторизацию. Доступны из интернета
  - name: devices(auth)
    description: Методы devices. Требуют авторизацию. Доступны из интернета
  - name: unlink(auth)
    description: Методы unlink. Требуют авторизацию. Доступны из интернета
  - name: user(auth)
    description: Методы user. Требуют авторизацию. Доступны из интернета
paths:
  /iot_connect_sber/api/v1/command:
    post:
      summary: |-
        Метод приема команд на изменение состояния устройства.
        Поддерживается только открытие домофона.
        Метод доступен для: TokenACF: Scope: sber_iot
      operationId: CommandService_PostCommand
      responses:
        "200":
          description: Успешный ответ
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/v1PostCommandResponse"
        "400":
          description: Ошибка
        "401":
          description: Запрос не авторизован
        "403":
          description: В доступе отказано
        "409":
          description: В базе данных хранится более новая версия объекта
        "500":
          description: Внутренняя ошибка сервиса
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/rpcStatus"
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/v1PostCommandRequest"
        required: true
      tags:
        - command(auth)
      security:
        - oauth2:
            - iot_connect_sber:edit
          bearerHttp: []
      parameters:
        - in: header
          name: X-Request-Id
          schema:
            type: string
            format: uuid
          description: Уникальный идентификатор запроса. Создаётся клиентом на каждый запрос
        - in: header
          name: X-Device-Id
          schema:
            type: string
          description: Уникальный идентификатор устройства. Создаётся клиентом при первом
            запуске приложения. Если есть способ однозначно узнать идентификатор
            устройства, то создаётся на основе него и остаётся неизменным после
            переустановки приложения
        - in: header
          name: X-Api-Key
          schema:
            type: string
          description: Уникальный ключ для партнера. Создается администратором и
            передается партнерам.
        - in: header
          name: Canary
          schema:
            type: string
          description: Параметр балансировки запроса. Если для заголовка запроса
            установлено значение always, он будет перенаправлен на канареечный
            деплой. Если для заголовка установлено значение never, он никогда не
            будет перенаправлен на канареечный деплой
  /iot_connect_sber/api/v1/devices:
    get:
      summary: |-
        Метод получения устройств, доступных пользователю.
        Идентификатор пользователя - это subject из токена.
        Метод доступен для: TokenACF: Scope: sber_iot
      operationId: DevicesService_GetDevices
      responses:
        "200":
          description: Успешный ответ
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/v1GetDevicesResponse"
        "400":
          description: Ошибка
        "401":
          description: Запрос не авторизован
        "403":
          description: В доступе отказано
        "500":
          description: Внутренняя ошибка сервиса
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/rpcStatus"
      tags:
        - devices(auth)
      security:
        - oauth2:
            - iot_connect_sber:read
            - iot_connect_sber:edit
          bearerHttp: []
      parameters:
        - in: header
          name: X-Request-Id
          schema:
            type: string
            format: uuid
          description: Уникальный идентификатор запроса. Создаётся клиентом на каждый запрос
        - in: header
          name: X-Device-Id
          schema:
            type: string
          description: Уникальный идентификатор устройства. Создаётся клиентом при первом
            запуске приложения. Если есть способ однозначно узнать идентификатор
            устройства, то создаётся на основе него и остаётся неизменным после
            переустановки приложения
        - in: header
          name: X-Api-Key
          schema:
            type: string
          description: Уникальный ключ для партнера. Создается администратором и
            передается партнерам.
        - in: header
          name: Canary
          schema:
            type: string
          description: Параметр балансировки запроса. Если для заголовка запроса
            установлено значение always, он будет перенаправлен на канареечный
            деплой. Если для заголовка установлено значение never, он никогда не
            будет перенаправлен на канареечный деплой
  /iot_connect_sber/api/v1/unlink:
    post:
      summary: |-
        Метод разъединения аккаунтов.
        Идентификатор пользователя - это subject из токена.
        Метод доступен для: TokenACF: Scope: sber_iot
      operationId: UnlinkService_PostUnlink
      responses:
        "200":
          description: Успешный ответ
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/v1PostUnlinkResponse"
        "400":
          description: Ошибка
        "401":
          description: Запрос не авторизован
        "403":
          description: В доступе отказано
        "409":
          description: В базе данных хранится более новая версия объекта
        "500":
          description: Внутренняя ошибка сервиса
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/rpcStatus"
      tags:
        - unlink(auth)
      security:
        - oauth2:
            - iot_connect_sber:edit
          bearerHttp: []
      parameters:
        - in: header
          name: X-Request-Id
          schema:
            type: string
            format: uuid
          description: Уникальный идентификатор запроса. Создаётся клиентом на каждый запрос
        - in: header
          name: X-Device-Id
          schema:
            type: string
          description: Уникальный идентификатор устройства. Создаётся клиентом при первом
            запуске приложения. Если есть способ однозначно узнать идентификатор
            устройства, то создаётся на основе него и остаётся неизменным после
            переустановки приложения
        - in: header
          name: X-Api-Key
          schema:
            type: string
          description: Уникальный ключ для партнера. Создается администратором и
            передается партнерам.
        - in: header
          name: Canary
          schema:
            type: string
          description: Параметр балансировки запроса. Если для заголовка запроса
            установлено значение always, он будет перенаправлен на канареечный
            деплой. Если для заголовка установлено значение never, он никогда не
            будет перенаправлен на канареечный деплой
  /iot_connect_sber/api/v1/user:
    get:
      summary: |-
        Метод получения пользователя для соединения аккаунтов.
        Идентификатор пользователя - это subject из токена.
        Метод доступен для: TokenACF: Scope: sber_iot
      operationId: UserService_GetUser
      responses:
        "200":
          description: Успешный ответ
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/v1GetUserResponse"
        "400":
          description: Ошибка
        "401":
          description: Запрос не авторизован
        "403":
          description: В доступе отказано
        "500":
          description: Внутренняя ошибка сервиса
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/rpcStatus"
      tags:
        - user(auth)
      security:
        - oauth2:
            - iot_connect_sber:read
            - iot_connect_sber:edit
          bearerHttp: []
      parameters:
        - in: header
          name: X-Request-Id
          schema:
            type: string
            format: uuid
          description: Уникальный идентификатор запроса. Создаётся клиентом на каждый запрос
        - in: header
          name: X-Device-Id
          schema:
            type: string
          description: Уникальный идентификатор устройства. Создаётся клиентом при первом
            запуске приложения. Если есть способ однозначно узнать идентификатор
            устройства, то создаётся на основе него и остаётся неизменным после
            переустановки приложения
        - in: header
          name: X-Api-Key
          schema:
            type: string
          description: Уникальный ключ для партнера. Создается администратором и
            передается партнерам.
        - in: header
          name: Canary
          schema:
            type: string
          description: Параметр балансировки запроса. Если для заголовка запроса
            установлено значение always, он будет перенаправлен на канареечный
            деплой. Если для заголовка установлено значение never, он никогда не
            будет перенаправлен на канареечный деплой
components:
  schemas:
    ModelFeatureType:
      type: string
      enum:
        - INCOMING_CALL
        - ONLINE
        - REJECT_CALL
        - UNLOCK
      description: |-
        - FEATURE_TYPE_UNKNOWN: Значение не указано
         - INCOMING_CALL: Сигнализация о поступившем звонке
         - ONLINE: Сигнализация о доступности устройства
         - REJECT_CALL: Отклонение звонка
         - UNLOCK: Открытие замка
      title: Список функций устройства
    ValueValueEnumType:
      type: string
      enum:
        - REJECT
        - UNLOCK
      description: |-
        - VALUE_ENUM_TYPE_UNKNOWN: Значение не указано
         - REJECT: Отклонение звонка
         - UNLOCK: Открытие замка
      title: Значения команд на изменение статуса устройства типа перечисление
    protobufAny:
      type: object
      properties:
        "@type":
          type: string
      additionalProperties: {}
      title: Произвольный JSON
    rpcStatus:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: "#/components/schemas/protobufAny"
      title: Ошибка транспортного слоя
    v1Device:
      type: object
      properties:
        id:
          type: string
          title: |-
            Идентификатор устройства на платформе Ключ.
            Конкатенация user_id и device_id плафтормы Ключ
        name:
          type: string
          title: Название устройства на платформе Ключ
        defaultName:
          type: string
          title: Название устройства от производителя
        home:
          type: string
          title: Адрес дома, где установлено устройство
        room:
          type: string
          title: Название или номер подъезда
        model:
          title: Тип устройства
          allOf:
            - $ref: "#/components/schemas/v1Model"
        hwVersion:
          type: string
          title: HW версия устройства
        swVersion:
          type: string
          title: SW версия устройства
      title: Объект устройства
    v1DeviceCommand:
      type: object
      properties:
        key:
          title: Тип команды на изменение статуса устройства
          allOf:
            - $ref: "#/components/schemas/v1DeviceCommandKeyType"
        value:
          title: Значение команды на изменение статуса устройства
          allOf:
            - $ref: "#/components/schemas/v1DeviceCommandValue"
      title: Команды на изменение статуса устройства
    v1DeviceCommandArray:
      type: object
      properties:
        states:
          type: array
          items:
            $ref: "#/components/schemas/v1DeviceCommand"
          title: Команды на изменение статуса устройства
      title: Массив команд на изменение статуса устройства
    v1DeviceCommandKeyType:
      type: string
      enum:
        - REJECT_CALL
        - UNLOCK
      description: |-
        - KEY_TYPE_UNKNOWN: Значение не указано
         - REJECT_CALL: Отклонение звонка
         - UNLOCK: Открытие замка
      title: Список ключей команд на изменение статуса устройства
    v1DeviceCommandValue:
      type: object
      properties:
        type:
          title: Тип значения команды на изменение статуса устройства
          allOf:
            - $ref: "#/components/schemas/v1DeviceCommandValueType"
        enum_value:
          title: Значения команды на изменение статуса устройства типа перечисление
          allOf:
            - $ref: "#/components/schemas/ValueValueEnumType"
      title: Значение команды на изменение статуса устройства
    v1DeviceCommandValueType:
      type: string
      enum:
        - ENUM
      description: |-
        - TYPE_UNKNOWN: Значение не указано
         - ENUM: Перечисление
      title: Тип значения команд на изменение статуса устройства
    v1GetDevicesResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/v1Device"
          title: Домофоны, доступные пользователю
      title: Ответ на запрос метода получения устройств, доступных пользователю
    v1GetUserResponse:
      type: object
      properties:
        id:
          type: integer
          format: int32
          title: Идентификатор пользователя
      title: Ответ на запрос метода получения пользователя для соединения аккаунтов
    v1Model:
      type: object
      properties:
        id:
          type: string
          title: Идентификатор модели
        manufacturer:
          type: string
          title: Производитель
        model:
          type: string
          title: Название модели
        hwVersion:
          type: string
          title: Версия оборудования
        swVersion:
          type: string
          title: Версия прошивки
        description:
          type: string
          title: Описание
        category:
          type: string
          title: Категория устройства
        features:
          type: array
          items:
            $ref: "#/components/schemas/ModelFeatureType"
          title: Список функций
      title: Объект Модель устройства
    v1PostCommandRequest:
      type: object
      properties:
        devices:
          type: object
          additionalProperties:
            $ref: "#/components/schemas/v1DeviceCommandArray"
          title: Массив домофонов со статусами
      title: Запрос на изменение состояния устройства
    v1PostCommandResponse:
      type: object
      title: Ответ на запрос на изменение состояния устройства
    v1PostUnlinkResponse:
      type: object
      title: Ответ на запрос метода разъединения аккаунтов
  securitySchemes:
    bearerHttp:
      type: http
      scheme: bearer
      bearerFormat: JWT
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://oauth2-staging.k8s.key.rt.ru/oauth2/token
          scopes:
            iot_connect_sber:edit: Предоставляет полный доступ в сервис iot_connect_sber
            iot_connect_sber:read: Предоставляет доступ на чтение данных из сервиса iot_connect_sber
servers:
  - url: https://keyapis-staging.k8s.key.rt.ru
    description: staging
  - url: https://{feature}.k8s.key.rt.ru/
    description: https feature
    variables:
      feature:
        default: ""
        description: Feature name
  - url: http://{feature}.k8s.key.rt.ru/
    description: http feature
    variables:
      feature:
        default: ""
        description: Feature name
  - url: https://localhost:3001
    description: localhost
  - url: https://keyapis.key.rt.ru
    description: production
