From 751ec7996c8e1b12b4a7b1b2db9fbf6f08f630ab Mon Sep 17 00:00:00 2001 From: Vlad Vitan Date: Thu, 29 Aug 2024 12:39:01 +0200 Subject: [PATCH] api: Update description for the paused field --- api/ttn/lorawan/v3/api.md | 2 +- api/ttn/lorawan/v3/api.swagger.json | 4 ++-- api/ttn/lorawan/v3/applicationserver_web.proto | 2 +- pkg/ttnpb/applicationserver_web.pb.go | 2 +- sdk/js/generated/api.json | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/api/ttn/lorawan/v3/api.md b/api/ttn/lorawan/v3/api.md index 3d2f8cd9c15..2a03fe97ddf 100644 --- 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 index 57193ca564b..30f12fcd170 100644 --- 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 index 26dfc721d10..f2e5c8a94d6 100644 --- 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 index 9ab4a88fab2..9778efd7ab7 100644 --- a/pkg/ttnpb/applicationserver_web.pb.go +++ b/pkg/ttnpb/applicationserver_web.pb.go @@ -622,7 +622,7 @@ type ApplicationWebhook struct { ServiceData *ApplicationWebhook_Message `protobuf:"bytes,18,opt,name=service_data,json=serviceData,proto3" json:"service_data,omitempty"` HealthStatus *ApplicationWebhookHealth `protobuf:"bytes,20,opt,name=health_status,json=healthStatus,proto3" json:"health_status,omitempty"` FieldMask *fieldmaskpb.FieldMask `protobuf:"bytes,21,opt,name=field_mask,json=fieldMask,proto3" json:"field_mask,omitempty"` - // 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. Paused bool `protobuf:"varint,24,opt,name=paused,proto3" json:"paused,omitempty"` } diff --git a/sdk/js/generated/api.json b/sdk/js/generated/api.json index 8b0e7ae7602..da4eff5dc9b 100644 --- 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",