Arduino lora_freq_plan_v1 API

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

OpenAPI Specification

arduino-lora-freq-plan-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_freq_plan_v1 API
  version: '2.0'
tags:
- name: lora_freq_plan_v1
paths:
  /iot/v1/lora-freq-plans/:
    get:
      description: List the lora frequency plans supported
      operationId: lora_freq_plan_v1#list
      responses:
        '200':
          content:
            application/vnd.arduino.lorafreqplansv1+json:
              schema:
                $ref: '#/components/schemas/ArduinoLorafreqplansv1'
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/ArduinoLorafreqplansv1'
          description: OK
        '401':
          content:
            application/vnd.arduino.lorafreqplansv1+json:
              schema:
                $ref: '#/components/schemas/error'
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Unauthorized
        '500':
          content:
            application/vnd.arduino.lorafreqplansv1+json:
              schema:
                $ref: '#/components/schemas/error'
            application/vnd.goa.error+json:
              schema:
                $ref: '#/components/schemas/error'
          description: Internal Server Error
      summary: list lora_freq_plan_v1
      tags:
      - lora_freq_plan_v1
components:
  schemas:
    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
    ArduinoLorafreqplansv1:
      description: ArduinoLorafreqplansv1 media type (default view)
      properties:
        frequency_plans:
          description: The list of frequency plans
          items:
            $ref: '#/components/schemas/ArduinoLorafreqplanv1'
          type: array
      title: 'Mediatype identifier: application/vnd.arduino.lorafreqplansv1+json; view=default'
      type: object
    ArduinoLorafreqplanv1:
      description: ArduinoLorafreqplanv1 media type (default view)
      properties:
        advanced:
          description: Frequency plan only for advanced users
          type: boolean
        id:
          description: The ID of the frequency paln
          type: string
        name:
          description: The name of the frequency plan
          type: string
      required:
      - name
      - id
      - advanced
      title: 'Mediatype identifier: application/vnd.arduino.lorafreqplanv1+json; view=default'
      type: object
externalDocs:
  description: See docs on Confluence
  url: https://arduino.atlassian.net/wiki/spaces/FTWEB/pages/91160610/Arduino+IoT+Cloud