Release 3.32.1 documentation (#1384)

* docs: Release 3.32.1 * doc: Update featured section and fix AWS ECS changelog --------- Co-authored-by: Krishna Iyer <krishna@thethingsindustries.com>
TheThingsIndustries · Oct 15, 2024 · a5beaed · a5beaed
1 parent 98253bb
commit a5beaed
Show file tree

Hide file tree

Showing 15 changed files with 14,130 additions and 717 deletions.
diff --git a/doc/config/_default/config.toml b/doc/config/_default/config.toml
@@ -23,7 +23,7 @@ pygmentsUseClasses = true
   github_repository = "https://github.com/TheThingsIndustries/lorawan-stack-docs"
   github_repository_edit = "https://github.com/TheThingsIndustries/lorawan-stack-docs/blob/master/doc/content"
   tts_github_repository = "https://github.com/TheThingsNetwork/lorawan-stack"
-  version = "3.32.0"
+  version = "3.32.1"
 
 [markup]
   [markup.goldmark]

diff --git a/doc/content/the-things-stack/host/aws/ecs/changelog/index.md b/doc/content/the-things-stack/host/aws/ecs/changelog/index.md
@@ -5,9 +5,9 @@ aliases: [/getting-started/aws/ecs/changelog]
 
 # Upgrading
 
-All meaningful changes to templates are documented in this file.
+## 3.32.1
 
-## Unreleased
+- Updated ECS AMIs to the latest versions.
 
 ## 3.32.0
 

diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_applications_webhooks_get.md b/doc/content/ttn-lw-cli/ttn-lw-cli_applications_webhooks_get.md
@@ -44,6 +44,7 @@ ttn-lw-cli applications webhooks get [application-id] [webhook-id] [flags]
       --join-accept.path                                             select the join_accept.path field
       --location-solved                                              select the location_solved field and all allowed sub-fields
       --location-solved.path                                         select the location_solved.path field
+      --paused                                                       select the paused field
       --queue                                                        select the queue field and all allowed sub-fields
       --queue.enabled                                                select the queue.enabled field
       --service-data                                                 select the service_data field and all allowed sub-fields

diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_applications_webhooks_list.md b/doc/content/ttn-lw-cli/ttn-lw-cli_applications_webhooks_list.md
@@ -44,6 +44,7 @@ ttn-lw-cli applications webhooks list [application-id] [flags]
       --join-accept.path                                             select the join_accept.path field
       --location-solved                                              select the location_solved field and all allowed sub-fields
       --location-solved.path                                         select the location_solved.path field
+      --paused                                                       select the paused field
       --queue                                                        select the queue field and all allowed sub-fields
       --queue.enabled                                                select the queue.enabled field
       --service-data                                                 select the service_data field and all allowed sub-fields

diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_applications_webhooks_set.md b/doc/content/ttn-lw-cli/ttn-lw-cli_applications_webhooks_set.md
@@ -29,6 +29,7 @@ ttn-lw-cli applications webhooks set [application-id] [webhook-id] [flags]
   -h, --help                                     help for set
       --join-accept.path string                  
       --location-solved.path string              
+      --paused                                   
       --queue.enabled                            
       --service-data.path string                 
       --template-fields stringToString           

diff --git a/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_list-frequency-plans.md b/doc/content/ttn-lw-cli/ttn-lw-cli_gateways_list-frequency-plans.md
@@ -14,7 +14,9 @@ ttn-lw-cli gateways list-frequency-plans [flags]
 ### Options
 
 ```
+      --band-id string          Band ID to filter by
       --base-frequency uint32   Base frequency in MHz for hardware support (433, 470, 868 or 915)
+      --gateways-only           List only frequency plans that support gateways
   -h, --help                    help for list-frequency-plans
 ```
 

diff --git a/doc/content/whats-new/3.32.1.md b/doc/content/whats-new/3.32.1.md
@@ -0,0 +1,26 @@
+---
+date: 2024-10-14T09:33:47Z
+title: "3.32.1"
+featured:
+  {
+    added: [Endpoint for claiming gateways using a qr code],
+    fixed:
+      [
+        RX2 and Class C with The Things Industries gateway protocol in dynamic channel plan regions (including `EU868`).,
+      ],
+  }
+---
+
+### Added
+
+- Option to filter out non-gateway related frequency plans.
+  - `ListFrequencyPlans` RPC has a new `gateways-only` flag.
+- Option to pause application webhooks.
+- Endpoint for claiming gateways using a qr code
+- Update the GetTemplate endpoint in device repository to check for profile identifiers in the vendor index.
+- Support for claiming a gateway via QR code in the Console.
+
+### Fixed
+
+- RX2 and Class C with The Things Industries gateway protocol in dynamic channel plan regions (including `EU868`).
+- Filtering the list end points for end devices and gateways using the HTTP API.
diff --git a/doc/data/api/ttn.lorawan.v3/messages/ApplicationWebhook.yml b/doc/data/api/ttn.lorawan.v3/messages/ApplicationWebhook.yml
@@ -121,3 +121,8 @@ fields:
   message:
     name: ApplicationWebhookQueue
   default: {}
+- name: paused
+  comment: Set to temporarily pause forwarding uplink data to this end point and receiving
+    downlinks from this end point.
+  type: bool
+  default: false
diff --git a/doc/data/api/ttn.lorawan.v3/messages/ListFrequencyPlansRequest.yml b/doc/data/api/ttn.lorawan.v3/messages/ListFrequencyPlansRequest.yml
@@ -8,3 +8,7 @@ fields:
   comment: Optional Band ID to filter the results.
   type: string
   default: ""
+- name: gateways_only
+  comment: Optional field to include only gateway related results.
+  type: bool
+  default: false
diff --git a/doc/data/api/ttn.lorawan.v3/messages/ParseGatewayQRCodeRequest.yml b/doc/data/api/ttn.lorawan.v3/messages/ParseGatewayQRCodeRequest.yml
@@ -0,0 +1,18 @@
+name: ParseGatewayQRCodeRequest
+fields:
+- name: format_id
+  comment: |-
+    QR code format identifier.
+    If this field is not specified, the server will default to ttigpro1.
+  type: string
+  rules:
+    max_len: 36
+    pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$|^$
+  default: ""
+- name: qr_code
+  comment: Raw QR code contents.
+  type: bytes
+  rules:
+    min_len: 10
+    max_len: 1024
+  default: ""
diff --git a/doc/data/api/ttn.lorawan.v3/messages/ParseGatewayQRCodeResponse.yml b/doc/data/api/ttn.lorawan.v3/messages/ParseGatewayQRCodeResponse.yml
@@ -0,0 +1,15 @@
+name: ParseGatewayQRCodeResponse
+fields:
+- name: format_id
+  comment: Identifier of the format used to parse the QR code data.
+  type: string
+  default: ""
+- name: gateway_eui
+  type: bytes
+  rules:
+    len: 8
+    ignore_empty: true
+  default: ""
+- name: owner_token
+  type: string
+  default: ""
diff --git a/doc/data/api/ttn.lorawan.v3/services/EndDeviceRegistry.yml b/doc/data/api/ttn.lorawan.v3/services/EndDeviceRegistry.yml
@@ -60,6 +60,8 @@ methods:
     http:
     - method: GET
       path: /applications/{application_ids.application_id}/devices
+    - method: POST
+      path: /applications/{application_ids.application_id}/devices/filter
   Update:
     name: Update
     comment: Update the end device, changing the fields specified by the field mask

diff --git a/doc/data/api/ttn.lorawan.v3/services/GatewayQRCodeGenerator.yml b/doc/data/api/ttn.lorawan.v3/services/GatewayQRCodeGenerator.yml
@@ -0,0 +1,17 @@
+name: GatewayQRCodeGenerator
+comment: The GatewayQRCodeGenerator service provides functionality to generate and
+  parse QR codes for gateways.
+methods:
+  Parse:
+    name: Parse
+    comment: Parse QR Codes of known formats and return the information contained
+      within.
+    input:
+      name: ParseGatewayQRCodeRequest
+    output:
+      name: ParseGatewayQRCodeResponse
+    http:
+    - method: POST
+      path: /qr-codes/gateways/parse
+    - method: POST
+      path: /qr-codes/gateways/{format_id}/parse
diff --git a/doc/data/api/ttn.lorawan.v3/services/GatewayRegistry.yml b/doc/data/api/ttn.lorawan.v3/services/GatewayRegistry.yml
@@ -56,6 +56,8 @@ methods:
       path: /users/{collaborator.user_ids.user_id}/gateways
     - method: GET
       path: /organizations/{collaborator.organization_ids.organization_id}/gateways
+    - method: POST
+      path: /gateways/filter
   Update:
     name: Update
     comment: Update the gateway, changing the fields specified by the field mask to