feat: switch new OpenAPI docs to /api/v2

apify · Jan 14, 2025 · 41e49b1 · 41e49b1
1 parent e4ecdd4
commit 41e49b1
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 50 deletions.
diff --git a/apify-api/scripts/script-requirements.txt b/apify-api/scripts/script-requirements.txt
diff --git a/apify-docs-theme/static/js/custom.js b/apify-docs-theme/static/js/custom.js
@@ -78,8 +78,7 @@ function scrollOpenApiSidebarItemIntoView() {
 function redirectOpenApiDocs() {
     const { hash, pathname, origin } = new URL(window.location.href);
 
-    // TODO change to '/api/v2'
-    if (pathname.replace(/\/$/, '') !== '/api/v2-new') {
+    if (pathname.startsWith('/api/v2') && pathname.startsWith('/api/v2-')) {
         return;
     }
 
@@ -129,5 +128,6 @@ window.addEventListener('load', () => {
 });
 
 window.addEventListener('popstate', () => {
+    setTimeout(() => redirectOpenApiDocs(), 50);
     setTimeout(() => scrollOpenApiSidebarItemIntoView(), 50);
 });
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -132,7 +132,7 @@ module.exports = {
                 specs: [
                     {
                         spec: './apify-api/openapi/openapi.yaml',
-                        route: '/api/v2/',
+                        route: '/api/v2-redoc/',
                     },
                 ],
                 theme: {
@@ -177,7 +177,7 @@ module.exports = {
             {
                 id: 'openapi',
                 path: './sources/api',
-                routeBasePath: 'api/v2-new', // TODO change to `api/v2` once we are ready
+                routeBasePath: 'api/v2',
                 rehypePlugins: [externalLinkProcessor],
                 showLastUpdateAuthor: false,
                 showLastUpdateTime: false,

diff --git a/static/robots.txt b/static/robots.txt
@@ -1,4 +1,5 @@
 User-agent: *
 Sitemap: https://docs.apify.com/sitemap.xml
 Disallow: https://docs.apify.com/api/v2-old
-Disallow: https://docs.apify.com/api/v2-new
+Disallow: https://docs.apify.com/api/v2-redoc
+Disallow: https://docs.apify.com/api/v2