Skip to content

Use the injected REST API docs instead of redirecting to the playgound app #379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MustafaJafar merged 7 commits into from
Aug 12, 2025
Merged

Use the injected REST API docs instead of redirecting to the playgound app #379

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0058ac6
Use `/api` instead of `https://playground.ayon.app/doc/api`
MustafaJafar Jul 17, 2025
e8169f9
Merge branch 'main' into 378-use-the-injected-rest-api-docs-instead-o…
MustafaJafar Jul 23, 2025
025d9a1
Merge branch 'main' into 378-use-the-injected-rest-api-docs-instead-o…
MustafaJafar Jul 23, 2025
b6170ea
Merge branch 'main' into 378-use-the-injected-rest-api-docs-instead-o…
MustafaJafar Jul 24, 2025
83e2c60
Merge branch 'main' into 378-use-the-injected-rest-api-docs-instead-o…
MustafaJafar Jul 24, 2025
fbed00e
Merge branch 'main' into 378-use-the-injected-rest-api-docs-instead-o…
MustafaJafar Aug 11, 2025
0777873
Merge branch 'main' into 378-use-the-injected-rest-api-docs-instead-o…
antirotor Aug 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/docs/dev_api_rest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ You access the REST API Docs via `<your-ayon-server-url>/api` or via help icon.

![](assets/apis_and_resources/rest_api_docs.png)

For instance, you can check the REST API Docs for our Public AYON Server here at [AYON REST API Docs](https://playground.ayon.app/doc/api).
For instance, you can check the REST API Docs for our Public AYON Server here at [AYON REST API Docs](/api).

## Your First AYON API Calls

Expand Down
9 changes: 6 additions & 3 deletions website/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,7 @@ const config = {
items: [
{
label: "REST API Docs",
href: "https://playground.ayon.app/doc/api",
target: "_blank",
rel: null,
to: "/api",
},
{
label: "GraphQL API Explorer",
Expand Down Expand Up @@ -453,6 +451,11 @@ const config = {
rel: null,
position: "left",
},
{
label: "REST API Docs",
position: "right",
to: "/api",
},
{
label: "Addons",
position: "right",
Expand Down