Gateway APIs docs. Updated commands#570
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Gateway MQTT API reference include docs to standardize gateway access token placeholders and provide product-specific guidance (self-hosted vs ThingsBoard Cloud), plus improves the attribute request example flow to avoid MQTT connection churn.
Changes:
- Added
ShowFor+Productsgating to show different “replace host/token” instructions for CE/PE vs PAAS/PAAS_EU pages. - Standardized command examples to use
GATEWAY_DEVICE_ACCESS_TOKEN(and documented$THINGSBOARD_HOSTfor self-hosted rendering). - Expanded the “Request Attribute Values” section with
mosquitto_rrrequest/response examples and clarified payload shape.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| src/content/_includes/docs/reference/gateway-api/telemetry.mdx | Adds product-specific replacement notes for the telemetry publish command. |
| src/content/_includes/docs/reference/gateway-api/rpc.mdx | Adds product-specific replacement notes and updates RPC command token placeholder. |
| src/content/_includes/docs/reference/gateway-api/overview.mdx | Adds product-specific replacement notes and updates connect/disconnect command token placeholder. |
| src/content/_includes/docs/reference/gateway-api/claiming.mdx | Adds product-specific replacement notes and updates claiming command token placeholder. |
| src/content/_includes/docs/reference/gateway-api/attributes.mdx | Updates HostCode import, expands attribute request docs, switches examples to mosquitto_rr, and adds a note about missing values. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updated the Gateway MQTT API reference docs (
src/content/_includes/docs/reference/gateway-api/) with corrected/expanded request examples.attributes.mdx— Request Attribute Values:id,device,keys(array),client(boolean:truefor client-side,falsefor shared), with tabbed JSON examples for each variant.mosquitto_sub+mosquitto_pubexample with a singlemosquitto_rrcommand per variant (Client/Shared tabs) — avoids the response being lost when a second connection from the same gateway device drops the subscriber's connection.