Skip to content

docs(api): add time-cutoff examples and Request URL copy button - #5086

Draft
aseckin wants to merge 1 commit into
mainfrom
claude/issue-3394-small-api-docs-improvements
Draft

docs(api): add time-cutoff examples and Request URL copy button#5086
aseckin wants to merge 1 commit into
mainfrom
claude/issue-3394-small-api-docs-improvements

Conversation

@aseckin

@aseckin aseckin commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Closes #3394

Summary

  • Enhance descriptions of open_time__gt, published_at__gt, and scheduled_resolve_time__gt filters with concrete usage examples.
  • Inject a small copy-to-clipboard button next to each "Request URL" heading in the Swagger UI page (Swagger UI v3 ships one for the curl example but not for the plain Request URL).

Generated with Claude Code

- Enhance descriptions of open_time__gt, published_at__gt, and
  scheduled_resolve_time__gt filters with concrete gt/lte usage
  examples so users can see how to query time cutoffs at a glance.
- Inject a small copy-to-clipboard button next to each "Request URL"
  heading in the Swagger UI page. Swagger UI v3 ships one for the
  curl example but not for the plain Request URL.

Closes #3394

Co-authored-by: aseckin <3686968+aseckin@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: ae37b48a-c829-43ec-ab1c-559871e866cc

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/issue-3394-small-api-docs-improvements

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

🚀 Preview Environment

Your preview environment is ready!

Resource Details
🌐 Preview URL https://metaculus-pr-5086-claude-issue-3394-small-api-do-preview.mtcl.cc
📦 Docker Image ghcr.io/metaculus/metaculus:claude-issue-3394-small-api-docs-improvements-cd63255
🗄️ PostgreSQL NeonDB branch preview/pr-5086-claude-issue-3394-small-api-do
Redis Fly Redis mtc-redis-pr-5086-claude-issue-3394-small-api-do

Details

  • Commit: cd632552984e47ba3363c9ad5a23fc93e5f8f507
  • Branch: claude/issue-3394-small-api-docs-improvements
  • Fly App: metaculus-pr-5086-claude-issue-3394-small-api-do

ℹ️ Preview Environment Info

Isolation:

  • PostgreSQL and Redis are fully isolated from production
  • Each PR gets its own database branch and Redis instance
  • Changes pushed to this PR will trigger a new deployment

Limitations:

  • Background workers and cron jobs are not deployed in preview environments
  • If you need to test background jobs, use Heroku staging environments

Cleanup:

  • This preview will be automatically destroyed when the PR is closed

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.

Small API Docs improvements

1 participant