FAQ | This is a LIVE service | Changelog

Create client library generation image

Description

Create (or find) a standard docker image that can generate client library code from a provided OpenAPI specification.

Further details

We intend to, for the first instance, create a docker image that can generate a Typescript client library. The client library to use will be from https://gitlab.developers.cam.ac.uk/uis/devops/iam/admin/-/issues/110

When run the entrypoint of the docker image will need to ingest:

  • An OpenAPI specification
  • Configuration options/command line arguments for the generator

And should write as an output:

  • A typescript package (into a known location on the container - can be extracted via a volume mount or similar)

Task list

Acceptance criteria

  • Docker container that can be used to build API Typescript client libraries is built and available for downstream use.
  • This image is built as part of the standard DevOps docker image builds.
  • This image is documented in this repository's README

Links/references

Edited by Mike Knee