Skip to content
This repository was archived by the owner on Dec 8, 2025. It is now read-only.

Commit 49558b0

Browse files
authored
Update README.md
1 parent 869d308 commit 49558b0

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ go install github.com/speakeasy-api/openapi-overlay@latest
4040

4141
# Usage
4242

43-
The tool provides the following sub-commands for working with overlay files. It can also be accessed through Speakeasy CLI command `speakeasy overlay`. Please see [here](https://www.speakeasyapi.dev/docs/speakeasy-cli/overlay/README) for CLI installation and usage documentation.
43+
The tool provides sub-commands such as `apply`, `validate` and `compare` under the `openapi-overlay` command for working with overlay files. The reccomended usage pattern is through Speakeasy CLI command `speakeasy overlay`. Please see [here](https://www.speakeasyapi.dev/docs/speakeasy-cli/overlay/README) for CLI installation and usage documentation.
4444

4545
For more examples of usage, see [here](https://www.speakeasyapi.dev/docs/openapi/overlays)
4646

@@ -49,7 +49,7 @@ For more examples of usage, see [here](https://www.speakeasyapi.dev/docs/openapi
4949
The most obvious use-case for this command is applying an overlay to a specification file.
5050

5151
```sh
52-
openapi-overlay apply overlay.yaml spec.yaml
52+
speakeasy overlay apply --overlay=overlay.yaml --schema=spec.yaml
5353
```
5454

5555
If the overlay file has the `extends` key set to a `file://` URL, then the `spec.yaml` file may be omitted.
@@ -59,18 +59,18 @@ If the overlay file has the `extends` key set to a `file://` URL, then the `spec
5959
A command is provided to perform basic validation of the overlay file itself. It will not tell you whether it will apply correctly or whether the application will generate a valid OpenAPI specification. Rather, it is limited to just telling you when the spec follows the OpenAPI Overlay Specification correctly: all required fields are present and have valid values.
6060

6161
```sh
62-
openapi-overlay validate overlay.yaml
62+
speakeasy overlay validate --overlay=overlay.yaml
6363
```
6464

6565
## Compare
6666

6767
Finally, a tool is provided that will generate an OpenAPI Overlay specification from two input files.
6868

6969
```sh
70-
openapi-overlay compare spec1.yaml spec2.yaml
70+
speakeasy overlay compare --before=spec1.yaml --after=spec2.yaml --out=overlay.yaml
7171
```
7272

73-
The overlay file will be written to stdout.
73+
the overlay file will be written to a file called `overlay.yaml` with a diagnostic output in the console.
7474

7575
# Other Notes
7676

0 commit comments

Comments
 (0)