Skip to content

docs: reconcile query API documentation with QueryManager gap analysis#596

Closed
DevSolex wants to merge 1 commit into
Predictify-org:masterfrom
DevSolex:feature/query-api-reconciliation
Closed

docs: reconcile query API documentation with QueryManager gap analysis#596
DevSolex wants to merge 1 commit into
Predictify-org:masterfrom
DevSolex:feature/query-api-reconciliation

Conversation

@DevSolex

Copy link
Copy Markdown
Contributor

Summary

Reconciles the published Query API against the Gap Analysis identified in contracts/predictify-hybrid/src/queries.rs.

Changes

  • queries.rs — supersedes the 2026-04-23 Gap Analysis doc-comment with a reconciled table for every getter (Implemented / Stubbed / Planned) plus exact call paths for functions outside QueryManager
  • API_DOCUMENTATION.md — replaces the flat bullet list in the Query Functions section with status tables covering all 24 QueryManager functions and out-of-manager getters (get_permissions_for_role, get_dispute_timeout_status, get_config, get_configuration_history, get_effective_bet_limits)

Acceptance Criteria Met

  • Every getter from the Gap Analysis marked Implemented / Stubbed / Planned
  • Getters outside QueryManager documented with their real call path
  • Stubbed metric fields (query_user_balance, query_market_pool, query_contract_state) flagged and linked to Document and reconcile the published query API against the QueryManager gap analysis #595
  • Gap Analysis doc-comment updated/superseded
  • All 24 documented function names verified via grep -n "pub fn <name>" contracts/predictify-hybrid/src/*.rs

Closes #595

- Update Gap Analysis doc-comment in queries.rs (supersedes 2026-04-23):
  mark every getter as Implemented / Stubbed / Planned with exact call path
- Update API_DOCUMENTATION.md 'Query Functions' section:
  replace flat bullet list with status tables covering all QueryManager
  functions plus out-of-manager getters (bet limits, config, dispute timeout,
  permissions_for_role)
- Flag stubbed metric fields in query_user_balance, query_market_pool, and
  query_contract_state and cross-link to issue Predictify-org#595
- Add grep-based verification method so status can be re-checked at any time

Closes Predictify-org#595
@greatest0fallt1me

Copy link
Copy Markdown
Contributor

closing in favor of #597, which already includes this exact commit plus the threat-model doc, so i didn't want to merge the same queries.rs change twice. all your work still lands via #597, thanks 🙏

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.

Document and reconcile the published query API against the QueryManager gap analysis

2 participants