api: Update description for the paused field

TheThingsNetwork · Aug 29, 2024 · 751ec79 · 751ec79
1 parent db5deff
commit 751ec79
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 6 deletions.
diff --git a/api/ttn/lorawan/v3/api.md b/api/ttn/lorawan/v3/api.md
@@ -2073,7 +2073,7 @@ The NATS provider settings.
 | `service_data` | [`ApplicationWebhook.Message`](#ttn.lorawan.v3.ApplicationWebhook.Message) |  |  |
 | `health_status` | [`ApplicationWebhookHealth`](#ttn.lorawan.v3.ApplicationWebhookHealth) |  |  |
 | `field_mask` | [`google.protobuf.FieldMask`](#google.protobuf.FieldMask) |  |  |
-| `paused` | [`bool`](#bool) |  | Set to true to skip processing the messages for this webhook. |
+| `paused` | [`bool`](#bool) |  | Set to temporarily pause forwarding uplink data to this end point and receiving downlinks from this end point. |
 
 #### Field Rules
 

diff --git a/api/ttn/lorawan/v3/api.swagger.json b/api/ttn/lorawan/v3/api.swagger.json
@@ -20840,7 +20840,7 @@
         },
         "paused": {
           "type": "boolean",
-          "description": "Set to true to skip processing the messages for this webhook."
+          "description": "Set to temporarily pause forwarding uplink data to this end point and receiving downlinks from this end point."
         }
       }
     },
@@ -20983,7 +20983,7 @@
             },
             "paused": {
               "type": "boolean",
-              "description": "Set to true to skip processing the messages for this webhook."
+              "description": "Set to temporarily pause forwarding uplink data to this end point and receiving downlinks from this end point."
             }
           }
         },

diff --git a/api/ttn/lorawan/v3/applicationserver_web.proto b/api/ttn/lorawan/v3/applicationserver_web.proto
@@ -227,7 +227,7 @@ message ApplicationWebhook {
   reserved 23;
   reserved "queue";
 
-  // Set to true to skip processing the messages for this webhook.
+  // Set to temporarily pause forwarding uplink data to this end point and receiving downlinks from this end point.
   bool paused = 24;
 
   // next: 25

diff --git a/pkg/ttnpb/applicationserver_web.pb.go b/pkg/ttnpb/applicationserver_web.pb.go
diff --git a/sdk/js/generated/api.json b/sdk/js/generated/api.json
@@ -6357,7 +6357,7 @@
             },
             {
               "name": "paused",
-              "description": "Set to true to skip processing the messages for this webhook.",
+              "description": "Set to temporarily pause forwarding uplink data to this end point and receiving downlinks from this end point.",
               "label": "",
               "type": "bool",
               "longType": "bool",