Skip to content

Commit 68eef1d

Browse files
committed
Sync open source content 🐝 (from ce97345fca69dfb1e56e2fd678cf33caee93c2d2)
1 parent 3cd92b5 commit 68eef1d

File tree

5 files changed

+13
-19
lines changed

5 files changed

+13
-19
lines changed

β€Ždocs/sdks/sdk-docs/integrations/_get-public-url-snippet.mdxβ€Ž

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,24 @@ import { Screenshot } from "@/mdx/components";
44

55
### Get the API's combined spec public URL from the registry
66

7-
Navigate to the [Speakeasy Dashboard](https://app.speakeasy.com) and open the **API Registry** overview. Select the relevant API and open the entry labeled with type `Combined Spec`. This is typically at the bottom under "Related Documents".
7+
Navigate to the [Speakeasy Dashboard](https://app.speakeasy.com) and click on the **Docs** tab. Select the **Integrate with a Docs Provider** option.
88

9-
<Screenshot
9+
<Screenshot
1010
variant="web"
1111
image={{
12-
src: '/assets/docs/code-samples/openapi-registry-and-combined-spec.png',
13-
alt: "Screenshot showing the Speakeasy API Registry page"
12+
src: '/assets/docs/code-samples/integrate-with-docs-provider.png',
13+
alt: "Screenshot showing the Speakeasy Dashboard Docs tab with Integrate with a Docs Provider option"
1414
}}
1515
/>
1616

17-
> NOTE: If the entry is not labeled **Combined Spec**, ensure that the API
18-
> has an [automatic code sample
19-
> URL](/docs/sdk-docs/code-samples/automated-code-sample-urls) configured.
17+
On the **Integrate with a Docs Provider** page, select the correct OpenAPI document using the **Change OpenAPI Documents** button. Then, copy the Spec URL.
2018

21-
From the registry entry's page, copy the provided public URL using the "Share" button on the top right.
22-
23-
<Screenshot
19+
<Screenshot
2420
variant="web"
2521
image={{
26-
src: '/assets/docs/code-samples/copy-combined-spec-url.png',
27-
alt: "Screenshot showing the combined spec registry entry with the share function highlighted."
22+
src: '/assets/docs/code-samples/copy-spec-url.png',
23+
alt: "Screenshot showing the Integrate with a Docs Provider page with the Spec URL to copy"
2824
}}
2925
/>
26+
27+
Make sure the **Public** toggle is enabled, so Mintlify can access the OpenAPI document.

β€Ždocs/sdks/sdk-docs/integrations/mintlify.mdxβ€Ž

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Autogenerated code snippets from Speakeasy SDKs can be integrated directly into
1818
variant="web"
1919
url="docs.myapi.com"
2020
image={{
21-
src: "/assets/docs/code-samples/mintlify-with-speakeasy-openapi.png",
21+
src: "/assets/docs/code-samples/mintlify-with-speakeasy-code-snippets.png",
2222
alt: "Speakeasy code snippets with Mintlify.",
2323
}}
2424
/>
@@ -38,8 +38,6 @@ To integrate Mintlify with Speakeasy, you'll need the following:
3838

3939
Add the combined spec URL to **Anchors** or **Tabs** in the `docs.json` configuration file of a Mintlify repository.
4040

41-
**Note:** Mintlify now uses `docs.json` as the primary configuration file. If you're still using the legacy `mint.json` format, follow the [migration guide](https://mintlify.com/docs/settings#upgrading-from-mintjson) to upgrade to `docs.json`.
42-
4341
#### Using docs.json
4442

4543
Add the combined spec URL to **Anchors** by updating the `anchor` field in the `docs.json` file as follows:
@@ -49,10 +47,9 @@ Add the combined spec URL to **Anchors** by updating the `anchor` field in the `
4947
"anchors": [
5048
{
5149
"name": "API Reference",
52-
// !mark
53-
"openapi": "SPEAKEASY_COMBINED_SPEC_URL",
5450
"url": "api-reference",
55-
"icon": "square-terminal"
51+
"icon": "square-terminal",
52+
"openapi": "SPEAKEASY_COMBINED_SPEC_URL"
5653
}
5754
]
5855
}
@@ -66,7 +63,6 @@ Add the combined spec URL to **Tabs** by updating the `tab` field in the `docs.j
6663
{
6764
"name": "API Reference",
6865
"url": "api-reference",
69-
// !mark
7066
"openapi": "SPEAKEASY_COMBINED_SPEC_URL"
7167
}
7268
]
30.1 KB
Loading
41.1 KB
Loading
41.7 KB
Loading

0 commit comments

Comments
Β (0)