update documentation and add changeset

Signed-off-by: Aramis <sennyeyaramis@gmail.com>
This commit is contained in:
Aramis
2024-01-18 16:27:49 -05:00
parent 324b970209
commit 04907c39c2
3 changed files with 27 additions and 7 deletions
+15
View File
@@ -0,0 +1,15 @@
---
'@backstage/repo-tools': minor
---
Updates the OpenAPI client template to support the new format for identifying plugin ID. You should now use `info.title` like so,
```diff
info:
+ title: yourPluginId
- title: @internal/plugin-*-backend
servers:
- /
- - yourPluginId
```
+8
View File
@@ -0,0 +1,8 @@
---
'@backstage/catalog-client': minor
'@backstage/plugin-catalog-backend': minor
'@backstage/plugin-search-backend': minor
'@backstage/plugin-todo-backend': minor
---
Updates the OpenAPI specification title to plugin ID instead of package name.
+4 -7
View File
@@ -8,15 +8,12 @@ description: Documentation on how to create a client for a given OpenAPI spec
### Prerequisites
1. Add your plugin ID as the last `servers` item, like this,
1. Set your OpenAPI file's `info.title` to your pluginID like so,
```yaml
servers:
# first value, used for OpenAPI router validation.
- url: /
# final value, pluginId.
- url: catalog
info:
# your pluginId
title: catalog
```
2. Find or create a new plugin to house your new generated client. Currently, we do not support generating an entirely new plugin and instead just generate client files.