try to fix CI and remove index page with a redirect

Author: B4nan

.github/workflows/docs.yaml

@@ -18,16 +18,20 @@ jobs:
 
         steps:
             -   uses: actions/checkout@v4
-            -   name: Use Node.js 20
+            -   name: Use Node.js 22
                 uses: actions/setup-node@v4
                 with:
-                    node-version: 20
+                    node-version: 22
                     cache: 'npm'
                     cache-dependency-path: 'package-lock.json'
                     always-auth: 'true'
                     registry-url: 'https://npm.pkg.github.com/'
                     scope: '@apify-packages'
 
+            - name: Enable corepack
+              run: |
+                  corepack enable
+
             -   name: Build docs
                 run: |
                     npm ci --force

docusaurus.config.js

@@ -164,7 +164,7 @@ module.exports = {
             {
                 id: 'openapi',
                 path: './sources/api',
-                routeBasePath: 'api/v2-new',
+                routeBasePath: 'api/v2-new', // TODO change to `api/v2` once we are ready
                 rehypePlugins: [externalLinkProcessor],
                 showLastUpdateAuthor: false,
                 showLastUpdateTime: false,
@@ -209,18 +209,22 @@ module.exports = {
             },
         }),
         // TODO this should be somehow computed from all the external sources
-        // [
-        //     '@docusaurus/plugin-client-redirects',
-        //     {
-        //         createRedirects(existingPath) {
-        //             if (!existingPath.endsWith('/')) {
-        //                 return `${existingPath}/`;
-        //             }
-        //
-        //             return undefined; // Return a falsy value: no redirect created
-        //         },
-        //     },
-        // ],
+        [
+            '@docusaurus/plugin-client-redirects',
+            {
+                createRedirects(existingPath) {
+                    // TODO change to `api/v2` once we are ready
+                    if (existingPath.endsWith('api/v2-new')) {
+                        return `${existingPath}/api/v2-new/apify-api`;
+                    }
+                    // if (!existingPath.endsWith('/')) {
+                    //     return `${existingPath}/`;
+                    // }
+
+                    return undefined; // Return a falsy value: no redirect created
+                },
+            },
+        ],
         ...config.plugins,
     ],
     markdown: {

sources/api/sidebars.js

@@ -2,14 +2,14 @@ module.exports = {
     api: [
         {
             type: 'category',
-            label: 'Petstore',
-            link: {
-                type: 'generated-index',
-                title: 'Petstore API',
-                description:
-                    'This is a sample server Petstore server. You can find out more about Swagger at http://swagger.io or on irc.freenode.net, #swagger. For this sample, you can use the api key special-key to test the authorization filters.',
-                slug: '/category/petstore-api',
-            },
+            label: 'API reference',
+            // link: {
+            //     type: 'generated-index',
+            //     title: 'API reference',
+            //     description:
+            //         'This is a sample server Petstore server. You can find out more about Swagger at http://swagger.io or on irc.freenode.net, #swagger. For this sample, you can use the api key special-key to test the authorization filters.',
+            //     slug: '/category/petstore-api',
+            // },
             // eslint-disable-next-line global-require
             items: require('./sidebar.ts'),
         },

sources/api/webhook-dispatch-get.api.mdx

@@ -31,7 +31,7 @@ import Heading from "@theme/Heading";
   path={"/v2/webhook-dispatches/{dispatchId}"}
   context={"endpoint"}
 >
-  
+
 </MethodEndpoint>
 
 
@@ -47,25 +47,24 @@ import Heading from "@theme/Heading";
 </Heading>
 
 <ParamsDetails
-  parameters={[{"name":"dispatchId","in":"path","description":"Webhook dispacth ID.","required":true,"style":"simple","schema":{"type":"string","example":"Zib4xbZsmvZeK55ua"}}]}
+  parameters={[{"name":"dispatchId","in":"path","description":"Webhook dispatch ID.","required":true,"style":"simple","schema":{"type":"string","example":"Zib4xbZsmvZeK55ua"}}]}
 >
-  
+
 </ParamsDetails>
 
 <RequestSchema
   title={"Body"}
   body={undefined}
 >
-  
+
 </RequestSchema>
 
 <StatusCodes
   id={undefined}
   label={undefined}
   responses={{"200":{"description":"","headers":{},"content":{"application/json":{"schema":{"title":"GetWebhookDispatchResponse","required":["data"],"type":"object","properties":{"data":{"title":"WebhookDispatch","required":["id","userId","webhookId","createdAt","status","eventType","eventData"],"type":"object","properties":{"id":{"type":"string","example":"asdLZtadYvn4mBZmm"},"userId":{"type":"string","example":"wRsJZtadYvn4mBZmm"},"webhookId":{"type":"string","example":"asdLZtadYvn4mBZmm"},"createdAt":{"type":"string","example":"2019-12-12T07:34:14.202Z"},"status":{"type":"string","example":"SUCCEEDED"},"eventType":{"type":"string","example":"ACTOR.RUN.SUCCEEDED"},"eventData":{"title":"eventData","type":"object","required":["actorId","actorRunId"],"properties":{"actorId":{"type":"string","example":"vvE7iMKuMc5qTHHsR"},"actorRunId":{"type":"string","example":"JgwXN9BdwxGcu9MMF"}}},"calls":{"title":"calls","type":"object","properties":{"startedAt":{"type":"string","nullable":true,"example":"2019-12-12T07:34:14.202Z"},"finishedAt":{"type":"string","nullable":true,"example":"2019-12-12T07:34:14.202Z"},"errorMessage":{"type":"string","nullable":true,"example":"Cannot send request"},"responseStatus":{"type":"number","nullable":true,"example":200},"responseBody":{"type":"string","nullable":true,"example":{"foo":"bar"}}}}}}}}}}}}}
 >
-  
+
 </StatusCodes>
 
 
-