Skip to content

Adds comprehensive context key reference to docs#8420

Merged
mabuyo merged 11 commits intodevfrom
doc-context-keylist
Oct 16, 2025
Merged

Adds comprehensive context key reference to docs#8420
mabuyo merged 11 commits intodevfrom
doc-context-keylist

Conversation

@faisalwaseem
Copy link
Contributor

@faisalwaseem faisalwaseem commented Oct 14, 2025

This change documents all the context keys router supports as of submitting this PR.


Checklist

Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.

  • PR description explains the motivation for the change and relevant context for reviewing
  • PR description links appropriate GitHub/Jira tickets (creating when necessary)
  • Changeset is included for user-facing changes
  • Changes are compatible1
  • Documentation2 completed
  • Performance impact assessed and acceptable
  • Metrics and logs are added3 and documented
  • Tests added and passing4
    • Unit tests
    • Integration tests
    • Manual tests, as necessary

Exceptions
This is only a change in documentation
Note any exceptions here

Notes

Footnotes

  1. It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this.

  2. Configuration is an important part of many changes. Where applicable please try to document configuration examples.

  3. A lot of (if not most) features benefit from built-in observability and debug-level logs. Please read this guidance on metrics best-practices.

  4. Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions.

@faisalwaseem faisalwaseem requested a review from a team as a code owner October 14, 2025 20:02
@github-actions

This comment has been minimized.

@apollo-librarian
Copy link

apollo-librarian bot commented Oct 14, 2025

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 2 changed, 0 removed
* graphos/routing/(latest)/customization/coprocessor/reference.mdx
* graphos/routing/(latest)/customization/overview.mdx

Build ID: a5140f61af01d6bb372b3b18
Build Logs: View logs

URL: https://www.apollographql.com/docs/deploy-preview/a5140f61af01d6bb372b3b18

@@ -0,0 +1,35 @@
### Adds comprehensive context key reference to docs ([PR #8420](https://github.com/apollographql/router/pull/8420))
Copy link
Contributor

Choose a reason for hiding this comment

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

I think something went wrong in the changeset here? I'm seeing a checklist that should only be in the PR description.

We can also remove this changeset because docs-only PRs typically don't need one.

Copy link
Member

Choose a reason for hiding this comment

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

Generally speaking, it's true that docs stuff doesn't need them, but I like to highlight really valuable documentation additions in our changesets, and I feel like this is one of them.

The changesets tooling defaults to the PR description that appears above the <!-- start metadata --> line in the PR template, but since this PR had no description, it just defaulted to the entire PR contents.

@faisalwaseem If you don't have time to fix the changeset, I can take a shot at it. Alternatively, agree to just delete it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am ok with removing the changeset since the change is so minor

Copy link
Contributor Author

Choose a reason for hiding this comment

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

FYI I did take a crack and fixing the changeset file lets see if that works

Copy link
Contributor

Choose a reason for hiding this comment

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

Ahh thanks for clarifying Jesse! and looks like the changeset looks better now 🙌🏽 I'll go ahead and review the meat of the PR 👀

Copy link
Contributor

@mabuyo mabuyo left a comment

Choose a reason for hiding this comment

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

@faisalwaseem I made a few edits directly (reasoning in commit messages / comments). Just need confirmation for a couple property names. Thanks for improving these docs!

Copy link
Contributor Author

@faisalwaseem faisalwaseem left a comment

Choose a reason for hiding this comment

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

I am good with the changes proposed. Thank you for the reviews

Copy link
Contributor Author

@faisalwaseem faisalwaseem left a comment

Choose a reason for hiding this comment

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

Aligned with the changes

@faisalwaseem faisalwaseem requested a review from mabuyo October 16, 2025 14:51
@mabuyo mabuyo enabled auto-merge (squash) October 16, 2025 15:20
@mabuyo mabuyo merged commit 9f9b0bf into dev Oct 16, 2025
15 checks passed
@mabuyo mabuyo deleted the doc-context-keylist branch October 16, 2025 15:36
@abernix abernix mentioned this pull request Oct 27, 2025
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