dr: Generate api definitions for get provisioning info endpoint

TheThingsNetwork · Aug 13, 2024 · cdd001d · cdd001d
1 parent 78a27d1
commit cdd001d
Show file tree

Hide file tree

Showing 4 changed files with 1,072 additions and 0 deletions.
diff --git a/api/ttn/lorawan/v3/api.md b/api/ttn/lorawan/v3/api.md
@@ -210,8 +210,10 @@
   - [Message `EndDeviceModel.Photos`](#ttn.lorawan.v3.EndDeviceModel.Photos)
   - [Message `EndDeviceModel.Reseller`](#ttn.lorawan.v3.EndDeviceModel.Reseller)
   - [Message `EndDeviceModel.Videos`](#ttn.lorawan.v3.EndDeviceModel.Videos)
+  - [Message `EndDeviceProvisioningInfo`](#ttn.lorawan.v3.EndDeviceProvisioningInfo)
   - [Message `GetEndDeviceBrandRequest`](#ttn.lorawan.v3.GetEndDeviceBrandRequest)
   - [Message `GetEndDeviceModelRequest`](#ttn.lorawan.v3.GetEndDeviceModelRequest)
+  - [Message `GetEndDeviceProvisioningInfoRequest`](#ttn.lorawan.v3.GetEndDeviceProvisioningInfoRequest)
   - [Message `GetPayloadFormatterRequest`](#ttn.lorawan.v3.GetPayloadFormatterRequest)
   - [Message `GetTemplateRequest`](#ttn.lorawan.v3.GetTemplateRequest)
   - [Message `GetTemplateRequest.EndDeviceProfileIdentifiers`](#ttn.lorawan.v3.GetTemplateRequest.EndDeviceProfileIdentifiers)
@@ -223,6 +225,7 @@
   - [Message `MessagePayloadDecoder.Example`](#ttn.lorawan.v3.MessagePayloadDecoder.Example)
   - [Message `MessagePayloadEncoder`](#ttn.lorawan.v3.MessagePayloadEncoder)
   - [Message `MessagePayloadEncoder.Example`](#ttn.lorawan.v3.MessagePayloadEncoder.Example)
+  - [Message `VendorProfile`](#ttn.lorawan.v3.VendorProfile)
   - [Enum `KeyProvisioning`](#ttn.lorawan.v3.KeyProvisioning)
   - [Enum `KeySecurity`](#ttn.lorawan.v3.KeySecurity)
   - [Service `DeviceRepository`](#ttn.lorawan.v3.DeviceRepository)
@@ -3444,6 +3447,13 @@ The GatewayClaimingServer service support claiming and managing gateway claims.
 | `main` | <p>`string.pattern`: `^(?:https?:\/\/(?:www\.)?youtu(?:be\.com\/watch\?v=|\.be\/)(?:[\w\-_]*)(?:&(amp;)?[\w\?=]*)?)$|^(?:https?:\/\/(?:www\.)?vimeo\.com\/(?:channels\/(?:\w+\/)?|groups\/([^\/]*)\/videos\/|)(?:\d+)(?:|\/\?))$`</p> |
 | `other` | <p>`repeated.unique`: `true`</p><p>`repeated.items.string.pattern`: `^(?:https?:\/\/(?:www\.)?youtu(?:be\.com\/watch\?v=|\.be\/)(?:[\w\-_]*)(?:&(amp;)?[\w\?=]*)?)$|^(?:https?:\/\/(?:www\.)?vimeo\.com\/(?:channels\/(?:\w+\/)?|groups\/([^\/]*)\/videos\/|)(?:\d+)(?:|\/\?))$`</p> |
 
+### <a name="ttn.lorawan.v3.EndDeviceProvisioningInfo">Message `EndDeviceProvisioningInfo`</a>
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| `end_device_model` | [`EndDeviceModel`](#ttn.lorawan.v3.EndDeviceModel) |  |  |
+| `end_device_template` | [`EndDeviceTemplate`](#ttn.lorawan.v3.EndDeviceTemplate) |  |  |
+
 ### <a name="ttn.lorawan.v3.GetEndDeviceBrandRequest">Message `GetEndDeviceBrandRequest`</a>
 
 | Field | Type | Label | Description |
@@ -3474,6 +3484,19 @@ The GatewayClaimingServer service support claiming and managing gateway claims.
 | `brand_id` | <p>`string.max_len`: `36`</p><p>`string.pattern`: `^[a-z0-9](?:[-]?[a-z0-9]){2,}$`</p> |
 | `model_id` | <p>`string.max_len`: `36`</p><p>`string.pattern`: `^[a-z0-9](?:[-]?[a-z0-9]){2,}$`</p> |
 
+### <a name="ttn.lorawan.v3.GetEndDeviceProvisioningInfoRequest">Message `GetEndDeviceProvisioningInfoRequest`</a>
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| `vendor_id` | [`uint32`](#uint32) |  | VendorID managed by the LoRa Alliance, as defined in TR005. |
+| `vendor_profile_id` | [`uint32`](#uint32) |  | ID of the LoRaWAN end device profile assigned by the vendor. |
+
+#### Field Rules
+
+| Field | Validations |
+| ----- | ----------- |
+| `vendor_id` | <p>`uint32.gte`: `1`</p> |
+
 ### <a name="ttn.lorawan.v3.GetPayloadFormatterRequest">Message `GetPayloadFormatterRequest`</a>
 
 | Field | Type | Label | Description |
@@ -3619,6 +3642,16 @@ Identifiers to uniquely identify a LoRaWAN end device profile.
 | ----- | ----------- |
 | `description` | <p>`string.max_len`: `200`</p> |
 
+### <a name="ttn.lorawan.v3.VendorProfile">Message `VendorProfile`</a>
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| `vendor_profile_id` | [`uint32`](#uint32) |  | ID of the LoRaWAN end device profile assigned by the vendor. |
+| `end_device_id` | [`string`](#string) |  | Device model identifier, as defined in the Device Repository. |
+| `firmware_version` | [`string`](#string) |  | Firmware version string. |
+| `hardware_version` | [`string`](#string) |  | Hardware version string. |
+| `region` | [`string`](#string) |  | Region. |
+
 ### <a name="ttn.lorawan.v3.KeyProvisioning">Enum `KeyProvisioning`</a>
 
 | Name | Number | Description |
@@ -3646,6 +3679,7 @@ Identifiers to uniquely identify a LoRaWAN end device profile.
 | `ListModels` | [`ListEndDeviceModelsRequest`](#ttn.lorawan.v3.ListEndDeviceModelsRequest) | [`ListEndDeviceModelsResponse`](#ttn.lorawan.v3.ListEndDeviceModelsResponse) |  |
 | `GetModel` | [`GetEndDeviceModelRequest`](#ttn.lorawan.v3.GetEndDeviceModelRequest) | [`EndDeviceModel`](#ttn.lorawan.v3.EndDeviceModel) |  |
 | `GetTemplate` | [`GetTemplateRequest`](#ttn.lorawan.v3.GetTemplateRequest) | [`EndDeviceTemplate`](#ttn.lorawan.v3.EndDeviceTemplate) |  |
+| `GetEndDeviceProvisioningInfo` | [`GetEndDeviceProvisioningInfoRequest`](#ttn.lorawan.v3.GetEndDeviceProvisioningInfoRequest) | [`EndDeviceProvisioningInfo`](#ttn.lorawan.v3.EndDeviceProvisioningInfo) |  |
 | `GetUplinkDecoder` | [`GetPayloadFormatterRequest`](#ttn.lorawan.v3.GetPayloadFormatterRequest) | [`MessagePayloadDecoder`](#ttn.lorawan.v3.MessagePayloadDecoder) |  |
 | `GetDownlinkDecoder` | [`GetPayloadFormatterRequest`](#ttn.lorawan.v3.GetPayloadFormatterRequest) | [`MessagePayloadDecoder`](#ttn.lorawan.v3.MessagePayloadDecoder) |  |
 | `GetDownlinkEncoder` | [`GetPayloadFormatterRequest`](#ttn.lorawan.v3.GetPayloadFormatterRequest) | [`MessagePayloadEncoder`](#ttn.lorawan.v3.MessagePayloadEncoder) |  |
@@ -3668,6 +3702,7 @@ Identifiers to uniquely identify a LoRaWAN end device profile.
 | `GetTemplate` | `GET` | `/api/v3/dr/vendors/{end_device_profile_ids.vendor_id}/profiles/{end_device_profile_ids.vendor_profile_id}/template` |  |
 | `GetTemplate` | `GET` | `/api/v3/dr/applications/{application_ids.application_id}/brands/{version_ids.brand_id}/models/{version_ids.model_id}/{version_ids.firmware_version}/{version_ids.band_id}/template` |  |
 | `GetTemplate` | `GET` | `/api/v3/dr/applications/{application_ids.application_id}/vendors/{end_device_profile_ids.vendor_id}/profiles/{end_device_profile_ids.vendor_profile_id}/template` |  |
+| `GetEndDeviceProvisioningInfo` | `GET` | `/api/v3/dr/vendors/{vendor_id}/profiles/{vendor_profile_id}/provisioning-info` |  |
 | `GetUplinkDecoder` | `GET` | `/api/v3/dr/brands/{version_ids.brand_id}/models/{version_ids.model_id}/{version_ids.firmware_version}/{version_ids.band_id}/formatters/uplink/decoder` |  |
 | `GetUplinkDecoder` | `GET` | `/api/v3/dr/applications/{application_ids.application_id}/brands/{version_ids.brand_id}/models/{version_ids.model_id}/{version_ids.firmware_version}/{version_ids.band_id}/formatters/uplink/decoder` |  |
 | `GetDownlinkDecoder` | `GET` | `/api/v3/dr/brands/{version_ids.brand_id}/models/{version_ids.model_id}/{version_ids.firmware_version}/{version_ids.band_id}/formatters/downlink/decoder` |  |

diff --git a/api/ttn/lorawan/v3/api.swagger.json b/api/ttn/lorawan/v3/api.swagger.json
@@ -6161,6 +6161,46 @@
         ]
       }
     },
+    "/dr/vendors/{vendor_id}/profiles/{vendor_profile_id}/provisioning-info": {
+      "get": {
+        "operationId": "DeviceRepository_GetEndDeviceProvisioningInfo",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/v3EndDeviceProvisioningInfo"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/googlerpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "vendor_id",
+            "description": "VendorID managed by the LoRa Alliance, as defined in TR005.",
+            "in": "path",
+            "required": true,
+            "type": "integer",
+            "format": "int64"
+          },
+          {
+            "name": "vendor_profile_id",
+            "description": "ID of the LoRaWAN end device profile assigned by the vendor.",
+            "in": "path",
+            "required": true,
+            "type": "integer",
+            "format": "int64"
+          }
+        ],
+        "tags": [
+          "DeviceRepository"
+        ]
+      }
+    },
     "/edcs/applications/{application_ids.application_id}/authorize": {
       "post": {
         "summary": "Authorize the End Device Claiming Server to claim devices registered in the given application. The application\nidentifiers are the source application, where the devices are registered before they are claimed.\nThe API key is used to access the application, find the device, verify the claim request and delete the end device\nfrom the source application.\nDEPRECATED: Device claiming that transfers devices between applications is no longer supported and will be removed\nin a future version of The Things Stack.",
@@ -23039,6 +23079,17 @@
         }
       }
     },
+    "v3EndDeviceProvisioningInfo": {
+      "type": "object",
+      "properties": {
+        "end_device_model": {
+          "$ref": "#/definitions/v3EndDeviceModel"
+        },
+        "end_device_template": {
+          "$ref": "#/definitions/v3EndDeviceTemplate"
+        }
+      }
+    },
     "v3EndDeviceRegistryCreateBody": {
       "type": "object",
       "properties": {