[FEEDS-0] Add Feeds v3 to the Swagger UI docs (#2135)

Author: juan-elvir

docs/dist/feeds-v3-note.js

@@ -0,0 +1,30 @@
+// The Feeds v3 spec is generated into openapi/v2/ because v2 is the version of
+// the spec generator, not the Feeds product. Show a note above the spec title
+// so readers aren't misled by the path.
+window.FeedsV3NotePlugin = function () {
+  return {
+    wrapComponents: {
+      info: (Original, system) => (props) => {
+        const React = system.React;
+        const original = React.createElement(Original, props);
+        if (!/\/openapi\/v2\/feeds-/.test(system.specSelectors.url())) {
+          return original;
+        }
+        return React.createElement(
+          'div',
+          null,
+          React.createElement(
+            'div',
+            { className: 'feeds-v3-note' },
+            React.createElement('strong', null, 'Feeds v3 API. '),
+            'This spec lives under ',
+            React.createElement('code', null, 'openapi/v2/'),
+            ' because v2 is the version of the OpenAPI spec, not the Feeds ' +
+              'product version.',
+          ),
+          original,
+        );
+      },
+    },
+  };
+};

docs/dist/index.css

@@ -14,3 +14,13 @@ body {
     margin: 0;
     background: #fafafa;
 }
+
+.feeds-v3-note {
+    margin: 0 0 16px;
+    padding: 10px 14px;
+    border-left: 4px solid #4990e2;
+    background: #eaf3fd;
+    font-family: sans-serif;
+    font-size: 14px;
+    color: #3b4151;
+}

docs/dist/swagger-initializer.js

@@ -21,11 +21,15 @@ window.onload = function () {
         name: 'Moderation v2',
         url: 'https://raw.githubusercontent.com/GetStream/protocol/main/openapi/v2/moderation-serverside-api.yaml',
       },
+      {
+        name: 'Feeds v3',
+        url: 'https://raw.githubusercontent.com/GetStream/protocol/main/openapi/v2/feeds-serverside-api.yaml',
+      },
     ],
     dom_id: '#swagger-ui',
     deepLinking: true,
     presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
-    plugins: [SwaggerUIBundle.plugins.DownloadUrl],
+    plugins: [SwaggerUIBundle.plugins.DownloadUrl, FeedsV3NotePlugin],
     layout: 'StandaloneLayout',
   });
 };

docs/dist/swagger-initializer_feeds_v2.js

@@ -0,0 +1,10 @@
+window.onload = function () {
+  window.ui = SwaggerUIBundle({
+    url: 'https://raw.githubusercontent.com/GetStream/protocol/main/openapi/v2/feeds-serverside-api.yaml',
+    dom_id: '#swagger-ui',
+    deepLinking: true,
+    presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
+    plugins: [SwaggerUIBundle.plugins.DownloadUrl, FeedsV3NotePlugin],
+    layout: 'StandaloneLayout',
+  });
+};

docs/feeds_v2_openapi.html

@@ -0,0 +1,35 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>Swagger UI</title>
+    <link rel="stylesheet" type="text/css" href="dist/swagger-ui.css" />
+    <link rel="stylesheet" type="text/css" href="dist/index.css" />
+    <link
+      data-react-helmet="true"
+      rel="icon"
+      type="image/png"
+      sizes="32x32"
+      href="dist/favicon-32x32.png"
+    />
+    <link
+      data-react-helmet="true"
+      rel="icon"
+      type="image/png"
+      sizes="96x96"
+      href="dist/favicon-96x96.png"
+    />
+  </head>
+
+  <body>
+    <div id="swagger-ui"></div>
+    <script src="dist/swagger-ui-bundle.js" charset="UTF-8"></script>
+    <script src="dist/swagger-ui-standalone-preset.js" charset="UTF-8"></script>
+    <script src="dist/feeds-v3-note.js" charset="UTF-8"></script>
+    <script
+      src="dist/swagger-initializer_feeds_v2.js"
+      charset="UTF-8"
+    ></script>
+  </body>
+</html>

docs/index.html

@@ -14,6 +14,7 @@
     <div id="swagger-ui"></div>
     <script src="dist/swagger-ui-bundle.js" charset="UTF-8"> </script>
     <script src="dist/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
+    <script src="dist/feeds-v3-note.js" charset="UTF-8"> </script>
     <script src="dist/swagger-initializer.js" charset="UTF-8"> </script>
   </body>
 </html>