Skip to content

API package implementation

Key Points

  1. rest api and other apis (rpc services if ever needed) to interact with the DMS;
  2. The api package will be responsible for two main functionalities:
    1. Wrapping functions in other packages and creating adapters
    2. Listening on a server (REST and/or RPC) and translating to the actual functions in other packages when the endpoints are triggered.

Work Package Deliverables

No Deliverable Proof
1 Wrappers need to be created for all functionality offered through the rest endpoints.. Not structured at the moment Specify and write tests; Tests added to the respective test suite
2 Wrappers need to be able to be served through both REST endpoints and GRPC services Implemented and tested
3 Move current functionality implemented within routes package into the api package re-factored, tests adapted accordingly

Timeline

Additional notes and context

  1. relatively simple package that does not depend on the job orchestration semantics and other packages; However, the specification and documentation of the package via our [documentation / specification system] is the most important aspect of this package, as it is exposing all dms functionalities to other packages and use-cases to be developed both by the core-team and community developers.
Edited by kabir