diff --git a/ai/contextual-menu.mdx b/ai/contextual-menu.mdx index 27cd50f70a..550fd15f33 100644 --- a/ai/contextual-menu.mdx +++ b/ai/contextual-menu.mdx @@ -114,8 +114,8 @@ Create custom options in the contextual menu by adding an object to the `options The base URL for the option. - - The query parameters for the option. + + An array of query parameter objects to append to the base URL. diff --git a/es/ai/contextual-menu.mdx b/es/ai/contextual-menu.mdx index 3375bac510..fe1e7c639b 100644 --- a/es/ai/contextual-menu.mdx +++ b/es/ai/contextual-menu.mdx @@ -123,8 +123,8 @@ Crea opciones personalizadas en el menú contextual agregando un objeto al arreg La URL base de la opción. - - Los parámetros de búsqueda de la opción. + + Un array de objetos de parámetros de búsqueda que se añaden a la URL base. diff --git a/es/integrations/sdks/speakeasy.mdx b/es/integrations/sdks/speakeasy.mdx index adb537d4a4..b191860e07 100644 --- a/es/integrations/sdks/speakeasy.mdx +++ b/es/integrations/sdks/speakeasy.mdx @@ -84,3 +84,15 @@ Agrega la URL de la especificación combinada a un Tab actualizando el campo `ta ``` Ahora puedes ver los fragmentos de código generados por Speakeasy en tu documentación de la API e interactuar con ellos en el playground. + +
+ ## Verificar la integración +
+ +Después de volver a desplegar tu documentación, abre cualquier endpoint en tu referencia de API y confirma que los fragmentos de código aparecen en el playground. El conjunto de lenguajes disponibles coincide con los targets de SDK configurados en tu proyecto de Speakeasy. + +Si los fragmentos no aparecen, comprueba lo siguiente: + +- La URL de `openapi` en `docs.json` apunta a la entrada de la especificación combinada `*-with-code-samples`, no al archivo OpenAPI de origen. +- La URL de la especificación combinada es accesible públicamente desde el navegador. +- Tu proyecto de Speakeasy tiene configurada una [URL automatizada de muestras de código](https://www.speakeasy.com/docs/code-samples/automated-code-sample-urls) y al menos un target de SDK habilitado. diff --git a/fr/ai/contextual-menu.mdx b/fr/ai/contextual-menu.mdx index 6c320c94fd..8c67324f39 100644 --- a/fr/ai/contextual-menu.mdx +++ b/fr/ai/contextual-menu.mdx @@ -123,8 +123,8 @@ Créez des options personnalisées dans le menu contextuel en ajoutant un objet L’URL de base de l’option. - - Les paramètres de requête de l’option. + + Un tableau d'objets de paramètres de requête à ajouter à l'URL de base. diff --git a/fr/integrations/sdks/speakeasy.mdx b/fr/integrations/sdks/speakeasy.mdx index 25bd06cbae..33db7020f4 100644 --- a/fr/integrations/sdks/speakeasy.mdx +++ b/fr/integrations/sdks/speakeasy.mdx @@ -84,3 +84,15 @@ Ajoutez l’URL de la spécification combinée à un onglet en mettant à jour l ``` Vous pouvez désormais afficher les extraits de code générés par Speakeasy dans votre documentation d’API et interagir avec eux dans le playground. + +
+ ## Vérifier l'intégration +
+ +Après avoir redéployé votre documentation, ouvrez n'importe quel endpoint dans votre référence d'API et vérifiez que les extraits de code apparaissent dans le playground. L'ensemble des langages disponibles correspond aux cibles SDK configurées dans votre projet Speakeasy. + +Si les extraits n'apparaissent pas, vérifiez que : + +- L'URL `openapi` dans `docs.json` pointe vers l'entrée de spécification combinée `*-with-code-samples`, et non vers le fichier OpenAPI source. +- L'URL de la spécification combinée est accessible publiquement depuis le navigateur. +- Votre projet Speakeasy dispose d'une [URL d'échantillons de code automatisés](https://www.speakeasy.com/docs/code-samples/automated-code-sample-urls) configurée et d'au moins une cible SDK activée. diff --git a/integrations/sdks/speakeasy.mdx b/integrations/sdks/speakeasy.mdx index 9ec1bb44de..5c670341d7 100644 --- a/integrations/sdks/speakeasy.mdx +++ b/integrations/sdks/speakeasy.mdx @@ -76,3 +76,13 @@ Add the combined spec URL to a tab by updating the `tab` field in the `docs.json ``` You can now view Speakeasy-generated code snippets in your API docs and interact with them in the playground. + +## Verify the integration + +After you redeploy your documentation, open any endpoint in your API reference and confirm that language snippets appear in the playground. The set of available languages matches the SDK targets configured in your Speakeasy project. + +If snippets do not appear, check that: + +- The `openapi` URL in `docs.json` points to the `*-with-code-samples` combined spec entry, not the source OpenAPI file. +- The combined spec URL is publicly reachable from the browser. +- Your Speakeasy project has an [automated code sample URL](https://www.speakeasy.com/docs/code-samples/automated-code-sample-urls) configured and at least one SDK target enabled. diff --git a/zh/ai/contextual-menu.mdx b/zh/ai/contextual-menu.mdx index b6f8b35c5a..1922ddab32 100644 --- a/zh/ai/contextual-menu.mdx +++ b/zh/ai/contextual-menu.mdx @@ -117,8 +117,8 @@ import IconsRequired from "/snippets/zh/icons-required.mdx"; 选项的基础 URL。 - - 选项的 query 参数。 + + 要附加到基础 URL 的 query 参数对象数组。 diff --git a/zh/integrations/sdks/speakeasy.mdx b/zh/integrations/sdks/speakeasy.mdx index 41a07ed3dc..eb2d8eb41e 100644 --- a/zh/integrations/sdks/speakeasy.mdx +++ b/zh/integrations/sdks/speakeasy.mdx @@ -84,3 +84,15 @@ boost: 3 ``` 现在，你可以在 API 文档中查看 Speakeasy 生成的代码片段，并在演示区中与它们交互。 + +
+ ## 验证集成 +
+ +重新部署文档后，打开 API 参考中的任一端点，确认在演示区中显示了各语言的代码片段。可用语言的范围与你在 Speakeasy 项目中配置的 SDK 目标一致。 + +如果代码片段未显示，请检查： + +- `docs.json` 中的 `openapi` URL 指向 `*-with-code-samples` 组合规范条目，而不是源 OpenAPI 文件。 +- 组合规范的 URL 可以从浏览器公开访问。 +- 你的 Speakeasy 项目已配置[自动生成的代码示例 URL](https://www.speakeasy.com/docs/code-samples/automated-code-sample-urls)，并至少启用了一个 SDK 目标。