docs: Update API examples list to include Museum API (Redocly#2506)

* feat: Update API examples list to include Museum API * updates museum.yaml with logo and replaces petstore with museum api in playground for local dev and some minor edits to redoc name * docs: update definition --------- Co-authored-by: Heather Cloward <[email protected]> Co-authored-by: Alex Varchuk <[email protected]>
maxdgt · Apr 2, 2024 · 3f3f955 · 3f3f955
1 parent 8c39149
commit 3f3f955
Show file tree

Hide file tree

Showing 7 changed files with 862 additions and 71 deletions.
diff --git a/demo/index.html b/demo/index.html
@@ -1,46 +1,63 @@
 <!DOCTYPE html>
 <html>
-
-<head>
-  <meta charset="UTF-8" />
-  <title>ReDoc Interactive Demo</title>
-  <meta name="description" content="ReDoc Interactive Demo. OpenAPI/Swagger-generated API Reference Documentation" />
-  <meta name="viewport" content="width=device-width, initial-scale=1">
-
-  <meta property="og:title" content="ReDoc Interactive Demo">
-  <meta property="og:description" content="ReDoc Interactive Demo. OpenAPI/Swagger-generated API Reference Documentation">
-  <meta property="og:image" content="https://user-images.githubusercontent.com/3975738/37729752-8a9ea38a-2d46-11e8-8438-42ed26bf1751.png">
-  <meta name="twitter:card" content="summary_large_image">
-
-  <style>
-    body {
-      margin: 0;
-      padding: 0;
-    }
-
-    redoc {
-      display: block;
-    }
-  </style>
-  <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
-</head>
-
-<body>
-  <div id="container"> </div>
-
-  <script>
-    (function (i, s, o, g, r, a, m) {
-      i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () {
-        (i[r].q = i[r].q || []).push(arguments)
-      }, i[r].l = 1 * new Date(); a = s.createElement(o),
-        m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m)
-    })(window, document, 'script', 'https://www.google-analytics.com/analytics.js', 'ga');
-
-    if (window.location.host === 'rebilly.github.io') {
-      ga('create', 'UA-81703547-1', 'auto');
-      ga('send', 'pageview');
-    }
-  </script>
-</body>
-
-</html>
+  <head>
+    <meta charset="UTF-8" />
+    <title>Redoc Interactive Demo</title>
+    <meta
+      name="description"
+      content="Redoc Interactive Demo. OpenAPI-generated API Reference Documentation"
+    />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+
+    <meta property="og:title" content="Redoc Interactive Demo" />
+    <meta
+      property="og:description"
+      content="Redoc Interactive Demo. OpenAPI-generated API Reference Documentation"
+    />
+    <meta
+      property="og:image"
+      content="https://user-images.githubusercontent.com/3975738/37729752-8a9ea38a-2d46-11e8-8438-42ed26bf1751.png"
+    />
+    <meta name="twitter:card" content="summary_large_image" />
+
+    <style>
+      body {
+        margin: 0;
+        padding: 0;
+      }
+
+      redoc {
+        display: block;
+      }
+    </style>
+    <link
+      href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700"
+      rel="stylesheet"
+    />
+  </head>
+
+  <body>
+    <div id="container"></div>
+
+    <script>
+      (function (i, s, o, g, r, a, m) {
+        i['GoogleAnalyticsObject'] = r;
+        (i[r] =
+          i[r] ||
+          function () {
+            (i[r].q = i[r].q || []).push(arguments);
+          }),
+          (i[r].l = 1 * new Date());
+        (a = s.createElement(o)), (m = s.getElementsByTagName(o)[0]);
+        a.async = 1;
+        a.src = g;
+        m.parentNode.insertBefore(a, m);
+      })(window, document, 'script', 'https://www.google-analytics.com/analytics.js', 'ga');
+
+      if (window.location.host === 'rebilly.github.io') {
+        ga('create', 'UA-81703547-1', 'auto');
+        ga('send', 'pageview');
+      }
+    </script>
+  </body>
+</html>
diff --git a/demo/index.tsx b/demo/index.tsx
@@ -5,11 +5,12 @@ import { RedocStandalone } from '../src';
 import ComboBox from './ComboBox';
 import FileInput from './components/FileInput';
 
-const DEFAULT_SPEC = 'openapi.yaml';
-const NEW_VERSION_SPEC = 'openapi-3-1.yaml';
+const DEFAULT_SPEC = 'museum.yaml';
+const NEW_VERSION_PETSTORE = 'openapi-3-1.yaml';
 
 const demos = [
-  { value: NEW_VERSION_SPEC, label: 'Petstore OpenAPI 3.1' },
+  { value: DEFAULT_SPEC, label: 'Museum API' },
+  { value: NEW_VERSION_PETSTORE, label: 'Petstore OpenAPI 3.1' },
   { value: 'https://api.apis.guru/v2/specs/instagram.com/1.0.0/swagger.yaml', label: 'Instagram' },
   {
     value: 'https://api.apis.guru/v2/specs/googleapis.com/calendar/v3/openapi.yaml',
@@ -54,7 +55,7 @@ class DemoApp extends React.Component<
   };
 
   handleChange = (url: string) => {
-    if (url === NEW_VERSION_SPEC) {
+    if (url === NEW_VERSION_PETSTORE) {
       this.setState({ cors: false });
       0;
     }

diff --git a/demo/museum-logo.png b/demo/museum-logo.png