Skip to content

docs(iot): revamp #624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 21, 2023
Merged

docs(iot): revamp #624

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions packages/clients/src/api/iot/v1/api.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,9 @@ const jsonContentHeaders = {
}

/**
* IoT API.
* IoT Hub API.
*
* This API allows you to manage IoT hubs and devices. IoT API.
* This API allows you to manage IoT hubs and devices. IoT Hub API.
*/
export class API extends ParentAPI {
/** Lists the available regions of the API. */
Expand Down Expand Up @@ -286,7 +286,8 @@ export class API extends ParentAPI {
})

/**
* Get a hub's metrics.
* Get a hub's metrics. Get the metrics of an existing IoT Hub, specified by
* its Hub ID.
*
* @deprecated
* @param request - The request {@link GetHubMetricsRequest}
Expand Down Expand Up @@ -576,7 +577,8 @@ export class API extends ParentAPI {
})

/**
* Get a device's metrics.
* Get a device's metrics. Get the metrics of an existing device, specified by
* its device ID.
*
* @deprecated
* @param request - The request {@link GetDeviceMetricsRequest}
Expand Down Expand Up @@ -743,7 +745,7 @@ export class API extends ParentAPI {
)

/**
* List the Networks.
* List the networks.
*
* @param request - The request {@link ListNetworksRequest}
* @returns A Promise of ListNetworksResponse
Expand All @@ -752,7 +754,9 @@ export class API extends ParentAPI {
enrichForPagination('networks', this.pageOfListNetworks, request)

/**
* Create a new Network.
* Create a new network. Create a new network for an existing hub. Beside the
* default network, you can add networks for different data providers.
* Possible network types are Sigfox and REST.
*
* @param request - The request {@link CreateNetworkRequest}
* @returns A Promise of CreateNetworkResponse
Expand All @@ -774,7 +778,9 @@ export class API extends ParentAPI {
)

/**
* Retrieve a specific Network.
* Retrieve a specific network. Retrieve an existing network, specified by its
* network ID. The response returns full details of the network, including its
* type, the topic prefix and its endpoint.
*
* @param request - The request {@link GetNetworkRequest}
* @returns A Promise of Network
Expand All @@ -792,7 +798,8 @@ export class API extends ParentAPI {
)

/**
* Delete a Network.
* Delete a Network. Delete an existing network, specified by its network ID.
* Deleting a network is permanent, and cannot be undone.
*
* @param request - The request {@link DeleteNetworkRequest}
*/
Expand Down