chapps.rest package

CHAPPS REST API implementation

Originally, I had hoped to isolate all the API-related stuff in this package, but as I should have known, references to the data models crept back into the main codebase even before the API was finished.

The api module serves to supply some top-level documentation strings related to the groups of API routes, and to include all the various API routers into the final FastAPI object.

Subpackages

• chapps.rest.routers package
  • Submodules
    • chapps.rest.routers.common module
      • Route factories and other reusable code
    • chapps.rest.routers.domains module
      • Domain record management implemented by factories
    • chapps.rest.routers.emails module
      • Email record management implemented by factories
    • chapps.rest.routers.live module
      • Routes for live access to CHAPPS state
    • chapps.rest.routers.quotas module
      • Quota record management implemented by factories
    • chapps.rest.routers.users module
      • User record management implemented by factories

Submodules

• chapps.rest.api module
  • Top level API definition