From 2715433c80b40fada3bcb6e972bc201706b74f27 Mon Sep 17 00:00:00 2001 From: Iury Lenon Alves Date: Fri, 13 Feb 2026 13:09:44 +0000 Subject: [PATCH] docs(catalog): add mention of openapi backend module for support Signed-off-by: Iury Lenon Alves --- docs/features/software-catalog/index.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/features/software-catalog/index.md b/docs/features/software-catalog/index.md index 53afb5205e..e2ff558404 100644 --- a/docs/features/software-catalog/index.md +++ b/docs/features/software-catalog/index.md @@ -136,6 +136,14 @@ Your Backstage developer portal can be customized by incorporating [existing open source plugins](https://github.com/backstage/backstage/tree/master/plugins), or by [building your own](../../plugins/index.md). +## OpenAPI and $ref Support + +If you are using OpenAPI specifications that are split into multiple files using `$ref`, standard processing might not resolve them correctly. + +To fix this, you should install the **OpenAPI Catalog Backend Module**. This module helps resolve `$ref` pointers in your YAML documents, bundling them into a single specification for the catalog. + +For installation instructions and usage, see the [catalog-backend-module-openapi README](https://github.com/backstage/backstage/tree/master/plugins/catalog-backend-module-openapi). + ## Links - [[Blog post] Backstage Service Catalog released in alpha](https://backstage.io/blog/2020/06/22/backstage-service-catalog-alpha)