The Things Network / The Things Stack AppAs API

openapi: 3.2.0
info:
  title: Things Stack — Application Server App As API
  version: v3.36
  description: The Things Stack is an open-source LoRaWAN Network Server implementation. This OpenAPI was derived from the upstream gRPC-Gateway generated api.swagger.json published by TheThingsNetwork/lorawan-stack v3.36.
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    name: The Things Industries
    url: https://www.thethingsindustries.com
servers:
- url: https://eu1.cloud.thethings.industries/api/v3
security:
- ApiKeyAuth: []
tags:
- name: AppAs
paths:
  /as/applications/{application_ids.application_id}/devices/{device_id}/down:
    get:
      summary: List the items currently in the downlink queue.
      operationId: AppAs_DownlinkQueueList
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3ApplicationDownlinks'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: application_ids.application_id
        in: path
        required: true
        schema:
          type: string
      - name: device_id
        in: path
        required: true
        schema:
          type: string
      - name: dev_eui
        description: The LoRaWAN DevEUI.
        in: query
        required: false
        schema:
          type: string
          format: string
      - name: join_eui
        description: The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).
        in: query
        required: false
        schema:
          type: string
          format: string
      - name: dev_addr
        description: The LoRaWAN DevAddr.
        in: query
        required: false
        schema:
          type: string
          format: string
      tags:
      - AppAs
  /as/applications/{application_id}/mqtt-connection-info:
    get:
      summary: Get connection information to connect an MQTT client.
      operationId: AppAs_GetMQTTConnectionInfo
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3MQTTConnectionInfo'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: application_id
        in: path
        required: true
        schema:
          type: string
      tags:
      - AppAs
  /as/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}/down/decode:
    post:
      operationId: AppAs_DecodeDownlink
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3DecodeDownlinkResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: end_device_ids.application_ids.application_id
        in: path
        required: true
        schema:
          type: string
      - name: end_device_ids.device_id
        in: path
        required: true
        schema:
          type: string
      tags:
      - AppAs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppAsDecodeDownlinkBody'
        required: true
  /as/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}/down/encode:
    post:
      operationId: AppAs_EncodeDownlink
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3EncodeDownlinkResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: end_device_ids.application_ids.application_id
        in: path
        required: true
        schema:
          type: string
      - name: end_device_ids.device_id
        in: path
        required: true
        schema:
          type: string
      tags:
      - AppAs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppAsEncodeDownlinkBody'
        required: true
  /as/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}/down/push:
    post:
      summary: Push downlink messages to the end of the downlink queue.
      operationId: AppAs_DownlinkQueuePush
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                type: object
                properties: {}
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: end_device_ids.application_ids.application_id
        in: path
        required: true
        schema:
          type: string
      - name: end_device_ids.device_id
        in: path
        required: true
        schema:
          type: string
      tags:
      - AppAs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v3AppAsDownlinkQueuePushBody'
        required: true
  /as/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}/down/replace:
    post:
      summary: 'Replace the entire downlink queue with the specified messages.

        This can also be used to empty the queue by specifying no messages.'
      operationId: AppAs_DownlinkQueueReplace
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                type: object
                properties: {}
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: end_device_ids.application_ids.application_id
        in: path
        required: true
        schema:
          type: string
      - name: end_device_ids.device_id
        in: path
        required: true
        schema:
          type: string
      tags:
      - AppAs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v3AppAsDownlinkQueueReplaceBody'
        required: true
  /as/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}/up/decode:
    post:
      operationId: AppAs_DecodeUplink
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v3DecodeUplinkResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: end_device_ids.application_ids.application_id
        in: path
        required: true
        schema:
          type: string
      - name: end_device_ids.device_id
        in: path
        required: true
        schema:
          type: string
      tags:
      - AppAs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppAsDecodeUplinkBody'
        required: true
  /as/applications/{end_device_ids.application_ids.application_id}/devices/{end_device_ids.device_id}/up/simulate:
    post:
      summary: Simulate an upstream message. This can be used to test integrations.
      operationId: AppAs_SimulateUplink
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                type: object
                properties: {}
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/googlerpcStatus'
      parameters:
      - name: end_device_ids.application_ids.application_id
        in: path
        required: true
        schema:
          type: string
      - name: end_device_ids.device_id
        in: path
        required: true
        schema:
          type: string
      tags:
      - AppAs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppAsSimulateUplinkBody'
        required: true
components:
  schemas:
    v3DecodeUplinkResponse:
      type: object
      properties:
        uplink:
          $ref: '#/components/schemas/v3ApplicationUplink'
    v3LastBatteryPercentage:
      type: object
      properties:
        f_cnt:
          type: integer
          format: int64
          description: Frame counter value of last uplink containing DevStatusAns.
        value:
          type: number
          format: float
          description: 'The battery percentage of the end device.

            The value is defined in the [0, 100] interval.'
        received_at:
          type: string
          format: date-time
          description: Time when last DevStatus MAC command was received.
    ApplicationDownlinkConfirmedRetry:
      type: object
      properties:
        attempt:
          type: integer
          format: int64
          description: The number of attempted confirmed downlink acknowledgements.
        max_attempts:
          type: integer
          format: int64
          description: 'The maximum number of confirmed downlink acknowledgement attempts.

            If null, the Application Server configuration is used instead.'
    v3LocationSource:
      type: string
      enum:
      - SOURCE_UNKNOWN
      - SOURCE_GPS
      - SOURCE_REGISTRY
      - SOURCE_IP_GEOLOCATION
      - SOURCE_WIFI_RSSI_GEOLOCATION
      - SOURCE_BT_RSSI_GEOLOCATION
      - SOURCE_LORA_RSSI_GEOLOCATION
      - SOURCE_LORA_TDOA_GEOLOCATION
      - SOURCE_COMBINED_GEOLOCATION
      default: SOURCE_UNKNOWN
      description: " - SOURCE_UNKNOWN: The source of the location is not known or not set.\n - SOURCE_GPS: The location is determined by GPS.\n - SOURCE_REGISTRY: The location is set in and updated from a registry.\n - SOURCE_IP_GEOLOCATION: The location is estimated with IP geolocation.\n - SOURCE_WIFI_RSSI_GEOLOCATION: The location is estimated with WiFi RSSI geolocation.\n - SOURCE_BT_RSSI_GEOLOCATION: The location is estimated with BT/BLE RSSI geolocation.\n - SOURCE_LORA_RSSI_GEOLOCATION: The location is estimated with LoRa RSSI geolocation.\n - SOURCE_LORA_TDOA_GEOLOCATION: The location is estimated with LoRa TDOA geolocation.\n - SOURCE_COMBINED_GEOLOCATION: The location is estimated by a combination of geolocation sources.\n\nMore estimation methods can be added."
    v3PacketBrokerRouteHop:
      type: object
      properties:
        received_at:
          type: string
          format: date-time
          description: Time when the service received the message.
        sender_name:
          type: string
          description: Sender of the message, typically the authorized client identifier.
        sender_address:
          type: string
          description: Sender IP address or host name.
        receiver_name:
          type: string
          description: Receiver of the message.
        receiver_agent:
          type: string
          description: Receiver agent.
    v3LRFHSSDataRate:
      type: object
      properties:
        modulation_type:
          type: integer
          format: int64
        operating_channel_width:
          type: integer
          format: int64
          description: Operating Channel Width (Hz).
        coding_rate:
          type: string
    v3ApplicationJoinAccept:
      type: object
      properties:
        session_key_id:
          type: string
          format: byte
          description: Join Server issued identifier for the session keys negotiated in this join.
        app_s_key:
          $ref: '#/components/schemas/v3KeyEnvelope'
          description: Encrypted Application Session Key (if Join Server sent it to Network Server).
        invalidated_downlinks:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/v3ApplicationDownlink'
          description: Downlink messages in the queue that got invalidated because of the session change.
        pending_session:
          type: boolean
          description: 'Indicates whether the security context refers to the pending session, i.e. when this join-accept is an answer to a

            rejoin-request.'
        received_at:
          type: string
          format: date-time
          description: Server time when the Network Server received the message.
        locations:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/lorawanv3Location'
          description: End device location metadata, set by the Application Server while handling the message.
        version_ids:
          $ref: '#/components/schemas/v3EndDeviceVersionIdentifiers'
          description: End device version identifiers, set by the Application Server while handling the message.
        network_ids:
          $ref: '#/components/schemas/v3NetworkIdentifiers'
          description: Network identifiers, set by the Network Server that handles the message.
        attributes:
          type: object
          additionalProperties:
            type: string
          description: Attributes for devices, set by the Application Server while handling the message.
    ApplicationDownlinkClassBC:
      type: object
      properties:
        gateways:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/v3ClassBCGatewayIdentifiers'
          description: 'Possible gateway identifiers, antenna index, and group index to use for this downlink message.

            The Network Server selects one of these gateways for downlink, based on connectivity, signal quality, channel utilization and an available slot.

            If none of the gateways can be selected, the downlink message fails.

            If empty, a gateway and antenna is selected automatically from the gateways seen in recent uplinks.

            If group index is set, gateways will be grouped by the index for the Network Server to select one gateway per group.'
        absolute_time:
          type: string
          format: date-time
          description: 'Absolute time when the downlink message should be transmitted.

            This requires the gateway to have GPS time synchronization.

            If the time is in the past or if there is a scheduling conflict, the downlink message fails.

            If null, the time is selected based on slot availability. This is recommended in class B mode.'
    v3KeyEnvelope:
      type: object
      properties:
        key:
          type: string
          format: string
          example: 0123456789ABCDEF0123456789ABCDEF
          description: The unencrypted AES key.
        kek_label:
          type: string
          description: The label of the RFC 3394 key-encryption-key (KEK) that was used to encrypt the key.
        encrypted_key:
          type: string
          format: byte
    v3ErrorDetails:
      type: object
      properties:
        namespace:
          type: string
          description: Namespace of the error (typically the package name in The Things Stack).
        name:
          type: string
          description: Name of the error.
        message_format:
          type: string
          description: 'The default (fallback) message format that should be used for the error.

            This is also used if the client does not have a translation for the error.'
        attributes:
          type: object
          description: 'Attributes that should be filled into the message format. Any extra attributes

            can be displayed as error details.'
        correlation_id:
          type: string
          description: 'The correlation ID of the error can be used to correlate the error to stack

            traces the network may (or may not) store about recent errors.'
        cause:
          $ref: '#/components/schemas/v3ErrorDetails'
          description: The error that caused this error.
        code:
          type: integer
          format: int64
          description: The status code of the error.
        details:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/protobufAny'
          description: The details of the error.
      description: 'Error details that are communicated over gRPC (and HTTP) APIs.

        The messages (for translation) are stored as "error:<namespace>:<name>".'
    googlerpcStatus:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/protobufAny'
    v3ApplicationDownlink:
      type: object
      properties:
        session_key_id:
          type: string
          format: byte
          description: Join Server issued identifier for the session keys used by this downlink.
        f_port:
          type: integer
          format: int64
        f_cnt:
          type: integer
          format: int64
        frm_payload:
          type: string
          format: byte
          description: 'The frame payload of the downlink message.

            The payload is encrypted if the skip_payload_crypto field of the EndDevice

            is true.'
        decoded_payload:
          type: object
          description: 'The decoded frame payload of the downlink message.

            When scheduling downlink with a message processor configured for the end device (see formatters) or application (see default_formatters),

            this fields acts as input for the downlink encoder, and the output is set to frm_payload.

            When reading downlink (listing the queue, downlink message events, etc), this fields acts as output of the downlink decoder, and the input is frm_payload.'
        decoded_payload_warnings:
          type: array
          items:
            type: string
          description: Warnings generated by the message processor while encoding frm_payload (scheduling downlink) or decoding the frm_payload (reading downlink).
        confirmed:
          type: boolean
        class_b_c:
          $ref: '#/components/schemas/ApplicationDownlinkClassBC'
          description: 'Optional gateway and timing information for class B and C.

            If set, this downlink message will only be transmitted as class B or C downlink.

            If not set, this downlink message may be transmitted in class A, B and C.'
        priority:
          $ref: '#/components/schemas/v3TxSchedulePriority'
          description: Priority for scheduling the downlink message.
        correlation_ids:
          type: array
          items:
            type: string
        confirmed_retry:
          $ref: '#/components/schemas/ApplicationDownlinkConfirmedRetry'
        locations:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/lorawanv3Location'
          description: End device location metadata, set by the Application Server while handling the message.
        version_ids:
          $ref: '#/components/schemas/v3EndDeviceVersionIdentifiers'
          description: End device version identifiers, set by the Application Server while handling the message.
        network_ids:
          $ref: '#/components/schemas/v3NetworkIdentifiers'
          description: Network identifiers, set by the Network Server that handles the message.
        attributes:
          type: object
          additionalProperties:
            type: string
          description: Attributes for devices, set by the Application Server while handling the message.
    AppAsEncodeDownlinkBody:
      type: object
      properties:
        end_device_ids:
          type: object
          properties:
            application_ids:
              type: object
            dev_eui:
              type: string
              format: string
              example: 70B3D57ED000ABCD
              description: The LoRaWAN DevEUI.
            join_eui:
              type: string
              format: string
              example: 70B3D57ED000ABCD
              description: The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).
            dev_addr:
              type: string
              format: string
              example: 2600ABCD
              description: The LoRaWAN DevAddr.
        version_ids:
          $ref: '#/components/schemas/v3EndDeviceVersionIdentifiers'
        downlink:
          $ref: '#/components/schemas/v3ApplicationDownlink'
        formatter:
          $ref: '#/components/schemas/v3PayloadFormatter'
        parameter:
          type: string
    v3DecodeDownlinkResponse:
      type: object
      properties:
        downlink:
          $ref: '#/components/schemas/v3ApplicationDownlink'
    lorawanv3GatewayIdentifiers:
      type: object
      properties:
        gateway_id:
          type: string
        eui:
          type: string
          format: string
          example: 70B3D57ED000ABCD
          description: Secondary identifier, which can only be used in specific requests.
    v3EndDeviceVersionIdentifiers:
      type: object
      properties:
        brand_id:
          type: string
        model_id:
          type: string
        hardware_version:
          type: string
        firmware_version:
          type: string
        band_id:
          type: string
      description: Identifies an end device model with version information.
    v3ApplicationDownlinkFailed:
      type: object
      properties:
        downlink:
          $ref: '#/components/schemas/v3ApplicationDownlink'
        error:
          $ref: '#/components/schemas/v3ErrorDetails'
        locations:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/lorawanv3Location'
          description: End device location metadata, set by the Application Server while handling the message.
        version_ids:
          $ref: '#/components/schemas/v3EndDeviceVersionIdentifiers'
          description: End device version identifiers, set by the Application Server while handling the message.
        network_ids:
          $ref: '#/components/schemas/v3NetworkIdentifiers'
          description: Network identifiers, set by the Network Server that handles the message.
        attributes:
          type: object
          additionalProperties:
            type: string
          description: Attributes for devices, set by the Application Server while handling the message.
    AppAsDecodeDownlinkBody:
      type: object
      properties:
        end_device_ids:
          type: object
          properties:
            application_ids:
              type: object
            dev_eui:
              type: string
              format: string
              example: 70B3D57ED000ABCD
              description: The LoRaWAN DevEUI.
            join_eui:
              type: string
              format: string
              example: 70B3D57ED000ABCD
              description: The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).
            dev_addr:
              type: string
              format: string
              example: 2600ABCD
              description: The LoRaWAN DevAddr.
        version_ids:
          $ref: '#/components/schemas/v3EndDeviceVersionIdentifiers'
        downlink:
          $ref: '#/components/schemas/v3ApplicationDownlink'
        formatter:
          $ref: '#/components/schemas/v3PayloadFormatter'
        parameter:
          type: string
    lorawanv3Location:
      type: object
      properties:
        latitude:
          type: number
          format: double
          description: The North–South position (degrees; -90 to +90), where 0 is the equator, North pole is positive, South pole is negative.
        longitude:
          type: number
          format: double
          description: The East-West position (degrees; -180 to +180), where 0 is the Prime Meridian (Greenwich), East is positive , West is negative.
        altitude:
          type: integer
          format: int32
          description: The altitude (meters), where 0 is the mean sea level.
        accuracy:
          type: integer
          format: int32
          description: The accuracy of the location (meters).
        source:
          $ref: '#/components/schemas/v3LocationSource'
          description: Source of the location information.
    v3ApplicationInvalidatedDownlinks:
      type: object
      properties:
        downlinks:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/v3ApplicationDownlink'
        last_f_cnt_down:
          type: integer
          format: int64
        session_key_id:
          type: string
          format: byte
        locations:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/lorawanv3Location'
          description: End device location metadata, set by the Application Server while handling the message.
        version_ids:
          $ref: '#/components/schemas/v3EndDeviceVersionIdentifiers'
          description: End device version identifiers, set by the Application Server while handling the message.
        network_ids:
          $ref: '#/components/schemas/v3NetworkIdentifiers'
          description: Network identifiers, set by the Network Server that handles the message.
        attributes:
          type: object
          additionalProperties:
            type: string
          description: Attributes for devices, set by the Application Server while handling the message.
    lorawanv3RelayMetadata:
      type: object
      properties:
        device_id:
          type: string
          description: End device identifiers of the relay.
        wor_channel:
          $ref: '#/components/schemas/lorawanv3RelayWORChannel'
          description: Wake on radio channel.
    protobufAny:
      type: object
      properties:
        '@type':
          type: string
          description: "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
      additionalProperties: {}
      description: "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n    // or ...\n    if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n      foo = any.unpack(Foo.getDefaultInstance());\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := anypb.New(foo)\n     if err != nil {\n       ...\n     }\n     ...\n     foo := &pb.Foo{}\n     if err := any.UnmarshalTo(foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }"
    AppAsDecodeUplinkBody:
      type: object
      properties:
        end_device_ids:
          type: object
          properties:
            application_ids:
              type: object
            dev_eui:
              type: string
              format: string
              example: 70B3D57ED000ABCD
              description: The LoRaWAN DevEUI.
            join_eui:
              type: string
              format: string
              example: 70B3D57ED000ABCD
              description: The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).
            dev_addr:
              type: string
              format: string
              example: 2600ABCD
              description: The LoRaWAN DevAddr.
        version_ids:
          $ref: '#/components/schemas/v3EndDeviceVersionIdentifiers'
        uplink:
          $ref: '#/components/schemas/v3ApplicationUplink'
        formatter:
          $ref: '#/components/schemas/v3PayloadFormatter'
        parameter:
          type: string
    v3ClassBCGatewayIdentifiers:
      type: object
      properties:
        gateway_ids:
          $ref: '#/components/schemas/lorawanv3GatewayIdentifiers'
        antenna_index:
          type: integer
          format: int64
        group_index:
          type: integer
          format: int64
    v3DownlinkPathConstraint:
      type: string
      enum:
      - DOWNLINK_PATH_CONSTRAINT_NONE
      - DOWNLINK_PATH_CONSTRAINT_PREFER_OTHER
      - DOWNLINK_PATH_CONSTRAINT_NEVER
      default: D

# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/the-things-network/refs/heads/main/openapi/the-things-network-appas-api-openapi.yml