From 81a6dd279a073a8d7fc0da8118ae242c48f5d76b Mon Sep 17 00:00:00 2001 From: colethienes Date: Thu, 5 Oct 2023 11:37:37 +0100 Subject: [PATCH] docs: add documentation for deprecating old API versions --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index de4cdfa8..e17d95fb 100644 --- a/README.md +++ b/README.md @@ -238,3 +238,15 @@ output: A new version of `vervet` will automatically be generated for Github and `npm` when new features are introduced, i.e. when commits are merged that are marked with `feat:`. + +## Deprecating a version +After removing the endpoint version code and specs, you may see this issue: +``` +ENOENT: no such file or directory, open '.../spec.yaml' +``` +To solve this: +1. Temporarily ignore the endpoint version code in `.vervet.yaml` +2. Remove the endpoint versions from `catalog-info.yaml` +3. Remove the old OpenAPI specs. + +[Example PR](https://github.com/snyk/registry/pull/33489/files)