EDC TypeScript POC API Client

[richardtreier]

Feature Request

Description

Implement a TypeScript API Client for our new API Wrapper.

How does this tie into our current product?

Faster deployment speed for UI APIs allows us to more confidently build and ship UI features. It would allow us to fully take control and create API endpoints for our UI pages that suit our needs.

Stakeholders

EDC UI

Solution Proposal and Work Breakdown

• Implement OpenAPI Generation on build to be consumed for further generation for Typescript Client
• Implement an optional endpoint that serves the OpenAPI YAML file in dev.
• Add POC for correct generation of advanced OpenAPI YAML:
  • Find a way to mark fields as required=true so they can be generated in TypeScript non-null.
  • Find a way to add text documentation for anything that can be documented in the OpenAPI specification, so that the models in the generated TypeScript client may be documented.
• Implement a TypeScript API Client Library that generates itself from the openapi.yaml
• Automatic Deployment of this TypeScript API Client Library to a public NPM Repository
• Ensure API Client works:
  • With API Key (CE / Self-Deployed)
  • Without API Key (for our UIs)
• Add example ts project that uses the library with a README.md on how to get it running