fix more documentation and workflows
Signed-off-by: Aramis <sennyeyaramis@gmail.com>
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
'@backstage/repo-tools': minor
|
||||
---
|
||||
|
||||
Renames the `schema openapi *` commands into `package schema openapi *` and `repo schema openapi *`. The aim is to make it more clear what the command is operating on, the entire repo or just a single package.
|
||||
**BREAKING**: The `schema openapi *` commands are now renamed into `package schema openapi *` and `repo schema openapi *`. The aim is to make it more clear what the command is operating on, the entire repo or just a single package.
|
||||
|
||||
The following commands now live under the `package` namespace,
|
||||
|
||||
|
||||
@@ -113,10 +113,10 @@ jobs:
|
||||
run: yarn backstage-repo-tools generate-catalog-info --ci
|
||||
|
||||
- name: lint openapi yaml files
|
||||
run: yarn backstage-repo-tools schema openapi lint
|
||||
run: yarn backstage-repo-tools repo schema openapi lint
|
||||
|
||||
- name: verify openapi yaml file matches generated ts file
|
||||
run: yarn backstage-repo-tools schema openapi verify
|
||||
run: yarn backstage-repo-tools repo schema openapi verify
|
||||
|
||||
- name: verify doc links
|
||||
run: node scripts/verify-links.js
|
||||
@@ -225,7 +225,7 @@ jobs:
|
||||
|
||||
# We run the test cases before verifying the specs to prevent any failing tests from causing errors.
|
||||
- name: verify openapi specs against test cases
|
||||
run: yarn backstage-repo-tools schema openapi test
|
||||
run: yarn backstage-repo-tools repo schema openapi test
|
||||
|
||||
- name: ensure clean working directory
|
||||
run: |
|
||||
|
||||
@@ -4,7 +4,7 @@ title: Generate a client from your OpenAPI spec
|
||||
description: Documentation on how to create a client for a given OpenAPI spec
|
||||
---
|
||||
|
||||
## How to generate a client with `repo-tools schema openapi generate-client`?
|
||||
## How to generate a client with `repo-tools package schema openapi generate client`?
|
||||
|
||||
### Prerequisites
|
||||
|
||||
@@ -20,7 +20,7 @@ info:
|
||||
|
||||
### Generating your client
|
||||
|
||||
1. Run `yarn backstage-repo-tools schema openapi generate-client --input-spec <file> --output-directory <directory>`. This will create a new folder in `<directory>/src/generated` to house the generated content.
|
||||
1. Run `yarn backstage-repo-tools schema openapi generate client --output-package <directory>`. This will create a new folder in `<directory>/src/generated` to house the generated content.
|
||||
2. You should use the generated files as follows,
|
||||
|
||||
- `apis/DefaultApi.client.ts` - this is the client that you should use. It has types for all of the various operations on your API.
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
---
|
||||
id: test-case-validation
|
||||
title: Validate your OpenAPI spec against test data
|
||||
description: Documentation on how to use the `schema openapi test` command.
|
||||
description: Documentation on how to use the `repo schema openapi test` command.
|
||||
---
|
||||
|
||||
## OpenAPI Validation using Test Cases
|
||||
|
||||
This is primarily performed by `backstage-repo-tools schema openapi test`. Any errors found in the generated specs can be either
|
||||
This is primarily performed by `backstage-repo-tools repo schema openapi test`. Any errors found in the generated specs can be either
|
||||
|
||||
1. Fixed manually, this is usually relevant for request body or response body changes.
|
||||
2. Fixed automatically with `backstage-repo-tools schema openapi test --update`.
|
||||
2. Fixed automatically with `backstage-repo-tools repo schema openapi test --update`.
|
||||
3. Fixing the test case. This can happen where a response is mocked as
|
||||
|
||||
```ts
|
||||
|
||||
@@ -15,7 +15,8 @@ Commands:
|
||||
api-reports [options] [paths...]
|
||||
type-deps
|
||||
generate-catalog-info [options]
|
||||
schema [command]
|
||||
package [command]
|
||||
repo [command]
|
||||
help [command]
|
||||
```
|
||||
|
||||
@@ -48,10 +49,23 @@ Options:
|
||||
-h, --help
|
||||
```
|
||||
|
||||
### `backstage-repo-tools schema`
|
||||
### `backstage-repo-tools package`
|
||||
|
||||
```
|
||||
Usage: backstage-repo-tools schema [options] [command] [command]
|
||||
Usage: backstage-repo-tools package [options] [command] [command]
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
|
||||
Commands:
|
||||
schema [command]
|
||||
help [command]
|
||||
```
|
||||
|
||||
### `backstage-repo-tools package schema`
|
||||
|
||||
```
|
||||
Usage: backstage-repo-tools package schema [options] [command] [command]
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
@@ -61,65 +75,127 @@ Commands:
|
||||
help [command]
|
||||
```
|
||||
|
||||
### `backstage-repo-tools schema openapi`
|
||||
### `backstage-repo-tools package schema openapi`
|
||||
|
||||
```
|
||||
Usage: backstage-repo-tools schema openapi [options] [command] [command]
|
||||
Usage: backstage-repo-tools package schema openapi [options] [command] [command]
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
|
||||
Commands:
|
||||
init
|
||||
generate [command]
|
||||
help [command]
|
||||
```
|
||||
|
||||
### `backstage-repo-tools package schema openapi generate`
|
||||
|
||||
```
|
||||
Usage: backstage-repo-tools package schema openapi generate [options] [command] [command]
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
|
||||
Commands:
|
||||
server
|
||||
client [options]
|
||||
help [command]
|
||||
```
|
||||
|
||||
### `backstage-repo-tools package schema openapi generate client`
|
||||
|
||||
```
|
||||
Usage: backstage-repo-tools package schema openapi generate client [options]
|
||||
|
||||
Options:
|
||||
--output-package <pathToPackage>
|
||||
-h, --help
|
||||
```
|
||||
|
||||
### `backstage-repo-tools package schema openapi generate server`
|
||||
|
||||
```
|
||||
Usage: backstage-repo-tools package schema openapi generate server [options]
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
```
|
||||
|
||||
### `backstage-repo-tools package schema openapi init`
|
||||
|
||||
```
|
||||
Usage: backstage-repo-tools package schema openapi init [options]
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
```
|
||||
|
||||
### `backstage-repo-tools repo`
|
||||
|
||||
```
|
||||
Usage: backstage-repo-tools repo [options] [command] [command]
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
|
||||
Commands:
|
||||
schema [command]
|
||||
help [command]
|
||||
```
|
||||
|
||||
### `backstage-repo-tools repo schema`
|
||||
|
||||
```
|
||||
Usage: backstage-repo-tools repo schema [options] [command] [command]
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
|
||||
Commands:
|
||||
openapi [command]
|
||||
help [command]
|
||||
```
|
||||
|
||||
### `backstage-repo-tools repo schema openapi`
|
||||
|
||||
```
|
||||
Usage: backstage-repo-tools repo schema openapi [options] [command] [command]
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
|
||||
Commands:
|
||||
verify [paths...]
|
||||
generate [paths...]
|
||||
lint [options] [paths...]
|
||||
test [options] [paths...]
|
||||
init <paths...>
|
||||
help [command]
|
||||
```
|
||||
|
||||
### `backstage-repo-tools schema openapi generate`
|
||||
### `backstage-repo-tools repo schema openapi lint`
|
||||
|
||||
```
|
||||
Usage: backstage-repo-tools schema openapi generate [options] [paths...]
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
```
|
||||
|
||||
### `backstage-repo-tools schema openapi init`
|
||||
|
||||
```
|
||||
Usage: backstage-repo-tools schema openapi init [options] <paths...>
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
```
|
||||
|
||||
### `backstage-repo-tools schema openapi lint`
|
||||
|
||||
```
|
||||
Usage: backstage-repo-tools schema openapi lint [options] [paths...]
|
||||
Usage: backstage-repo-tools repo schema openapi lint [options] [paths...]
|
||||
|
||||
Options:
|
||||
--strict
|
||||
-h, --help
|
||||
```
|
||||
|
||||
### `backstage-repo-tools schema openapi test`
|
||||
### `backstage-repo-tools repo schema openapi test`
|
||||
|
||||
```
|
||||
Usage: backstage-repo-tools schema openapi test [options] [paths...]
|
||||
Usage: backstage-repo-tools repo schema openapi test [options] [paths...]
|
||||
|
||||
Options:
|
||||
--update
|
||||
-h, --help
|
||||
```
|
||||
|
||||
### `backstage-repo-tools schema openapi verify`
|
||||
### `backstage-repo-tools repo schema openapi verify`
|
||||
|
||||
```
|
||||
Usage: backstage-repo-tools schema openapi verify [options] [paths...]
|
||||
Usage: backstage-repo-tools repo schema openapi verify [options] [paths...]
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
|
||||
Reference in New Issue
Block a user