Skip to content

Gateway APIs docs. Updated commands#570

Merged
vvlladd28 merged 4 commits into
thingsboard:mainfrom
stitenko:07.2026/Gateway-Api-DOCS
Jul 23, 2026
Merged

Gateway APIs docs. Updated commands#570
vvlladd28 merged 4 commits into
thingsboard:mainfrom
stitenko:07.2026/Gateway-Api-DOCS

Conversation

@stitenko

Copy link
Copy Markdown
Contributor

Updated the Gateway MQTT API reference docs (src/content/_includes/docs/reference/gateway-api/) with corrected/expanded request examples.

attributes.mdx — Request Attribute Values:

  • Documented the request payload as id, device, keys (array), client (boolean: true for client-side, false for shared), with tabbed JSON examples for each variant.
  • Replaced the two-terminal mosquitto_sub + mosquitto_pub example with a single mosquitto_rr command per variant (Client/Shared tabs) — avoids the response being lost when a second connection from the same gateway device drops the subscriber's connection.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 + Products gating 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_HOST for self-hosted rendering).
  • Expanded the “Request Attribute Values” section with mosquitto_rr request/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.

Comment thread src/content/_includes/docs/reference/gateway-api/attributes.mdx
Comment thread src/content/_includes/docs/reference/gateway-api/telemetry.mdx Outdated
Comment thread src/content/_includes/docs/reference/gateway-api/rpc.mdx Outdated
Comment thread src/content/_includes/docs/reference/gateway-api/overview.mdx Outdated
Comment thread src/content/_includes/docs/reference/gateway-api/claiming.mdx Outdated
@vvlladd28
vvlladd28 merged commit 661ec15 into thingsboard:main Jul 23, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants