From 12ba80ff37be8cf2299ae76561987f4bacd5d8be Mon Sep 17 00:00:00 2001
From: Gabriel Dugny <gabriel.dugny@believe.com>
Date: Fri, 3 Jan 2025 14:02:56 +0100
Subject: [PATCH] docs: use a valid configuration as example

Entity can't have spaces in their names.

Signed-off-by: Gabriel Dugny <gabriel.dugny@believe.com>
---
 .changeset/tasty-chairs-beam.md                            | 5 +++++
 plugins/catalog-backend-module-backstage-openapi/README.md | 6 +++---
 2 files changed, 8 insertions(+), 3 deletions(-)
 create mode 100644 .changeset/tasty-chairs-beam.md

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`.