You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 8, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ go install github.com/speakeasy-api/openapi-overlay@latest
40
40
41
41
# Usage
42
42
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.
44
44
45
45
For more examples of usage, see [here](https://www.speakeasyapi.dev/docs/openapi/overlays)
46
46
@@ -49,7 +49,7 @@ For more examples of usage, see [here](https://www.speakeasyapi.dev/docs/openapi
49
49
The most obvious use-case for this command is applying an overlay to a specification file.
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
59
59
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.
60
60
61
61
```sh
62
-
openapi-overlay validate overlay.yaml
62
+
speakeasy overlay validate --overlay=overlay.yaml
63
63
```
64
64
65
65
## Compare
66
66
67
67
Finally, a tool is provided that will generate an OpenAPI Overlay specification from two input files.
0 commit comments