Skip to content

Commit

Permalink
doc: Add v3.28.0 release docs (#1206)
Browse files Browse the repository at this point in the history 
* doc: Add v3.28.0 release docs

* doc: Add new services to IS API docs
  • Loading branch information
@nejraselimovic
nejraselimovic authored Nov 3, 2023
1 parent 693fd32 commit f1aebcb
Show file tree
Hide file tree
Showing 38 changed files with 383 additions and 31 deletions.
2 changes: 1 addition & 1 deletion doc/config/_default/config.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,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.27.2"
version = "3.28.0"

[markup]
[markup.goldmark]
Expand Down
12 changes: 12 additions & 0 deletions doc/content/reference/api/identity_server.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,18 @@ description: ""

{{< proto/method service="OAuthAuthorizationRegistry" method="DeleteToken" >}}

## The `GatewayBatchAccess` service

{{< proto/method service="GatewayBatchAccess" method="AssertRights" >}}

## The `GatewayBatchRegistry` service

{{< proto/method service="GatewayBatchRegistry" method="Delete" >}}

## Messages

{{< proto/message message="AssertGatewayRightsRequest" >}}

{{< proto/message package="tti.lorawan.v3" message="AuthenticationProvider" >}}

{{< proto/message package="tti.lorawan.v3" message="AuthenticationProvider.Configuration" >}}
Expand All @@ -53,6 +63,8 @@ description: ""

{{< proto/message package="tti.lorawan.v3" message="AuthenticationProviders" >}}

{{< proto/message message="BatchDeleteGatewaysRequest" >}}

{{< proto/message package="tti.lorawan.v3" message="CreateAuthenticationProviderRequest" >}}

{{< proto/message message="ContactInfo" >}}
Expand Down
12 changes: 12 additions & 0 deletions doc/content/the-things-stack/host/aws/ecs/changelog/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,18 @@ All meaningful changes to templates are documented in this file.

## Unreleased

## 3.28.0

### `2-3-db-redis`

- The `r7g` family of machines is now available for hosting.

### `4-2a-configuration`

- Add `EventsBatchingEnabled`, `EventsBatchingTargetSize`, `EventsBatchingDelay` parameters.
- Add correlation IDs ignored methods to the gRPC server configuration.
- Add Identity Server NS-ID configuration.

## 3.27.2

### `5-4-ecs-services`
Expand Down
2 changes: 2 additions & 0 deletions doc/content/ttn-lw-cli/ttn-lw-cli_applications_storage_get.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@ ttn-lw-cli applications storage get [application-id] [flags]
--up.uplink-message.network-ids.cluster-address select the up.uplink_message.network_ids.cluster_address field
--up.uplink-message.network-ids.cluster-id select the up.uplink_message.network_ids.cluster_id field
--up.uplink-message.network-ids.net-id select the up.uplink_message.network_ids.net_id field
--up.uplink-message.network-ids.ns-id select the up.uplink_message.network_ids.ns_id field
--up.uplink-message.network-ids.tenant-address select the up.uplink_message.network_ids.tenant_address field
--up.uplink-message.network-ids.tenant-id select the up.uplink_message.network_ids.tenant_id field
--up.uplink-message.normalized-payload select the up.uplink_message.normalized_payload field
Expand Down Expand Up @@ -207,6 +208,7 @@ ttn-lw-cli applications storage get [application-id] [flags]
--up.uplink-normalized.network-ids.cluster-address select the up.uplink_normalized.network_ids.cluster_address field
--up.uplink-normalized.network-ids.cluster-id select the up.uplink_normalized.network_ids.cluster_id field
--up.uplink-normalized.network-ids.net-id select the up.uplink_normalized.network_ids.net_id field
--up.uplink-normalized.network-ids.ns-id select the up.uplink_normalized.network_ids.ns_id field
--up.uplink-normalized.network-ids.tenant-address select the up.uplink_normalized.network_ids.tenant_address field
--up.uplink-normalized.network-ids.tenant-id select the up.uplink_normalized.network_ids.tenant_id field
--up.uplink-normalized.normalized-payload select the up.uplink_normalized.normalized_payload field
Expand Down
1 change: 1 addition & 0 deletions doc/content/ttn-lw-cli/ttn-lw-cli_authentication-providers_create.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ ttn-lw-cli authentication-providers create [provider-id] [flags]

```
--allow-registrations
--allowed-email-domains strings
--configuration.provider.oidc.client-id string
--configuration.provider.oidc.client-secret string
--configuration.provider.oidc.provider-url string
Expand Down
1 change: 1 addition & 0 deletions doc/content/ttn-lw-cli/ttn-lw-cli_authentication-providers_get.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ ttn-lw-cli authentication-providers get [provider-id] [flags]

```
--allow-registrations select the allow_registrations field
--allowed-email-domains select the allowed_email_domains field
--configuration select the configuration field and all allowed sub-fields
--configuration.provider.oidc select the configuration.provider.oidc field and all allowed sub-fields
--configuration.provider.oidc.client-id select the configuration.provider.oidc.client_id field
Expand Down
1 change: 1 addition & 0 deletions doc/content/ttn-lw-cli/ttn-lw-cli_authentication-providers_list.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ ttn-lw-cli authentication-providers list [flags]

```
--allow-registrations select the allow_registrations field
--allowed-email-domains select the allowed_email_domains field
--configuration select the configuration field and all allowed sub-fields
--configuration.provider.oidc select the configuration.provider.oidc field and all allowed sub-fields
--configuration.provider.oidc.client-id select the configuration.provider.oidc.client_id field
Expand Down
1 change: 1 addition & 0 deletions doc/content/ttn-lw-cli/ttn-lw-cli_authentication-providers_update.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ ttn-lw-cli authentication-providers update [provider-id] [flags]

```
--allow-registrations
--allowed-email-domains strings
--configuration.provider.oidc.client-id string
--configuration.provider.oidc.client-secret string
--configuration.provider.oidc.provider-url string
Expand Down
2 changes: 2 additions & 0 deletions doc/content/ttn-lw-cli/ttn-lw-cli_end-devices_storage_get.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,7 @@ ttn-lw-cli end-devices storage get [application-id] [device-id] [flags]
--up.uplink-message.network-ids.cluster-address select the up.uplink_message.network_ids.cluster_address field
--up.uplink-message.network-ids.cluster-id select the up.uplink_message.network_ids.cluster_id field
--up.uplink-message.network-ids.net-id select the up.uplink_message.network_ids.net_id field
--up.uplink-message.network-ids.ns-id select the up.uplink_message.network_ids.ns_id field
--up.uplink-message.network-ids.tenant-address select the up.uplink_message.network_ids.tenant_address field
--up.uplink-message.network-ids.tenant-id select the up.uplink_message.network_ids.tenant_id field
--up.uplink-message.normalized-payload select the up.uplink_message.normalized_payload field
Expand Down Expand Up @@ -210,6 +211,7 @@ ttn-lw-cli end-devices storage get [application-id] [device-id] [flags]
--up.uplink-normalized.network-ids.cluster-address select the up.uplink_normalized.network_ids.cluster_address field
--up.uplink-normalized.network-ids.cluster-id select the up.uplink_normalized.network_ids.cluster_id field
--up.uplink-normalized.network-ids.net-id select the up.uplink_normalized.network_ids.net_id field
--up.uplink-normalized.network-ids.ns-id select the up.uplink_normalized.network_ids.ns_id field
--up.uplink-normalized.network-ids.tenant-address select the up.uplink_normalized.network_ids.tenant_address field
--up.uplink-normalized.network-ids.tenant-id select the up.uplink_normalized.network_ids.tenant_id field
--up.uplink-normalized.normalized-payload select the up.uplink_normalized.normalized_payload field
Expand Down
1 change: 1 addition & 0 deletions doc/content/ttn-lw-cli/ttn-lw-cli_gateways.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ Gateway commands

* [ttn-lw-cli]({{< relref "ttn-lw-cli" >}}) - The Things Industries Command-line Interface
* [ttn-lw-cli gateways api-keys]({{< relref "ttn-lw-cli_gateways_api-keys" >}}) - Manage gateway API keys
* [ttn-lw-cli gateways batch-delete]({{< relref "ttn-lw-cli_gateways_batch-delete" >}}) - Delete a batch of gateways (EXPERIMENTAL).
* [ttn-lw-cli gateways claim]({{< relref "ttn-lw-cli_gateways_claim" >}}) - Claim a gateway (EXPERIMENTAL)
* [ttn-lw-cli gateways collaborators]({{< relref "ttn-lw-cli_gateways_collaborators" >}}) - Manage gateway collaborators
* [ttn-lw-cli gateways contact-info]({{< relref "ttn-lw-cli_gateways_contact-info" >}}) - Manage gateway contact info (DEPRECATED. Instead, use administrative_contact and technical_contact fields of gateway)
Expand Down
60 changes: 60 additions & 0 deletions doc/content/ttn-lw-cli/ttn-lw-cli_gateways_batch-delete.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
title: "ttn-lw-cli gateways batch-delete"
slug: ttn-lw-cli_gateways_batch-delete
---

## ttn-lw-cli gateways batch-delete

Delete a batch of gateways (EXPERIMENTAL).

```
ttn-lw-cli gateways batch-delete [gateway-ids] [flags]
```

### Options

```
-h, --help help for batch-delete
```

### Options inherited from parent commands

```
--allow-unknown-hosts Allow sending credentials to unknown hosts
--application-server-enabled Application Server enabled (default true)
--application-server-grpc-address string Application Server address (default "localhost:8884")
--ca string CA certificate file
-c, --config strings Location of the config files (default [.ttn-lw-cli.yml,$HOME/.ttn-lw-cli.yml,$HOME/.config/.ttn-lw-cli.yml])
--credentials-id string Credentials ID (if using multiple configurations)
--device-claiming-server-grpc-address string Device Claiming Server address (default "localhost:8884")
--device-template-converter-grpc-address string Device Template Converter address (default "localhost:8884")
--dump-requests When log level is set to debug, also dump request payload as JSON
--experimental.features strings Experimental features to activate
--gateway-server-enabled Gateway Server enabled (default true)
--gateway-server-grpc-address string Gateway Server address (default "localhost:8884")
--identity-server-grpc-address string Identity Server address (default "localhost:8884")
--input-format string Input format (default "json")
--insecure Connect without TLS
--join-server-enabled Join Server enabled (default true)
--join-server-grpc-address string Join Server address (default "localhost:8884")
--log.format string Log format to write (console, json) (default "console")
--log.level string The minimum level log messages must have to be shown (default "info")
--network-server-enabled Network Server enabled (default true)
--network-server-grpc-address string Network Server address (default "localhost:8884")
--oauth-server-address string OAuth Server address (default "https://localhost/oauth")
--output-format string Output format (default "json")
--packet-broker-agent-grpc-address string Packet Broker Agent address (default "localhost:8884")
--qr-code-generator-grpc-address string QR Code Generator address (default "localhost:8884")
--retry.default-timeout duration Default timeout between retry attempts (default 100ms)
--retry.enable-metadata Use request response metadata to dynamically calculate timeout between retry attempts (default true)
--retry.jitter float Fraction that creates a deviation of the timeout used between retry attempts
--retry.max uint Maximum amount of times that a request can be reattempted
--skip-version-check Do not perform version checks
--telemetry.enable Enables telemetry for CLI (default true)
--telemetry.target string Target to which the information will be sent to (default "https://telemetry.thethingsstack.io/collect")
```

### SEE ALSO

* [ttn-lw-cli gateways]({{< relref "ttn-lw-cli_gateways" >}}) - Gateway commands

67 changes: 44 additions & 23 deletions doc/content/ttn-lw-cli/ttn-lw-cli_simulate_application-uplink.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,29 +14,50 @@ ttn-lw-cli simulate application-uplink [application-id] [device-id] [flags]
### Options

```
--app-s-key.encrypted-key bytesHex
--app-s-key.kek-label string
--app-s-key.key 16-bytes
--application-id string
--confirmed
--consumed-airtime duration
--decoded-payload-warnings strings
--dev-eui string (hex)
--device-id string
--f-cnt uint32
--f-port uint32
--frm-payload bytesBase64
-h, --help help for application-uplink
--join-eui string (hex)
--last-a-f-cnt-down uint32
--normalized-payload-warnings strings
--received-at timestamp
--session-key-id bytesBase64
--version-ids.band-id string
--version-ids.brand-id string
--version-ids.firmware-version string
--version-ids.hardware-version string
--version-ids.model-id string
--app-s-key.encrypted-key bytesHex
--app-s-key.kek-label string
--app-s-key.key 16-bytes
--application-id string
--confirmed
--consumed-airtime duration
--decoded-payload-warnings strings
--dev-eui string (hex)
--device-id string
--f-cnt uint32
--f-port uint32
--frm-payload bytesBase64
-h, --help help for application-uplink
--join-eui string (hex)
--last-a-f-cnt-down uint32
--network-ids.cluster-address string
--network-ids.cluster-id string
--network-ids.net-id 3-bytes
--network-ids.ns-id 8-bytes
--network-ids.tenant-address string
--network-ids.tenant-id string
--normalized-payload-warnings strings
--received-at timestamp
--session-key-id bytesBase64
--settings.concentrator-timestamp int
--settings.data-rate.modulation.fsk.bit-rate uint32
--settings.data-rate.modulation.lora.bandwidth uint32
--settings.data-rate.modulation.lora.coding-rate string
--settings.data-rate.modulation.lora.spreading-factor uint32
--settings.data-rate.modulation.lrfhss.coding-rate string
--settings.data-rate.modulation.lrfhss.modulation-type uint32
--settings.data-rate.modulation.lrfhss.operating-channel-width uint32
--settings.downlink.antenna-index uint32
--settings.downlink.invert-polarization
--settings.downlink.tx-power float32
--settings.enable-crc
--settings.frequency uint
--settings.time timestamp
--settings.timestamp uint32
--version-ids.band-id string
--version-ids.brand-id string
--version-ids.firmware-version string
--version-ids.hardware-version string
--version-ids.model-id string
```

### Options inherited from parent commands
Expand Down
2 changes: 2 additions & 0 deletions doc/content/ttn-lw-cli/ttn-lw-cli_tenants_create.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ ttn-lw-cli tenants create [tenant-id] [flags]
--configuration.default-cluster.ns.cooldown-window duration
--configuration.default-cluster.ns.deduplication-window duration
--configuration.default-cluster.ns.dev-addr-prefixes strings
--configuration.default-cluster.ns.net-id 3-bytes
--configuration.default-cluster.ns.ns-id bytesBase64
--configuration.default-cluster.ui.branding-base-url string
--configuration.pb.listed
--description string
Expand Down
2 changes: 2 additions & 0 deletions doc/content/ttn-lw-cli/ttn-lw-cli_tenants_get.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ ttn-lw-cli tenants get [tenant-id] [flags]
--configuration.default-cluster.ns.cooldown-window select the configuration.default_cluster.ns.cooldown_window field
--configuration.default-cluster.ns.deduplication-window select the configuration.default_cluster.ns.deduplication_window field
--configuration.default-cluster.ns.dev-addr-prefixes select the configuration.default_cluster.ns.dev_addr_prefixes field
--configuration.default-cluster.ns.net-id select the configuration.default_cluster.ns.net_id field
--configuration.default-cluster.ns.ns-id select the configuration.default_cluster.ns.ns_id field
--configuration.default-cluster.ui select the configuration.default_cluster.ui field and all allowed sub-fields
--configuration.default-cluster.ui.branding-base-url select the configuration.default_cluster.ui.branding_base_url field
--configuration.pb select the configuration.pb field and all allowed sub-fields
Expand Down
Loading

0 comments on commit f1aebcb

Please sign in to comment.