diff --git a/.changeset/fresh-lions-compete.md b/.changeset/fresh-lions-compete.md new file mode 100644 index 0000000000..906ed37665 --- /dev/null +++ b/.changeset/fresh-lions-compete.md @@ -0,0 +1,5 @@ +--- +'@backstage/cli': minor +--- + +Adding two new commands to support OpenAPI spec writing, `schema:openapi:generate` to generate the Typescript file that `@backstage/backend-openapi-utils` needs for typing and `schema:openapi:verify` to verify that this file exists and matches your `openapi.yaml` file. diff --git a/packages/cli/cli-report.md b/packages/cli/cli-report.md index bad849d283..998f2f3665 100644 --- a/packages/cli/cli-report.md +++ b/packages/cli/cli-report.md @@ -209,6 +209,8 @@ Commands: clean prepack postpack + schema:openapi:verify + schema:openapi:generate help [command] ``` @@ -265,6 +267,24 @@ Options: -h, --help ``` +### `backstage-cli package schema:openapi:generate` + +``` +Usage: backstage-cli package schema:openapi:generate [options] + +Options: + -h, --help +``` + +### `backstage-cli package schema:openapi:verify` + +``` +Usage: backstage-cli package schema:openapi:verify [options] + +Options: + -h, --help +``` + ### `backstage-cli package start` ``` @@ -403,6 +423,7 @@ Commands: lint [options] clean list-deprecations [options] + schema:openapi:verify test [options] help [command] ``` @@ -449,6 +470,15 @@ Options: -h, --help ``` +### `backstage-cli repo schema:openapi:verify` + +``` +Usage: backstage-cli repo schema:openapi:verify [options] + +Options: + -h, --help +``` + ### `backstage-cli repo test` ```