docs: move backstage openapi docs to configuration.md and add install steps
Signed-off-by: Iury Lenon Alves <iuryalves.uk@gmail.com>
This commit is contained in:
@@ -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:
|
||||
|
||||
@@ -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).
|
||||
|
||||
Reference in New Issue
Block a user