-
Notifications
You must be signed in to change notification settings - Fork 13
Docs: JavaScript SDK onboarding, starter workflow, and generated API sync #147
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
basit3407
wants to merge
23
commits into
main
Choose a base branch
from
sdk-updates
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit
Hold shift + click to select a range
c2ce845
test
osamasayed 036deff
Fix SDK onboarding docs verification
basit3407 2904811
Restore Cloudflare docs build steps
basit3407 034aa12
Merge main into SDK docs updates
basit3407 d5ba29e
Address SDK docs review comments
basit3407 54e5e85
docs: clarify SDK compatibility path
basit3407 8bf7f7a
docs: align SDK credential variable names
basit3407 4329131
docs: add agent prompt onboarding
basit3407 54a6bde
docs: streamline onboarding journey
basit3407 f92d97c
docs: fix static prompt resource links
basit3407 ca8d2b1
docs: clarify word audio CDN usage
basit3407 eb763e0
docs: add complete API reference entrypoint
basit3407 82fc11b
docs: remove unpublished OpenAPI spec links
basit3407 662cd75
docs: address llms url review feedback
basit3407 2fd715c
docs: simplify onboarding journey ux
basit3407 8c948e0
docs: reduce onboarding duplication
basit3407 8030f88
docs: remove duplicate journey guidance
basit3407 b89b683
docs: clarify starter credentials and journey previews
basit3407 bcec41a
docs: clarify starter sdk onboarding
basit3407 6179f2b
docs: refine onboarding journey UX
basit3407 2f2bf6d
docs: address copilot onboarding comments
basit3407 563226b
Add starter pointer to OAuth tutorial
basit3407 bcdd02a
Canonicalize API discovery links
basit3407 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
docs: add complete API reference entrypoint
- Loading branch information
commit eb763e024596d42dddf2df548bf47bb5546e8f01
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| title: "API Reference" | ||
| description: "Choose the right Quran Foundation API reference for content, search, OAuth2, user features, and pre-live user API validation." | ||
| sidebar_label: "API Reference" | ||
| displayed_sidebar: "APIsSidebar" | ||
| --- | ||
|
|
||
| # API Reference | ||
|
|
||
| Use this page when you already know what you are building and need endpoint-level request and response details. | ||
|
|
||
| If you do not have a Quran Foundation client yet, start with [Request Access](/request-access). If you are still choosing an app shape, start with the [Developer Journey](/docs/developer-journey). | ||
|
|
||
| ## API Families | ||
|
|
||
| | API family | Use for | Authentication shape | Reference | | ||
| | --- | --- | --- | --- | | ||
| | Content APIs | Quran text, chapters, verses, translations, tafsir, audio, recitations, pages, juz, hizb, ruku, and manzil resources. | App credentials from your backend, or the JavaScript SDK server client. | [Open Content APIs](/docs/content_apis_versioned/4.0.0/content-apis/) | | ||
| | Search APIs | Quran search queries and search result retrieval. | App credentials from your backend, or the JavaScript SDK server client. | [Open Search APIs](/docs/search_apis_versioned/1.0.0/quran-foundation-search-api/) | | ||
| | User-related APIs | Bookmarks, collections, notes, reading sessions, goals, preferences, profiles, rooms, posts, comments, and tags. | OAuth2 user session token plus client ID. | [Open User-related APIs](/docs/user_related_apis_versioned/1.0.0/user-related-apis/) | | ||
| | OAuth2 APIs | Authorization, token exchange, introspection, OIDC userinfo, and logout endpoints. | OAuth2 / OpenID Connect. | [Open OAuth2 APIs](/docs/oauth2_apis_versioned/1.0.0/oauth-2-apis/) | | ||
| | User-related APIs (Pre-live) | Upcoming user API behavior before it is promoted to production docs. | Pre-live OAuth2 user session token plus client ID. | [Open Pre-live User APIs](/docs/category/user-related-apis-pre-live) | | ||
|
|
||
| ## Reference Helpers | ||
|
|
||
| - [Field Reference](/docs/api/field-reference) lists common content field selectors. | ||
| - [OAuth2 Scopes](/docs/user_related_apis_versioned/scopes) lists user API scopes. | ||
| - [Content APIs Quickstart](/docs/quickstart) explains the first backend Content API call. | ||
| - [User APIs Quickstart](/docs/tutorials/oidc/user-apis-quickstart) explains signed-in user API calls. | ||
|
|
||
| ## OpenAPI Specs | ||
|
|
||
| | Spec | URL | | ||
| | --- | --- | | ||
| | Content APIs v4 | [`/openAPI/content/v4.json`](/openAPI/content/v4.json) | | ||
| | Search APIs v1 | [`/openAPI/search/v1.json`](/openAPI/search/v1.json) | | ||
| | User-related APIs v1 | [`/openAPI/user-related-apis/v1.json`](/openAPI/user-related-apis/v1.json) | | ||
| | User-related APIs v1 (Pre-live) | [`/openAPI/user-related-apis/pre-live/v1.json`](/openAPI/user-related-apis/pre-live/v1.json) | | ||
| | OAuth2 APIs v1 | [`/openAPI/oauth2-apis/v1.json`](/openAPI/oauth2-apis/v1.json) | |
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
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
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
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
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
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
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
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
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
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
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
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.