diff --git a/.changeset/tasty-chairs-beam.md b/.changeset/tasty-chairs-beam.md new file mode 100644 index 0000000000..8a64e6fd0e --- /dev/null +++ b/.changeset/tasty-chairs-beam.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-backend-module-backstage-openapi': patch +--- + +docs: Use a valid configuration as example diff --git a/plugins/catalog-backend-module-backstage-openapi/README.md b/plugins/catalog-backend-module-backstage-openapi/README.md index 8df5b5d6c9..c4342d42cf 100644 --- a/plugins/catalog-backend-module-backstage-openapi/README.md +++ b/plugins/catalog-backend-module-backstage-openapi/README.md @@ -26,14 +26,14 @@ catalog: backstageOpenapi: plugins: - catalog - - todo + - events - search entityOverrides: # All optional metadata: - name: 'my name' + name: 'my-name' title: 'my title' spec: - owner: 'my team' + owner: 'my-team' ``` We will attempt to load each plugin's OpenAPI spec hosted at `${pluginRoute}/openapi.json`. These are automatically added if you are using `@backstage/backend-openapi-utils`'s `createValidatedOpenApiRouter`.