From 905d1ecbf6a85ef21b89b811e9db783d9578415f Mon Sep 17 00:00:00 2001 From: Mukulika <60316606+Mukulikaa@users.noreply.github.com> Date: Thu, 3 Mar 2022 14:58:17 +0530 Subject: [PATCH] DC-219 Make API endpoints page more visible for Async APIs (#394) * change for exp branch * merge-docs-v1 added for build to workflow * changes for dev and prod dispatch events * Testing changes * DC-219 Make API endpoints page more visible for Async APIs * DC-219 Split Async API page into two pages Co-authored-by: harshad-symbl Co-authored-by: Adam Voliva Co-authored-by: amritesh-singh <88492460+amritesh-singh@users.noreply.github.com> --- docs/async-api/introduction.md | 30 +++++++++++++++++ .../{reference.md => supported-languages.md} | 32 ++----------------- sidebars.js | 6 +--- 3 files changed, 33 insertions(+), 35 deletions(-) rename docs/async-api/reference/{reference.md => supported-languages.md} (62%) diff --git a/docs/async-api/introduction.md b/docs/async-api/introduction.md index 9336d26d..9d82e45d 100644 --- a/docs/async-api/introduction.md +++ b/docs/async-api/introduction.md @@ -69,3 +69,33 @@ It can be useful in any use case where you have access to a video file of any ty * [Submit Video URL](/docs/async-api/overview/video/post-video-url) * [Append Video URL To Existing Conversation](/docs/async-api/overview/video/put-video-url) + + +## Endpoints + +### Text API + +| Method | Endpoint | | +|--------|----------|-| +|`POST` | `https://api.symbl.ai/v1/process/text` | [Reference](/docs/async-api/overview/text/post-text) +|`PUT` | `https://api.symbl.ai/v1/process/text/{conversationId}` | [Reference](/docs/async-api/overview/text/put-text) + + +### Audio API + +| Method | Endpoint | | +|--------|----------|-| +|`POST` | `https://api.symbl.ai/v1/process/audio` | [Reference](/docs/async-api/overview/audio/post-audio) +|`POST` | `https://api.symbl.ai/v1/process/audio/url` | [Reference](/docs/async-api/overview/audio/post-audio-url) +|`PUT` | `https://api.symbl.ai/v1/process/audio/{conversationId}` | [Reference](/docs/async-api/overview/audio/put-audio) +|`PUT` | `https://api.symbl.ai/v1/process/audio/url/{conversationId}` | [Reference](/docs/async-api/overview/audio/put-audio-url) + + +### Video API + +| Method | Endpoint | | +|--------|----------|-| +|`POST` | `https://api.symbl.ai/v1/process/video` | [Reference](/docs/async-api/overview/video/post-video) +|`POST` | `https://api.symbl.ai/v1/process/video/url` | [Reference](/docs/async-api/overview/video/post-video-url) +|`PUT` | `https://api.symbl.ai/v1/process/video/{conversationId}` | [Reference](/docs/async-api/overview/video/put-video) +|`PUT` | `https://api.symbl.ai/v1/process/video/url/{conversationId}` | [Reference](/docs/async-api/overview/video/put-video-url) diff --git a/docs/async-api/reference/reference.md b/docs/async-api/reference/supported-languages.md similarity index 62% rename from docs/async-api/reference/reference.md rename to docs/async-api/reference/supported-languages.md index 5817c1b1..f231164a 100644 --- a/docs/async-api/reference/reference.md +++ b/docs/async-api/reference/supported-languages.md @@ -1,37 +1,9 @@ --- id: reference -title: Async API Reference +title: Supported Languages +sidebar_label: Supported Languages --- -## Endpoints - -### Text API - -| Method | Endpoint | | -|--------|----------|-| -|`POST` | `https://api.symbl.ai/v1/process/text` | [Reference](/docs/async-api/overview/text/post-text) -|`PUT` | `https://api.symbl.ai/v1/process/text/{conversationId}` | [Reference](/docs/async-api/overview/text/put-text) - - -### Audio API - -| Method | Endpoint | | -|--------|----------|-| -|`POST` | `https://api.symbl.ai/v1/process/audio` | [Reference](/docs/async-api/overview/audio/post-audio) -|`POST` | `https://api.symbl.ai/v1/process/audio/url` | [Reference](/docs/async-api/overview/audio/post-audio-url) -|`PUT` | `https://api.symbl.ai/v1/process/audio/{conversationId}` | [Reference](/docs/async-api/overview/audio/put-audio) -|`PUT` | `https://api.symbl.ai/v1/process/audio/url/{conversationId}` | [Reference](/docs/async-api/overview/audio/put-audio-url) - - -### Video API - -| Method | Endpoint | | -|--------|----------|-| -|`POST` | `https://api.symbl.ai/v1/process/video` | [Reference](/docs/async-api/overview/video/post-video) -|`POST` | `https://api.symbl.ai/v1/process/video/url` | [Reference](/docs/async-api/overview/video/post-video-url) -|`PUT` | `https://api.symbl.ai/v1/process/video/{conversationId}` | [Reference](/docs/async-api/overview/video/put-video) -|`PUT` | `https://api.symbl.ai/v1/process/video/url/{conversationId}` | [Reference](/docs/async-api/overview/video/put-video-url) - ## Supported Languages The Async Audio and Async Video APIs can work with languages other than English. diff --git a/sidebars.js b/sidebars.js index 65e4c9e0..0555961a 100644 --- a/sidebars.js +++ b/sidebars.js @@ -248,11 +248,7 @@ items: [ }, { type: 'doc', - id: 'async-api/reference/reference', - customProps: { - hash: '#supported-languages', - label: 'Supported Languages', - }, + id: 'async-api/reference/supported-languages', }, { id: "async-api/overview/jobs-api",