Skip to content

Add a compatibility check between docs/api-reference.md's documented error codes and both contracts' actual error enums #932

Description

@fejilaup-cloud

Labels: documentation, bug
Priority: Medium
Estimated Time: 1.5 hours

Description:
Given ip_registry's ContractError currently has only 5 variants (per #92) while atomic_swap's has roughly 60, and both are surfaced through the API server once handlers are wired (#49), confirm docs/api-reference.md accurately lists every error code a client can actually receive from each contract, not a stale or partial subset.

Tasks:

  • Generate the documented error-code list directly from each contract's error enum rather than hand-maintaining it
  • Add a CI check that fails if docs/api-reference.md's error table and the contracts' enums diverge
  • Cross-link this with Implement swap_count view function #58's OpenAPI regeneration check

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions