Clarify headless app request guidance - #789
Conversation
✅ Deploy Preview for craft-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ca0c57badd
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 4c7f3df189
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review |
|
@codex review |
|
Codex Review: Didn't find any major issues. You're on a roll. Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
There was a problem hiding this comment.
🟡 Changes recommended
Five unresolved findings remain, including one critical signing-scope issue and four moderate caching/retry issues.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
Clarifies Craft Cloud headless-app guidance for signing, throttling, caching, and retries.
Changes:
- Refines request-signing and rate-limit guidance.
- Recommends throttling build bursts and using cacheable GraphQL GET requests.
- Updates Ky retry examples and framework guidance.
File summaries
| File | Summary |
|---|---|
docs/cloud/headless-apps.md |
Critical (1 vote): Explicitly scope signing to trusted server-side/build code and retain key-secrecy guidance. Moderate: Correct the cache description for GraphQL JSON responses (1 vote); align Retry-After wording with configured statuses (2 votes); enable GET retries across snippets (2 votes); replace unsupported totalTimeout with a real deadline mechanism (1 vote). |
Review details
Suppressed comments (2)
docs/cloud/headless-apps.md:29
- The Cloud static-caching guide says this cache is for cacheable HTML responses, while a GraphQL
GETreturns JSON. This claim therefore misleads readers into expecting these responses to use Cloud’s static page cache; point instead to the hosting/CDN cache (or Craft’s GraphQL cache) and state any required cache configuration.
- When possible, send GraphQL queries with
[`GET` requests](/5.x/development/graphql.html#sending-requests-manually) so
successful responses can be served from Cloud’s static cache.
docs/cloud/headless-apps.md:81
- This retry count is paired with
totalTimeout: 30_000, buttotalTimeoutis not a Ky option, so it does not impose an overall deadline. Withtimeout: false, ten exponential-backoff retries can run past the five-minute signature lifetime and leave builds waiting much longer than documented; replace that option with a real overall abort signal or another supported timeout mechanism.
limit: 10,
- Files reviewed: 1/1 changed files
- Comments generated: 3
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Summary
Retry-Afterand read-only queriesValidation
git diff --check origin/main...HEAD