Skip to content

Commit 24923f2

Browse files
committed
doc: Update review comments
1 parent 7280a30 commit 24923f2

File tree

15 files changed

+57
-62
lines changed

15 files changed

+57
-62
lines changed

doc/content/api/_index.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ menu:
1414

1515
<div class="fixed-table table-api">
1616

17-
| Type | Description |
18-
| --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
19-
| [HTTP (REST)]({{< ref "/api/reference/http" >}}) | {{% tts %}} HTTP (REST) APIs are primarily used for managing entities (ex: Devices, gateways, users, organizations etc). |
20-
| [gRPC]({{< ref "/api/reference/grpc" >}}) | {{% tts %}} backend components communicate with each other primarily using [gRPC](https://grpc.io/). |
21-
| [LoRaWAN® Gateway]({{< ref "/api/concepts/lorawan-gateway" >}}) | APIs for LoRaWAN® Gateways to communicate with {{% tts %}}. |
22-
| [Data Plane]({{< ref "/integrations" >}}) | APIs to read/receive application data and send downlinks to devices. |
17+
| Type | Description |
18+
| --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
19+
| [HTTP (REST)]({{< ref "/api/reference/http" >}}) | {{% tts %}} HTTP (REST) APIs are primarily used for managing entities (ex: Devices, gateways, users, organizations etc). |
20+
| [gRPC]({{< ref "/api/reference/grpc" >}}) | {{% tts %}} backend components communicate with each other primarily using [gRPC](https://grpc.io/). |
21+
| [LoRa® Gateway]({{< ref "/api/concepts/lora-gateway" >}}) | APIs for LoRa® Gateways to communicate with {{% tts %}}. |
22+
| [Data Plane]({{< ref "/integrations" >}}) | APIs to read/receive application data and send downlinks to devices. |
2323

2424
</div>
2525

doc/content/api/concepts/auth/_index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ aliases: ["reference/api/concepts/authentication"]
2323

2424
| Item | Length | Value |
2525
| -------------- | ------ | -------------------------------------------------- |
26-
| `token-type` | 5 | Fixed to `NNSXS` ("key" as base64 encoded string ) |
26+
| `token-type` | 5 | Fixed to `NNSXS` ("key" as base32 encoded string ) |
2727
| `token-id` | 24 | Unique identifier of the key, randomly generated |
2828
| `token-secret` | 32 | The secret value of they key, randomly generated |
2929

@@ -77,7 +77,7 @@ Now make sure to copy this API key as you will not be able to retrieve it again.
7777

7878
{{< tabs/tab "CLI" >}}
7979

80-
To create an API key for the gateway with the **Link as Gateway Server for traffic exchange, i.e. write uplink and read downlink** right:
80+
To create a user API key from the Command Line Interface, run the following command.
8181

8282
```bash
8383
API_KEY_NAME="User API Key"
@@ -120,6 +120,6 @@ If you are using [Postman](https://www.postman.com/) to make API calls, in the *
120120

121121
{{< figure src="postman-api-key.png" alt="Postman API key" >}}
122122

123-
Now that you have learnt about API keys, you can proceed to the [fieldmasks]({{< ref "/api/concepts/fieldmasks" >}}) section.
123+
Now that you have learnt about API keys, you can proceed to the [field masks]({{< ref "/api/concepts/fieldmasks" >}}) section.
124124

125125
Alternatively, look at how to work with OAuth access tokens and Session cookies in the guides below.

doc/content/api/concepts/fieldmasks/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Fieldmasks"
2+
title: "Field masks"
33
description: ""
44
weight: 2
55
aliases: ["reference/api/field-mask"]

doc/content/api/concepts/lorawan-gateway/_index.md doc/content/api/concepts/lora-gateway/_index.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: "LoRaWAN® Gateway specific APIs"
2+
title: "LoRa® Gateway specific APIs"
33
description: ""
44
weight: 5
55
---
66

7-
{{% tts %}} supports multiple LoRaWAN® gateway protocols which communicate the respective APIs.
7+
{{% tts %}} supports multiple LoRa® gateway protocols which communicate the respective APIs.
88

99
<!--more-->
1010

@@ -36,15 +36,13 @@ To communicate with the MQTT protocol, the Gateway Server and the gateway are ex
3636

3737
### MQTT v2
3838

39-
The MQTT v2 gateway APIs follows the [multi packet forwarder](https://github.com/kersing/packet_forwarder) reference.
40-
41-
Check the [protocol reference](https://github.com/kersing/packet_forwarder/blob/master/PROTOCOL.TXT) for more details.
39+
The MQTT v2 gateway APIs are used by [The Things Kickstarter Gateway]({{< ref "/gateways/models/thethingskickstartergateway">}}) and use the [TTN v2 MQTT](https://github.com/TheThingsNetwork/lorawan-stack/blob/master/pkg/gatewayserver/io/mqtt/format_protobufv2.go) format.
4240

4341
### MQTT v3
4442

4543
The MQTT v3 protocol uses the {{% tts %}} v3 messages definitions.
4644

47-
Gateways can connect using the username `{gateway-id}@{tenant-id}` and an API key as the password. Check how to [register a gateway and create an API key]({{< ref "http://localhost:1313/gateways/concepts/adding-gateways/">}}).
45+
Gateways can connect using the username `{gateway-id}@{tenant-id}` and an API key as the password. Check how to [register a gateway and create an API key]({{< ref "/gateways/concepts/adding-gateways/">}}).
4846

4947
<div class="fixed-table table-api">
5048

doc/content/api/concepts/troubleshooting/_index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,17 @@ Unlike other server components, the Identity Server component of {{% tts %}} is
2424

2525
This error indicates that the client HTTP protocol version is old, so the server refuses to perform the request and requires a client update to HTTP 1.1 version or higher.
2626

27-
###### "No_application_rights" or "No_user_rights" error
27+
###### "no_application_rights" or "no_user_rights" error
2828

2929
The API key you are using doesn't have sufficient rights to perform the desired API request. It might also be caused by a missing `Bearer` keyword in the `Authorization` header used in the API call.
3030

3131
To resolve this issue, make sure your API key has necessary rights to interact with the desired entity. Also, make sure to use the `Bearer` keyword when specifying the `Authorization` header.
3232

33-
###### "Api_key_not_found" error
33+
###### "api_key_not_found" error
3434

3535
This error indicates that the specified API key used for the API call is not valid or doesn't exist at all. Double-check that the API key you provided is correct and still valid. If it is expired, you can generate a new API key and update your API call request with the new one.
3636

37-
###### "Unauthenticated" error
37+
###### "unauthenticated" error
3838

3939
This error occurs when the API request is made without proper authentication credentials. Make sure to include the correct API key in the authentication request header.
4040

doc/content/devices/adding-devices/manual/abp/_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ If your device cannot be activated using the more secure OTAA, you may manually
88

99
<!--more-->
1010

11-
{{< tabs/container "Console" "CLI" "HTTP(REST) API">}}
11+
{{< tabs/container "Console" "CLI" "HTTP (REST) API">}}
1212

1313
{{< tabs/tab "Console" >}}
1414

@@ -106,7 +106,7 @@ You can also pass `--with-session` to have a session generated.
106106

107107
{{< /tabs/tab >}}
108108

109-
{{< tabs/tab "HTTP(REST) API" >}}
109+
{{< tabs/tab "HTTP (REST) API" >}}
110110

111111
{{% tts %}} stores end device data on the Identity Server, Application Server, Network Server. Since ABP devices do not have the concept of join, the Join Server is not used.
112112

doc/content/gateways/concepts/adding-gateways/_index.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Do not follow this guide for a [The Things Indoor Gateway]({{< ref "/gateways/mo
2222

2323
If your {{% tts %}} deployment is connected to [Packet Broker]({{< ref "the-things-stack/packet-broker" >}}), you can take advantage of coverage from The Things Network without adding any gateways of your own. See the community sourced [TTN Mapper](ttnmapper.org) to find out if your location has nearby gateways.
2424

25-
{{< tabs/container "Console" "CLI" "HTTP(REST) API">}}
25+
{{< tabs/container "Console" "CLI" "HTTP (REST) API">}}
2626

2727
{{< tabs/tab "Console" >}}
2828

@@ -89,7 +89,7 @@ This creates a gateway `gtw1` with user `admin` as collaborator, frequency plan
8989

9090
{{< /tabs/tab >}}
9191

92-
{{< tabs/tab "HTTP(REST) API" >}}
92+
{{< tabs/tab "HTTP (REST) API" >}}
9393

9494
#### Adding Gateways using the API
9595

@@ -99,7 +99,7 @@ This creates a gateway `gtw1` with user `admin` as collaborator, frequency plan
9999

100100
| Item | Value |
101101
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
102-
| EndPoint | [`/api/v3/users/{collaborator.user_ids.user_id}/gateways`]({{< ref "/api/reference/http/routes/#users{collaborator.user_ids.user_id}gateways-post" >}}) |
102+
| Endpoint | [`/api/v3/users/{collaborator.user_ids.user_id}/gateways`]({{< ref "/api/reference/http/routes/#users{collaborator.user_ids.user_id}gateways-post" >}}) |
103103
| Request type | `POST` |
104104

105105
</br>
@@ -143,7 +143,7 @@ curl -v -H "Content-Type: application/json" -H "Authorization: Bearer $API_KEY"
143143

144144
Some gateways require an API Key with Link Gateway Rights to be able to connect to {{% tts %}}. In this section we explain how to create an API key with this right, but the procedure of creating an API key is identical for any other right as well.
145145

146-
{{< tabs/container "Console" "CLI" "HTTP(REST) API" >}}
146+
{{< tabs/container "Console" "CLI" "HTTP (REST) API" >}}
147147

148148
{{< tabs/tab "Console" >}}
149149

@@ -177,15 +177,15 @@ See the [CLI Reference]({{< ref "/ttn-lw-cli/ttn-lw-cli_gateways_api-keys" >}})
177177

178178
{{< /tabs/tab >}}
179179

180-
{{< tabs/tab "HTTP(REST) API" >}}
180+
{{< tabs/tab "HTTP (REST) API" >}}
181181

182182
###### Details
183183

184184
<div class="fixed-table table-api-item">
185185

186186
| Item | Value |
187187
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
188-
| EndPoint | [`/api/v3/gateways/{gateway_ids.gateway_id}/api-keys`]({{< ref "/api/reference/http/routes/#gateways{gateway_ids.gateway_id}api-keys-post" >}}) |
188+
| Endpoint | [`/api/v3/gateways/{gateway_ids.gateway_id}/api-keys`]({{< ref "/api/reference/http/routes/#gateways{gateway_ids.gateway_id}api-keys-post" >}}) |
189189
| Request type | `POST` |
190190

191191
</br>
@@ -218,7 +218,7 @@ curl -H "Content-Type: application/json" -H "Authorization: Bearer $API_KEY" \
218218

219219
## Set Gateway Location
220220

221-
{{< tabs/container "Console" "CLI" "HTTP(REST) API" >}}
221+
{{< tabs/container "Console" "CLI" "HTTP (REST) API" >}}
222222

223223
{{< tabs/tab "Console" >}}
224224

@@ -285,15 +285,15 @@ The CLI will return something like:
285285

286286
{{< /tabs/tab >}}
287287

288-
{{< tabs/tab "HTTP(REST) API" >}}
288+
{{< tabs/tab "HTTP (REST) API" >}}
289289

290290
###### Details
291291

292292
<div class="fixed-table table-api-item">
293293

294294
| Item | Value |
295295
| ------------ | ----------------------------------------------------------------------------------------------------------------------------- |
296-
| EndPoint | [`/api/v3/gateways/{gateway.ids.gateway_id}`]({{< ref "/api/reference/http/routes/#gateways{gateway.ids.gateway_id}-put" >}}) |
296+
| Endpoint | [`/api/v3/gateways/{gateway.ids.gateway_id}`]({{< ref "/api/reference/http/routes/#gateways{gateway.ids.gateway_id}-put" >}}) |
297297
| Request type | `PUT` |
298298

299299
</br>
@@ -344,7 +344,7 @@ Keep in mind that if you change the physical location of your gateway, the locat
344344

345345
A preffered way for adjusting a downlink path gain is setting the gateway antenna gain, instead of changing the gateway Tx power.
346346

347-
{{< tabs/container "CLI" "HTTP(REST) API" >}}
347+
{{< tabs/container "CLI" "HTTP (REST) API" >}}
348348

349349
{{< tabs/tab "CLI" >}}
350350

@@ -382,15 +382,15 @@ The CLI output will be similar to:
382382

383383
{{< /tabs/container >}}
384384

385-
{{< tabs/tab "HTTP(REST) API" >}}
385+
{{< tabs/tab "HTTP (REST) API" >}}
386386

387387
###### Details
388388

389389
<div class="fixed-table table-api-item">
390390

391391
| Item | Value |
392392
| ------------ | ----------------------------------------------------------------------------------------------------------------------------- |
393-
| EndPoint | [`/api/v3/gateways/{gateway.ids.gateway_id}`]({{< ref "/api/reference/http/routes/#gateways{gateway.ids.gateway_id}-put" >}}) |
393+
| Endpoint | [`/api/v3/gateways/{gateway.ids.gateway_id}`]({{< ref "/api/reference/http/routes/#gateways{gateway.ids.gateway_id}-put" >}}) |
394394
| Request type | `PUT` |
395395

396396
</br>
@@ -412,7 +412,7 @@ To adjust the antenna gain of a gateway with ID `my-test-gateway` on `thethings.
412412
"field_mask": {
413413
"paths": ["antennas"]
414414
}
415-
415+
}
416416
```
417417

418418
The request using `cURL` is as follows.
@@ -436,7 +436,7 @@ Once a gateway has been added, get started with [Adding Devices]({{< ref "/devic
436436

437437
In deployments connected to [Packet Broker]({{< ref "/the-things-stack/packet-broker" >}}), you can control if you want uplinks received by your gateway to be forwarded to Packet Broker or not. In these deployments, uplinks received by your gateway are being forwarded to Packet Broker by default, but you can choose to disable this behavior.
438438

439-
{{< tabs/container "Console" "CLI" "HTTP(REST) API" >}}
439+
{{< tabs/container "Console" "CLI" "HTTP (REST) API" >}}
440440

441441
{{< tabs/tab "Console" >}}
442442

@@ -455,15 +455,15 @@ ttn-lw-cli gateways set $GTW_ID --disable-packet-broker-forwarding
455455

456456
{{< /tabs/tab >}}
457457

458-
{{< tabs/tab "HTTP(REST) API" >}}
458+
{{< tabs/tab "HTTP (REST) API" >}}
459459

460460
###### Details
461461

462462
<div class="fixed-table table-api-item">
463463

464464
| Item | Value |
465465
| ------------ | ----------------------------------------------------------------------------------------------------------------------------- |
466-
| EndPoint | [`/api/v3/gateways/{gateway.ids.gateway_id}`]({{< ref "/api/reference/http/routes/#gateways{gateway.ids.gateway_id}-put" >}}) |
466+
| Endpoint | [`/api/v3/gateways/{gateway.ids.gateway_id}`]({{< ref "/api/reference/http/routes/#gateways{gateway.ids.gateway_id}-put" >}}) |
467467
| Request type | `PUT` |
468468

469469
</br>

doc/content/gateways/concepts/udp/_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ If `debug_conf.json` exists, the other files are ignored - otherwise, the parame
1919

2020
An example `global_conf.json` is available in the [{{% udp-pf %}} Github repository](https://github.com/Lora-net/packet_forwarder/blob/master/lora_pkt_fwd/global_conf.json). It is also possible to download a `global_conf.json` configured with your Gateway EUI and Frequency Plan directly from {{% tts %}}.
2121

22-
{{< tabs/container "Console" "HTTP(REST) API" >}}
22+
{{< tabs/container "Console" "HTTP (REST) API" >}}
2323

2424
{{< tabs/tab "Console" >}}
2525

@@ -31,7 +31,7 @@ To download a `global_conf.json` file for your gateway, open the Gateway overvie
3131

3232
{{< /tabs/tab >}}
3333

34-
{{< tabs/tab "HTTP(REST) API" >}}
34+
{{< tabs/tab "HTTP (REST) API" >}}
3535

3636
## Download Configuration via Terminal
3737

doc/content/integrations/adding-applications/_index.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This section contains instructions for creating an Application.
1717

1818
<!--more-->
1919

20-
{{< tabs/container "Console" "CLI" "HTTP(REST) API" >}}
20+
{{< tabs/container "Console" "CLI" "HTTP (REST) API" >}}
2121

2222
{{< tabs/tab "Console" >}}
2323

@@ -57,17 +57,17 @@ This creates an application `app1` with the `admin` user as collaborator. Make s
5757

5858
{{< /tabs/tab >}}
5959

60-
{{< tabs/tab "HTTP(REST) API" >}}
60+
{{< tabs/tab "HTTP (REST) API" >}}
6161

62-
#### Adding Applications using the HTTP(REST) API
62+
#### Adding Applications using the HTTP (REST) API
6363

6464
###### Details
6565

6666
<div class="fixed-table table-api-item">
6767

6868
| Item | Value |
6969
| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
70-
| EndPoint | [`/users/{collaborator.user_ids.user_id}/applications`]({{< ref "/api/reference/http/routes/#users{collaborator.user_ids.user_id}applications-post" >}}) |
70+
| Endpoint | [`/users/{collaborator.user_ids.user_id}/applications`]({{< ref "/api/reference/http/routes/#users{collaborator.user_ids.user_id}applications-post" >}}) |
7171
| Request type | `POST` |
7272

7373
</br>
@@ -113,7 +113,7 @@ End devices are also created within applications. See [Adding Devices]({{< ref "
113113

114114
Some applications require an API Key to write downlink traffic, read uplink traffic, manage integrations, etc. In this section we explain how to create an application API key on some basic examples, but this procedure is identical for any other right as well.
115115

116-
{{< tabs/container "Console" "CLI" "HTTP(REST) API">}}
116+
{{< tabs/container "Console" "CLI" "HTTP (REST) API">}}
117117

118118
{{< tabs/tab "Console" >}}
119119

@@ -147,15 +147,15 @@ See the [CLI Reference]({{< ref "/ttn-lw-cli/ttn-lw-cli_applications_api-keys" >
147147

148148
{{< /tabs/tab >}}
149149

150-
{{< tabs/tab "HTTP(REST) API" >}}
150+
{{< tabs/tab "HTTP (REST) API" >}}
151151

152152
###### Details
153153

154154
<div class="fixed-table table-api-item">
155155

156156
| Item | Value |
157157
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
158-
| EndPoint | [`/api/v3/gateways/{gateway_ids.gateway_id}/api-keys`]({{< ref "/api/reference/http/routes/#gateways{gateway_ids.gateway_id}api-keys-post" >}}) |
158+
| Endpoint | [`/api/v3/gateways/{gateway_ids.gateway_id}/api-keys`]({{< ref "/api/reference/http/routes/#gateways{gateway_ids.gateway_id}api-keys-post" >}}) |
159159
| Request type | `POST` |
160160

161161
</br>

0 commit comments

Comments
 (0)