paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 27 Packages Projects Releases Wiki Activity

add note about API Base URL in descriptor-format docs page

Browse Source 
Signed-off-by: Claire Peng <clairep@spotify.com>
This commit is contained in:
Claire Peng
2026-04-09 10:52:43 +01:00
parent 17eb8e03e0
commit d4979b5178
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/software-catalog/descriptor-format.md
+6
View File
@@ -937,6 +937,12 @@ API belongs to, e.g. `artist-engagement-portal`. This field is optional.
The definition of the API, based on the format defined by `spec.type`. This
field is required.
**Note:** Be sure to specify the API base URL of your API within the `spec.definition`. If this is not provided, some widgets (such as OpenAPI) will fallback to the base URL of the Backstage instance. Below are some examples of specifying API base URL for different formats:
- [OpenAPI 3.x - use the `server` field](https://swagger.io/docs/specification/v3_0/api-host-and-base-path/#:~:text=All%20API%20endpoints%20are%20relative,.com%2Fv1%2Fusers%20.&text=In%20OpenAPI%203.0%2C%20you%20use,base%20URLs%20for%20your%20API.)
- [OpenAPI 2.0 (Swagger) — use `host`, `basePath`, and `schemes`](https://swagger.io/docs/specification/v2_0/api-host-and-base-path/)
- [AsyncAPI - use the `server` field](https://www.asyncapi.com/docs/concepts/asyncapi-document/structure#servers-field)
## Kind: Group
Describes the following entity kind: