Skip to content

Document repeated-key convention for OpenMetrics array query params#4627

Merged
jsundai merged 2 commits into
mainfrom
docs/cloud-metrics-array-param-convention
May 29, 2026
Merged

Document repeated-key convention for OpenMetrics array query params#4627
jsundai merged 2 commits into
mainfrom
docs/cloud-metrics-array-param-convention

Conversation

@dustin-temporal
Copy link
Copy Markdown
Contributor

@dustin-temporal dustin-temporal commented May 28, 2026

Summary

  • The namespaces and metrics query parameters on GET /v1/metrics were documented as "string array" with no example of how to pass multiple values.
  • Multi-value array encoding is not standardized across APIs (some use commas, some repeated keys, some bracketed indices), so users (and their AI assistants) were guessing wrong.
  • Adds an example showing the repeated-key convention (?namespaces=ns1&namespaces=ns2) under the Query Parameters table, and a multi-namespace line to the Filtering at Scrape Time examples.

Test plan

  • Visual review of rendered docs page on the Vercel preview
  • Confirm code samples render correctly in the shell fence

┆Attachments: EDU-6439 Document repeated-key convention for OpenMetrics array query params

The Query Parameters table listed `namespaces` and `metrics` as "string
array" without specifying the multi-value encoding. Add an example showing
the repeated-key convention so users do not assume comma-delimited values.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@dustin-temporal dustin-temporal requested a review from a team as a code owner May 28, 2026 20:20
@vercel
Copy link
Copy Markdown

vercel Bot commented May 28, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
temporal-documentation Ready Ready Preview, Comment May 29, 2026 5:47pm

Request Review

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 28, 2026

📖 Docs PR preview links

@jsundai jsundai merged commit 94c49e6 into main May 29, 2026
10 checks passed
@jsundai jsundai deleted the docs/cloud-metrics-array-param-convention branch May 29, 2026 17:47
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.

2 participants