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

Merge pull request #22352 from sennyeya/openapi-tooling/plugin-id

Browse Source 
feat(openapi-tooling): Update template to use `info.title` as plugin ID
This commit is contained in:
Patrik Oldsberg
2024-01-21 18:43:20 +01:00
committed by GitHub
parent 2bc6623498 a1a2ca5b52
commit bb71cccd55
11 changed files with 41 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/openapi/generate-client.md
+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.