docs: use a valid configuration as example

Entity can't have spaces in their names.

Signed-off-by: Gabriel Dugny <gabriel.dugny@believe.com>
This commit is contained in:
Gabriel Dugny
2025-01-03 14:02:56 +01:00
parent 55a85fcf5c
commit 12ba80ff37
2 changed files with 8 additions and 3 deletions
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog-backend-module-backstage-openapi': patch
---
docs: Use a valid configuration as example
@@ -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`.