Repository navigation
[docs] Clarify OTLP API key values must not be empty - #1720
Closed
aspire-repo-bot[bot] wants to merge 1 commit into
Closed
aspire-repo-bot[bot] wants to merge 1 commit into
aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
Documents PR microsoft/aspire#20363, which rejects empty OTLP primary/secondary API keys and empty incoming x-otlp-api-key headers. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
5 of 14 tasks
aspire-repo-bot
Bot
requested a review
from Jose Perez Rodriguez (joperezr)
September 23, 2026 06:53
Contributor
Author
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
David Pine (IEvangelist)
marked this pull request as ready for review
September 25, 2026 16:10
David Pine (IEvangelist)
requested review from
David Pine (IEvangelist) and
James Newton-King (JamesNK)
as code owners
September 25, 2026 16:10
David Pine (IEvangelist)
requested
a lite review from Copilot
and removed request for
Copilot
September 25, 2026 16:10
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.
Documents changes from microsoft/aspire#20363
@JamesNKTarget branch
Targeting
release/13.6based on the source PR milestone13.6.Why this docs update is needed
microsoft/aspire#20363 changes OTLP API key authentication behavior in the Aspire dashboard:
x-otlp-api-keyheader is empty, before performing the fixed-time key comparison against the primary/secondary key.Dashboard:Otlp:SecondaryApiKeynot be an empty string when OTLP auth mode isApiKey(it can still be left unset entirely).This is a user-visible behavior change to an already-documented feature (
Dashboard:Otlp:PrimaryApiKey/Dashboard:Otlp:SecondaryApiKeyin the OTLP configuration table), so no automatic docs signal fired, but the docs needed updating to describe the new validation.What changed
Updated
src/frontend/src/content/docs/dashboard/configuration.mdx:x-otlp-api-keyheader is always rejected, and that configuring an empty primary/secondary API key is invalid.Dashboard:Otlp:PrimaryApiKeyrow: notes the value must not be an empty string.Dashboard:Otlp:SecondaryApiKeyrow: notes that if configured, it must not be an empty string.Files modified
src/frontend/src/content/docs/dashboard/configuration.mdx(updated)