Skip to content

Commit 43bd99d

Browse files
committed
Sync open source content 🐝 (from cdaad59f546603080c7e4ccc405ff50402b70fd2)
1 parent 4834ee0 commit 43bd99d

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

docs/prep-openapi/overlays/create-overlays.mdx

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_label: Create Overlays
44
description: "Overlays are a quick and easy way to implement changes to an OpenAPI document. Learn how overlays work and how to use them."
55
---
66

7-
import { Spotlight, Callout } from "@/mdx/components";
7+
import { Callout, Spotlight } from "@/mdx/components";
88

99
# Create overlays
1010

@@ -20,11 +20,11 @@ These customizations apply to an OpenAPI document in a new file, ensuring API sp
2020

2121
Overlays enable various customizations to API specifications. Common scenarios include:
2222

23-
- [Adding Speakeasy extensions](/examples/sdk-generation/overlays/overlays#adding-speakeasy-extensions): Enhance OpenAPI documents with custom Speakeasy extensions for additional functionality or metadata
24-
- [Adding examples to API documentation](/examples/sdk-generation/overlays/overlays#adding-examples-to-api-documentation): Provide clear, concrete examples to clarify API usage
25-
- [Hiding internal APIs from a public SDK](/examples/sdk-generation/overlays/overlays#hiding-internal-apis-from-a-public-sdk): Exclude internal API endpoints from public-facing SDK documentation for security and clarity
23+
- [Adding Speakeasy extensions](/guides/sdks/overlays/overlays#adding-speakeasy-extensions): Enhance OpenAPI documents with custom Speakeasy extensions for additional functionality or metadata
24+
- [Adding examples to API documentation](/guides/sdks/overlays/overlays#adding-examples-to-api-documentation): Provide clear, concrete examples to clarify API usage
25+
- [Hiding internal APIs from a public SDK](/guides/sdks/overlays/overlays#hiding-internal-apis-from-a-public-sdk): Exclude internal API endpoints from public-facing SDK documentation for security and clarity
2626

27-
[View more examples here](/examples/sdk-generation/overlays/overlays).
27+
[View more examples here](/guides/sdks/overlays/overlays).
2828

2929
## Creating an overlay
3030

@@ -39,10 +39,10 @@ speakeasy overlay compare --before=./openapi_original.yaml --after=./openapi.yam
3939
```
4040

4141
<Callout title="Using compare" type="info">
42-
The compare feature helps identify differences across
43-
OpenAPI documents. Precise adjustments may require
44-
manual refinement of the generated overlay file. Validate
45-
and evaluate JSONPath expressions [here](https://jsonpath.com/).
42+
The compare feature helps identify differences across OpenAPI documents.
43+
Precise adjustments may require manual refinement of the generated overlay
44+
file. Validate and evaluate JSONPath expressions
45+
[here](https://jsonpath.com/).
4646
</Callout>
4747

4848
## Anatomy of an overlay
@@ -201,9 +201,17 @@ actions:
201201

202202
## Helpful references:
203203

204-
- [Common overlay examples](/examples/sdk-generation/overlays/overlays)
205-
- [Common JSONPath examples](/examples/sdk-generation/overlays/json-path-expressions)
204+
- [Common overlay examples](/guides/sdks/overlays/overlays)
205+
- [Common JSONPath examples](/guides/sdks/overlays/json-path-expressions)
206206

207207
<Callout title="Try Speakeasy's OpenAPI Overlay Playground" type="info">
208-
For a visual approach to creating or editing overlays, visit <a href="https://overlay.speakeasy.com/" target="_blank" rel="noopener noreferrer">overlay.speakeasy.com</a>.
208+
For a visual approach to creating or editing overlays, visit{" "}
209+
<a
210+
href="https://overlay.speakeasy.com/"
211+
target="_blank"
212+
rel="noopener noreferrer"
213+
>
214+
overlay.speakeasy.com
215+
</a>
216+
.
209217
</Callout>

0 commit comments

Comments
 (0)