Skip to content

Add OpenAPI Specification for Current Endpoints #8

@mikewheeleer

Description

@mikewheeleer

Implement OpenAPI Specification for LiquiFact API

Description

Document health, API info, invoices, and escrow endpoints in OpenAPI format with request and response schemas.

Requirements and context

  • Must be secure, tested, and documented
  • Should be efficient and easy to review

Suggested execution

  • Fork the repo and create a branch
  • git checkout -b docs/openapi-spec-v1
  • Implement changes
  • Write backend docs: OpenAPI file and route references
  • Write comprehensive tests: schema conformance checks
  • Add documentation: README.md
  • Include JSDoc-style comments
  • Validate security assumptions

Test and commit

  • Run tests
  • Cover edge cases
  • Include test output and security notes

Example commit message

docs(api): add OpenAPI spec for current endpoint surface

Guidelines

  • Minimum 95 percent test coverage
  • Clear documentation
  • Timeframe: 96 hours

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions