Skip to content

docs: similarity precheck API - #6

Merged
echobt merged 1 commit into
mainfrom
docs/similarity-precheck
Aug 8, 2026
Merged

docs: similarity precheck API#6
echobt merged 1 commit into
mainfrom
docs/similarity-precheck

Conversation

@echobt

@echobt echobt commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Document POST /v1/submissions/precheck (quota 3/coldkey/UTC day, response fields, curl example).
  • Mirror BASE monorepo miner docs for the Prism similarity dry-run path.

Test plan

  • Read-through submit.md / api.md / troubleshooting.md
  • Confirm gateway route live after control-plane deploy

Summary by CodeRabbit

  • Documentation
    • Documented the submission similarity precheck endpoint and ZIP request format.
    • Added examples for similarity verdicts, quota details, and response fields.
    • Clarified daily limits of three precheck requests per coldkey, with hotkey fallback.
    • Documented membership, contract, and quota-exceeded error responses.
    • Added troubleshooting guidance for similarity matches and exhausted precheck quotas.

Point miners at POST /v1/submissions/precheck before burning a real submit.
@echobt
echobt merged commit c12f201 into main Aug 8, 2026
3 of 10 checks passed
@echobt
echobt deleted the docs/similarity-precheck branch August 8, 2026 06:50
@coderabbitai

coderabbitai Bot commented Aug 8, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d4a904b4-38b5-4738-9ec1-70b2ae9d8c9a

📥 Commits

Reviewing files that changed from the base of the PR and between 8abba00 and ff6dea9.

📒 Files selected for processing (4)
  • docs/api.md
  • docs/scoring.md
  • docs/submit.md
  • docs/troubleshooting.md

📝 Walkthrough

Walkthrough

The documentation adds the submission similarity precheck endpoint, request and response examples, shared errors, a three-request daily coldkey quota, and troubleshooting guidance.

Changes

Submission precheck documentation

Layer / File(s) Summary
Precheck endpoint contract
docs/api.md
Documents the precheck route, advisory behavior, shared membership and contract errors, and 429 precheck_quota_exceeded.
Precheck usage and troubleshooting
docs/submit.md, docs/scoring.md, docs/troubleshooting.md
Describes ZIP requests, response fields, similarity verdicts, quota rules, and actions for flagged submissions.

Estimated code review effort: 1 (Trivial) | ~3 minutes

✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/similarity-precheck

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.

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.

1 participant