Skip to content

Create an ADR that defines how specs are transferred and automatically published to API Management #42

@lucashuet93

Description

@lucashuet93

Initial notes from design sessions:

  • Upstream spec repository will release new specs to this API Ops repo, but for POC purposes, we will build the specs into a specific folder/branch in this repo.
  • An API spec release should result in a new /apimartifacts/apis configuration, whether it be a new version or revision.
  • A spec change will be part of a larger release package that includes 1. the spec and 2. parameters related to the spec.
  • The API Ops repository (this repo) should have templates for apiInformation.json, product changes, and policy changes.
  • The release's parameters should be applied to these templates to create the relevant apimartifacts folders and files to deploy the new API version or revision.
  • The publisher should actually be run from inside Kubernetes, applying the /apimartifacts folder contents after the addition of the new version/revision.

Todo:

  • Create templates for apiInformation.json, product changes, and policy changes Templatize API Ops files that would be generated on API spec release #29
  • Design parameters file that accompanies spec release
  • Automate creation of new /apimartifacts/apis folder based on templates, released parameters file, and released Open API spec.
  • Ensure revisions can be deployed
  • Ensure publisher is runnable from Kubernetes

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions