Repository navigation
[api-v3] INTER-2472: Update schema URL and harden sync script - #282
Merged
Merged
Conversation
Update the OpenAPI schema URL. Use an `env bash` shebang and harden `curl` to refuse redirects that leave https and to bound connect and transfer time, so a stalled download cannot hang CI or a local run. Log the download. Inline the base URL into `schemaUrl`. Document `./scripts/sync.sh` and `./scripts/generate.sh` instead of invoking them through `sh`. Related-Task: INTER-2472
Contributor
pnpm exec changesetto create a changeset. |
Contributor
There was a problem hiding this comment.
Copilot review overview
🔵 Needs a closer look
The URL cutover depends on an upstream merge and repository rename that remain explicit prerequisites.
Review effort: Balanced
Findings: None
What changed in this PR
Updates schema synchronization for the planned OpenAPI repository rename and improves download reliability.
Changes:
- Uses the renamed GitHub Pages schema URL.
- Adds HTTPS redirect restrictions and network timeouts.
- Documents executable scripts using their shebangs.
| File | Description |
|---|---|
scripts/sync.sh |
Updates and hardens schema downloading. |
contributing.md |
Corrects script invocation guidance. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Contributor
|
🟢 Coverage increased by 34.33% Code Coverage ReportCoverage Report
Files Coverage
|
erayaydin
marked this pull request as ready for review
September 25, 2026 09:06
erayaydin
requested review from
Orkuncakilkaya,
TheUnderScorer and
ilfa
as code owners
September 25, 2026 09:06
Orkuncakilkaya
approved these changes
Sep 25, 2026
erayaydin
changed the title
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.
GitHub redirects repository URLs after a rename but explicitly not project GitHub Pages URLs, so
sync.shwill start failing after the rename. This PR changes the default OpenAPI schema URL.Alongside the URL change, use
env bashshebang, so the script picks up bash from the correct environment. Hardencurlto refuse redirects that leave https and bound connect and transfer time so a stalled download cannot hang CI or local. Log the download, and inline the base URL intoschemaUrl.Separately,
contributing.mddocumentedsh ./scripts/sync.shandsh ./scripts/generate.sh. Both are executable, so the documented command is now./scripts/<script>.sh, which honors the shebang. This is pre-existing and unrelated to the rename.