Merge pull request #2803 from SDA-SE/feat/remove-api-annotation

feat: remove the backstage.io/definition-at-location annotation
2020-10-08 16:25:31 +02:00
parent 3880e616dc e6b00e3af9
commit c6d1f4846f
6 changed files with 45 additions and 176 deletions
@@ -0,0 +1,26 @@
+---
+'@backstage/plugin-catalog-backend': minor
+---
+
+Remove the backstage.io/definition-at-location annotation.
+The annotation was superseded by the placeholder processor.
+
+```yaml
+apiVersion: backstage.io/v1alpha1
+kind: API
+metadata:
+  name: spotify
+  description: The Spotify web API
+  tags:
+    - spotify
+    - rest
+  annotations:
+    # Don't use this annotation, but the placeholder $text instead (see below).
+    backstage.io/definition-at-location: 'url:https://raw.githubusercontent.com/APIs-guru/openapi-directory/master/APIs/spotify.com/v1/swagger.yaml'
+spec:
+  type: openapi
+  lifecycle: production
+  owner: spotify@example.com
+  definition:
+    $text: https://raw.githubusercontent.com/APIs-guru/openapi-directory/master/APIs/spotify.com/v1/swagger.yaml
+```