Skip to content

docs: add Search API response examples#170

Merged
basit3407 merged 1 commit into
mainfrom
codex/search-response-examples
Jun 4, 2026
Merged

docs: add Search API response examples#170
basit3407 merged 1 commit into
mainfrom
codex/search-response-examples

Conversation

@basit3407

@basit3407 basit3407 commented Jun 4, 2026

Copy link
Copy Markdown
Collaborator

Split out from PR #167 so Search API response examples can be reviewed independently.

Scope:

  • Adds Search 200 response examples for advanced results, no results, and quick navigation.
  • Adds documented JSON content/examples for common 400, 401, and 403 responses.
  • Adds a Search error response schema matching the service error envelope.

Local validation:

  • Parsed openAPI/search/v1.json with Node.
  • Checked every Search JSON response has a top-level example.
  • git diff --check

Hosted validation:

  • Cloudflare Pages passed.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying qf-api-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 008dee5
Status: ✅  Deploy successful!
Preview URL: https://54ebc887.qf-api-docs.pages.dev
Branch Preview URL: https://codex-search-response-exampl.qf-api-docs.pages.dev

View logs

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@basit3407 basit3407 merged commit ffc1f95 into main Jun 4, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants