Skip to content

📝(docs) fix resource server code snippet - #2536

Open
jmaupetit wants to merge 1 commit into
mainfrom
fix-resource-server-doc
Open

📝(docs) fix resource server code snippet#2536
jmaupetit wants to merge 1 commit into
mainfrom
fix-resource-server-doc

Conversation

@jmaupetit

Copy link
Copy Markdown

Proposal

One needs to be authenticated while requesting the external API.

@jmaupetit jmaupetit self-assigned this Jul 23, 2026
@jmaupetit
jmaupetit requested a review from virgile-dev July 23, 2026 08:09
@jmaupetit jmaupetit added the documentation Improvements or additions to documentation label Jul 23, 2026
@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: c82d1bd4-f695-41e5-851d-7ff2049b3b5e

📥 Commits

Reviewing files that changed from the base of the PR and between 203d9c6 and 5bee213.

📒 Files selected for processing (1)
  • documentation/resource_server.md

Walkthrough

The resource server documentation updates the EXTERNAL_API actions formatting and adds an Authorization: Bearer {access_token} header to the “Create a document” requests.post(...) example.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: lunika

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title matches the docs-only change and mentions the resource server snippet being fixed.
Description check ✅ Passed The description is directly related to the change, noting that external API requests need authentication.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-resource-server-doc

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@documentation/resource_server.md`:
- Line 90: Update the multipart upload request in the documentation example to
remove the explicit Content-Type header while preserving the Authorization
Bearer header, allowing requests to generate the correct multipart/form-data
boundary automatically.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 9c2da300-630c-4f62-9dbb-4fc228bc20e0

📥 Commits

Reviewing files that changed from the base of the PR and between 9c3bc8a and 203d9c6.

📒 Files selected for processing (1)
  • documentation/resource_server.md

Comment thread documentation/resource_server.md Outdated
@virgile-dev
virgile-dev requested review from lunika and qbey and removed request for virgile-dev July 23, 2026 08:20
One needs to be authenticated while requesting the external API.
@jmaupetit
jmaupetit force-pushed the fix-resource-server-doc branch from 203d9c6 to 5bee213 Compare July 27, 2026 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant