From 04907c39c20f8f5ebc2dd306d57c40973580310c Mon Sep 17 00:00:00 2001 From: Aramis Date: Thu, 18 Jan 2024 16:27:49 -0500 Subject: [PATCH] update documentation and add changeset Signed-off-by: Aramis --- .changeset/afraid-numbers-invite.md | 15 +++++++++++++++ .changeset/nine-bulldogs-camp.md | 8 ++++++++ docs/openapi/generate-client.md | 11 ++++------- 3 files changed, 27 insertions(+), 7 deletions(-) create mode 100644 .changeset/afraid-numbers-invite.md create mode 100644 .changeset/nine-bulldogs-camp.md diff --git a/.changeset/afraid-numbers-invite.md b/.changeset/afraid-numbers-invite.md new file mode 100644 index 0000000000..ee81341d3a --- /dev/null +++ b/.changeset/afraid-numbers-invite.md @@ -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 +``` diff --git a/.changeset/nine-bulldogs-camp.md b/.changeset/nine-bulldogs-camp.md new file mode 100644 index 0000000000..f397bb9ab7 --- /dev/null +++ b/.changeset/nine-bulldogs-camp.md @@ -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. diff --git a/docs/openapi/generate-client.md b/docs/openapi/generate-client.md index 4afa7d64d7..f2c7c64574 100644 --- a/docs/openapi/generate-client.md +++ b/docs/openapi/generate-client.md @@ -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.