Document content resource sync API#152
Merged
Merged
Conversation
Deploying qf-api-docs with
|
| Latest commit: |
78e7c2d
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://e83d2798.qf-api-docs.pages.dev |
| Branch Preview URL: | https://codex-content-sync-openapi-d.qf-api-docs.pages.dev |
![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: 3b01ff130c
ℹ️ 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".
Contributor
There was a problem hiding this comment.
Pull request overview
This PR expands the Quran.Foundation Content API v4 documentation by adding OpenAPI + generated Docusaurus endpoint docs for the new resource sync/snapshot capabilities, and by documenting the intended sync flow in the JavaScript SDK docs.
Changes:
- Added OpenAPI v4 definitions for
GET /resources/syncandGET /resources/snapshots/{resource_group}/{id}, including new sync-related schemas. - Regenerated v4 API reference pages and wired the new endpoints into the Resources sidebars (current + 4.0.0 versioned).
- Added a JavaScript SDK guide section describing bootstrap + incremental sync + snapshot usage.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| openAPI/content/v4.json | Adds the two new Resources endpoints and introduces sync/snapshot schema components. |
| docs/sdk/javascript/resources.mdx | Documents recommended sync flow and provides TypeScript examples for SDK usage. |
| docs/content_apis_versioned/sidebar.js | Exposes the newly generated sync/snapshot endpoint docs in the current v4 Resources sidebar. |
| docs/content_apis_versioned/resources-sync.api.mdx | Generated API reference page for GET /resources/sync (current docs). |
| docs/content_apis_versioned/resources-snapshot.api.mdx | Generated API reference page for GET /resources/snapshots/... (current docs). |
| docs/content_apis_versioned/4.0.0/sidebar.js | Exposes the new endpoints in the versioned 4.0.0 sidebar. |
| docs/content_apis_versioned/4.0.0/resources-sync.api.mdx | Generated API reference page for GET /resources/sync (v4.0.0 docs). |
| docs/content_apis_versioned/4.0.0/resources-snapshot.api.mdx | Generated API reference page for GET /resources/snapshots/... (v4.0.0 docs). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
Summary
GET /resources/sync.GET /resources/snapshots/{resource_group}/{id}.Validation
yarn gen-api-docs content_apis_versionedyarn gen-api-docs:version content_apis_versioned:allyarn postgen-api-cleanupyarn postgen-api-sidebarsyarn testNotes
yarn typecheckcurrently fails on existing Docusaurus/theme alias resolution errors unrelated to these changes, e.g.@theme/ApiDemoPanel/FormItemand@docusaurus/plugin-content-docs-types.yarn buildwas attempted but did not complete within the 10 minute local timeout.