Skip to content

feat: network request docs overhaul#17644

Open
TkDodo wants to merge 3 commits intomasterfrom
tkdodo/data-fetching
Open

feat: network request docs overhaul#17644
TkDodo wants to merge 3 commits intomasterfrom
tkdodo/data-fetching

Conversation

@TkDodo
Copy link
Copy Markdown
Contributor

@TkDodo TkDodo commented May 6, 2026

DESCRIBE YOUR PR

This PR updates the Network Request section of the developer docs to reflect the current reality.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

EXTRA RESOURCES

@vercel
Copy link
Copy Markdown

vercel Bot commented May 6, 2026

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

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment May 6, 2026 11:58am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
sentry-docs Ignored Ignored Preview May 6, 2026 11:58am

Request Review

@TkDodo TkDodo marked this pull request as ready for review May 6, 2026 11:06
@TkDodo TkDodo requested a review from a team May 6, 2026 11:07
Comment thread develop-docs/frontend/network-requests.mdx Outdated
Comment thread develop-docs/frontend/network-requests.mdx Outdated
Comment on lines +323 to +325
url: getApiUrl('/organizations/$organizationIdOrSlug/projects/', {
path: {organizationIdOrSlug: organization.slug},
}),
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Bug: The mutation quick start example is broken. It uses getApiUrl without importing it and references an out-of-scope variable organization.slug instead of the correct orgSlug.
Severity: LOW

Suggested Fix

Import getApiUrl from its source file. In the call to getApiUrl, replace the reference to the out-of-scope variable organization.slug with the correct parameter, orgSlug.

Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: develop-docs/frontend/network-requests.mdx#L323-L325

Potential issue: The mutation quick start code example in the documentation contains two
errors that prevent it from functioning. First, it calls the `getApiUrl` function
without including the necessary import statement. Second, it references
`organization.slug` to construct the API URL path, but the `organization` variable is
not in scope. The intended variable is `orgSlug`, which is available as a parameter to
the mutation function but is not used. These issues will cause immediate TypeScript or
runtime errors for any developer attempting to use this code example.

Also affects:

  • develop-docs/frontend/network-requests.mdx:365~367

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.

1 participant