From f75764c7179565b683139c2419bb926460fab396 Mon Sep 17 00:00:00 2001 From: Iury Lenon Alves Date: Mon, 23 Feb 2026 20:37:58 +0000 Subject: [PATCH] docs: move backstage openapi docs to configuration.md and add install steps Signed-off-by: Iury Lenon Alves --- docs/features/software-catalog/configuration.md | 6 ++++++ docs/integrations/index.md | 6 ------ 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/features/software-catalog/configuration.md b/docs/features/software-catalog/configuration.md index 8c9241eb36..140b186137 100644 --- a/docs/features/software-catalog/configuration.md +++ b/docs/features/software-catalog/configuration.md @@ -371,6 +371,12 @@ backend.add(eventsModuleCatalogErrors); The **OpenAPI Catalog Backend Module** registers a JSON Schema placeholder resolver for the `openapi` (and `asyncapi`) placeholder keys. This enables you to use `$openapi` and `$asyncapi` references in your catalog entities, while having all underlying `$ref` pointers resolved and bundled as part of the schema processing. +## Backstage OpenAPI Module + +As Backstage increasingly uses OpenAPI to define its core APIs (such as the Catalog and Scaffolder), discovering and interacting with these APIs is essential for integrating external tools. + +You can install the **Backstage OpenAPI Module** to easily expose the OpenAPI specifications for your Backstage instance plugins directly into the catalog. + ### Installation 1. Add the package to your backend: diff --git a/docs/integrations/index.md b/docs/integrations/index.md index 89f8e044c3..00463a810f 100644 --- a/docs/integrations/index.md +++ b/docs/integrations/index.md @@ -26,9 +26,3 @@ integrations: See documentation for each type of integration for full details on configuration. - -## Backstage OpenAPI Module - -If you want to integrate the OpenAPI specifications from your Backstage instance itself into the catalog, you can use the `catalog-backend-module-backstage-openapi`. This module helps discover and ingest OpenAPI definitions from Backstage plugins. - -For more details, see the [module documentation](https://github.com/backstage/backstage/tree/master/plugins/catalog-backend-module-backstage-openapi).