Skip to content

Commit

Permalink
api: Add service annotations
Browse files Browse the repository at this point in the history
  • Loading branch information
KrishnaIyer committed Mar 14, 2024
1 parent e9e18b6 commit 29512f9
Show file tree
Hide file tree
Showing 57 changed files with 2,020 additions and 1,487 deletions.
33 changes: 27 additions & 6 deletions api/ttn/lorawan/v3/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -1054,7 +1054,7 @@ Application is the message that defines an Application in the network.

### <a name="ttn.lorawan.v3.ApplicationAccess">Service `ApplicationAccess`</a>

The ApplicationAcces service, exposed by the Identity Server, is used to manage
The ApplicationAccess service, exposed by the Identity Server, is used to manage
API keys and collaborators of applications.

| Method Name | Request Type | Response Type | Description |
Expand Down Expand Up @@ -2505,7 +2505,7 @@ The OAuth2 flows an OAuth client can use to get an access token.

### <a name="ttn.lorawan.v3.ClientAccess">Service `ClientAccess`</a>

The ClientAcces service, exposed by the Identity Server, is used to manage
The ClientAccess service, exposed by the Identity Server, is used to manage
collaborators of OAuth clients.

| Method Name | Request Type | Response Type | Description |
Expand Down Expand Up @@ -3114,6 +3114,8 @@ in a future version of The Things Stack.

### <a name="ttn.lorawan.v3.EndDeviceBatchClaimingServer">Service `EndDeviceBatchClaimingServer`</a>

The EndDeviceBatchClaimingServer service support claiming and managing batches of end devices on external Join Servers.

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| `Unclaim` | [`BatchUnclaimEndDevicesRequest`](#ttn.lorawan.v3.BatchUnclaimEndDevicesRequest) | [`BatchUnclaimEndDevicesResponse`](#ttn.lorawan.v3.BatchUnclaimEndDevicesResponse) | Unclaims multiple end devices on an external Join Server. All devices must have the same application ID. Check the response for devices that could not be unclaimed. |
Expand All @@ -3128,8 +3130,7 @@ in a future version of The Things Stack.

### <a name="ttn.lorawan.v3.EndDeviceClaimingServer">Service `EndDeviceClaimingServer`</a>

The EndDeviceClaimingServer service configures authorization to claim end devices registered in an application,
and allows clients to claim end devices.
The EndDeviceClaimingServer service support claiming and managing end devices on external Join Servers.

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
Expand All @@ -3153,6 +3154,8 @@ and allows clients to claim end devices.

### <a name="ttn.lorawan.v3.GatewayClaimingServer">Service `GatewayClaimingServer`</a>

The GatewayClaimingServer service support claiming and managing gateway claims.

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| `Claim` | [`ClaimGatewayRequest`](#ttn.lorawan.v3.ClaimGatewayRequest) | [`GatewayIdentifiers`](#ttn.lorawan.v3.GatewayIdentifiers) | Claims a gateway by claim authentication code or QR code and transfers the gateway to the target user. |
Expand Down Expand Up @@ -3679,7 +3682,7 @@ CreateClientEmailMessage is used as a wrapper for handling the email regarding t

### <a name="ttn.lorawan.v3.EmailValidationRegistry">Service `EmailValidationRegistry`</a>

The EmailValidationRegistry service, exposed by the Identity Server, is used for validating an user's primary email.
The EmailValidationRegistry service, exposed by the Identity Server, is used for validating a user's primary email.

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
Expand Down Expand Up @@ -4735,6 +4738,8 @@ NsEndDeviceRegistry, the AsEndDeviceRegistry and the JsEndDeviceRegistry.

### <a name="ttn.lorawan.v3.EndDeviceTemplateConverter">Service `EndDeviceTemplateConverter`</a>

The EndDeviceTemplateRegistry service is used to convert end devices information between formats.

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| `ListFormats` | [`.google.protobuf.Empty`](#google.protobuf.Empty) | [`EndDeviceTemplateFormats`](#ttn.lorawan.v3.EndDeviceTemplateFormats) | Returns the configured formats to convert from. |
Expand Down Expand Up @@ -5395,6 +5400,8 @@ Identifies an end device model with version information.

### <a name="ttn.lorawan.v3.GatewayConfigurationService">Service `GatewayConfigurationService`</a>

The GatewayConfigurationService fetches the configuration of a gateway.

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| `GetGatewayConfiguration` | [`GetGatewayConfigurationRequest`](#ttn.lorawan.v3.GetGatewayConfigurationRequest) | [`GetGatewayConfigurationResponse`](#ttn.lorawan.v3.GetGatewayConfigurationResponse) | |
Expand Down Expand Up @@ -5512,6 +5519,8 @@ gateway registrations in batches.

### <a name="ttn.lorawan.v3.GatewayConfigurator">Service `GatewayConfigurator`</a>

The GatewayConfigurator service is used to fetch gateway configuration.

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| `PullConfiguration` | [`PullGatewayConfigurationRequest`](#ttn.lorawan.v3.PullGatewayConfigurationRequest) | [`Gateway`](#ttn.lorawan.v3.Gateway) _stream_ | |
Expand Down Expand Up @@ -5616,6 +5625,8 @@ GatewayUp may contain zero or more uplink messages and/or a status message for t

### <a name="ttn.lorawan.v3.Gs">Service `Gs`</a>

The Gs service returns information about the Gateway Server and gateways connected to it.

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| `GetGatewayConnectionStats` | [`GatewayIdentifiers`](#ttn.lorawan.v3.GatewayIdentifiers) | [`GatewayConnectionStats`](#ttn.lorawan.v3.GatewayConnectionStats) | Get statistics about the current gateway connection to the Gateway Server. This is not persisted between reconnects. |
Expand Down Expand Up @@ -5969,6 +5980,8 @@ OrganizationOrUserIdentifiers contains either organization or user identifiers.

### <a name="ttn.lorawan.v3.EntityAccess">Service `EntityAccess`</a>

The EntityAccess service provides information about the access rights of an entity.

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| `AuthInfo` | [`.google.protobuf.Empty`](#google.protobuf.Empty) | [`AuthInfoResponse`](#ttn.lorawan.v3.AuthInfoResponse) | AuthInfo returns information about the authentication that is used on the request. |
Expand All @@ -5981,6 +5994,8 @@ OrganizationOrUserIdentifiers contains either organization or user identifiers.

### <a name="ttn.lorawan.v3.Is">Service `Is`</a>

The Is service provides information about the Identity Server.

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| `GetConfiguration` | [`GetIsConfigurationRequest`](#ttn.lorawan.v3.GetIsConfigurationRequest) | [`GetIsConfigurationResponse`](#ttn.lorawan.v3.GetIsConfigurationResponse) | Get the configuration of the Identity Server. The response is typically used to enable or disable features in a user interface. |
Expand Down Expand Up @@ -6351,6 +6366,8 @@ The AsJs service connects an Application Server to a Join Server.

### <a name="ttn.lorawan.v3.Js">Service `Js`</a>

The Js service returns configuration for a Join Server.

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| `GetJoinEUIPrefixes` | [`.google.protobuf.Empty`](#google.protobuf.Empty) | [`JoinEUIPrefixes`](#ttn.lorawan.v3.JoinEUIPrefixes) | Request the JoinEUI prefixes that are configured for this Join Server. |
Expand Down Expand Up @@ -9000,6 +9017,8 @@ The NsRelayConfigurationService provides configuration management capabilities f

### <a name="ttn.lorawan.v3.NotificationService">Service `NotificationService`</a>

The NotificationService is used to send notifications.

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| `Create` | [`CreateNotificationRequest`](#ttn.lorawan.v3.CreateNotificationRequest) | [`CreateNotificationResponse`](#ttn.lorawan.v3.CreateNotificationResponse) | Create a new notification. Can only be called by internal services using cluster auth. |
Expand Down Expand Up @@ -11111,7 +11130,7 @@ DashboardLayout is a set of possible layout values to be used in the Console.

### <a name="ttn.lorawan.v3.UserAccess">Service `UserAccess`</a>

The UserAcces service, exposed by the Identity Server, is used to manage
The UserAccess service, exposed by the Identity Server, is used to manage
API keys of users.

| Method Name | Request Type | Response Type | Description |
Expand Down Expand Up @@ -11161,6 +11180,8 @@ API keys of users.

### <a name="ttn.lorawan.v3.UserInvitationRegistry">Service `UserInvitationRegistry`</a>

The UserOrganizationRegistry service, exposed by the Identity Server, is used to manage user invitations.

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| `Send` | [`SendInvitationRequest`](#ttn.lorawan.v3.SendInvitationRequest) | [`Invitation`](#ttn.lorawan.v3.Invitation) | Invite a user to join the network. |
Expand Down
Loading

0 comments on commit 29512f9

Please sign in to comment.