Modify 'X-Api-Key' header description#569
Merged
Merged
Conversation
Updated the description for the 'X-Api-Key' header to include the requirement for a unique API key.
There was a problem hiding this comment.
Pull request overview
Updates the Live Search GraphQL required-headers include to clarify that X-Api-Key must be the environment-specific (unique) API key, aligning the guidance with other Commerce services documentation.
Changes:
- Replaced the
X-Api-Keyheader description from a fixed value (search_gql) to the unique API key generated for the Commerce environment. - Added a PaaS edition marker (
<Edition name="paas" />) to theX-Api-Keyheader guidance.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
meker12
approved these changes
May 27, 2026
github-project-automation
Bot
moved this from 📋 Needs Review
to 👍 Approved
in Commerce - Pull Requests
github-project-automation
Bot
moved this from 👍 Approved
to 🏁 Done
in Commerce - Pull Requests
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.
Purpose of this pull request
This pull request (PR) updates the description for the 'X-Api-Key' header to include the requirement for a unique API key.
JIRA: MSRCH-5527
Affected pages