Arduino lora_apps_v1 API

The lora_apps_v1 API from Arduino — 1 operation(s) for lora_apps_v1.

OpenAPI Specification

arduino-lora-apps-v1-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  description: Provides a set of endpoints to manage Devices, Things, Properties and Timeseries
  title: Arduino IoT Cloud binaries_v2 lora_apps_v1 API
  version: '2.0'
tags:
- name: lora_apps_v1
paths:
  /iot/v1/lora-apps/:
    get:
      description: List the available apps for the given user
      operationId: lora_apps_v1#list
      parameters:
      - description: The user id. Could be a uuid, or the string 'me'
        in: query
        name: user_id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '401':
          content:
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/error'
            text/plain:
              schema:
                $ref: '#/components/schemas/error'
          description: Unauthorized
        '500':
          content:
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/error'
            text/plain:
              schema:
                $ref: '#/components/schemas/error'
          description: Internal Server Error
      summary: list lora_apps_v1
      tags:
      - lora_apps_v1
    post:
      description: Update the available apps for the given user
      operationId: lora_apps_v1#update
      parameters:
      - description: The user id. Could be a uuid, or the string 'me'
        in: query
        name: user_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLoraAppsV1Payload'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateLoraAppsV1Payload'
        required: true
        x-originalParamName: payload
      responses:
        '200':
          description: OK
        '400':
          content:
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/error'
            text/plain:
              schema:
                $ref: '#/components/schemas/error'
          description: Bad Request
        '401':
          content:
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/error'
            text/plain:
              schema:
                $ref: '#/components/schemas/error'
          description: Unauthorized
        '500':
          content:
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/error'
            text/plain:
              schema:
                $ref: '#/components/schemas/error'
          description: Internal Server Error
      summary: update lora_apps_v1
      tags:
      - lora_apps_v1
components:
  schemas:
    UpdateLoraAppsV1Payload:
      properties:
        apps:
          items:
            type: string
          type: array
      title: UpdateLoraAppsV1Payload
      type: object
    error:
      description: Error response media type (default view)
      properties:
        code:
          description: an application-specific error code, expressed as a string value.
          example: invalid_value
          type: string
        detail:
          description: a human-readable explanation specific to this occurrence of the problem.
          example: Value of ID must be an integer
          type: string
        id:
          description: a unique identifier for this particular occurrence of the problem.
          example: 3F1FKVRR
          type: string
        meta:
          additionalProperties: true
          description: a meta object containing non-standard meta-information about the error.
          example:
            timestamp: 1458609066
          type: object
        status:
          description: the HTTP status code applicable to this problem, expressed as a string value.
          example: '400'
          type: string
      title: 'Mediatype identifier: application/vnd.goa.error+json; view=default'
      type: object
externalDocs:
  description: See docs on Confluence
  url: https://arduino.atlassian.net/wiki/spaces/FTWEB/pages/91160610/Arduino+IoT+Cloud