@platformatic/service 1.13.6 → 1.14.0

package/lib/root-endpoint/public/index.html

@@ -10,7 +10,8 @@
       body {
         width: 100%;
         height: 100vh;
-        overflow-y: hidden;
+        overflow-y: auto;
+        overflow-x: hidden;
         --text-color: #FFFFFF;
         --bg-color: #001825;
         --theme-img: url('./images/light_mode.svg')
@@ -76,15 +77,24 @@
         display: flex;
         column-gap: 3rem;
         justify-content: center;
-        align-items: center;
+        align-items: start;
         margin: 2rem 0;
       }
 
+      .buttons-list-container {
+        display: flex;
+        flex-direction: column;
+        row-gap: 1rem;
+        justify-content: center;
+        align-items: start;
+      }
+
       .button-link {
         width: 250px;
         border: 1px solid var(--text-color);
         border-radius: 2px;
-      } 
+        padding: 2px 6px;
+      }
 
       button {
         border-radius: 8px;
@@ -203,7 +213,7 @@
         <h2 class="text-center">Explore our flexible toolkit for building robust APIs.</h2>
         <div class="button-container">
           <a href="https://docs.platformatic.dev" target="_blank" class="button-link">Documentation</a>
-          <a id="openapi-link" target="_blank" class="button-link">OpenAPI Documentation</a>
+          <div class="open-documentation-version buttons-list-container">&nbsp;</div>
           <a id="graphql-link" target="_blank" class="button-link">GraphiQL</a>
         </div>
       </div>
@@ -212,9 +222,6 @@
     <script>
       const currentPath = window.location.pathname
     
-      const openApiLink = document.getElementById('openapi-link')
-      openApiLink.href = currentPath + 'documentation/static/index.html'
-
       const graphqlLink = document.getElementById('graphql-link')
       graphqlLink.href = currentPath + 'graphiql'
 
@@ -235,6 +242,27 @@
           document.getElementById('logo').src = 'images/platformatic-logo-dark.svg'
         }
       }
+
+      function join (...paths) {
+        return paths.join('/').replace(/\/+/g, '/')
+      }
+
+      fetch('/_platformatic_versions')
+        .then(response => response.json())
+        .then(versions => {
+          const sharedOpenapiHref = join(currentPath, 'documentation/static/index.html')
+          const openapiButtons = [
+            `<a href="${sharedOpenapiHref}"target="_blank" class="button-link">OpenAPI Documentation</a>`
+          ]
+
+          for (const version of versions) {
+            const href = join(currentPath, version.prefix, 'documentation/static/index.html')
+            openapiButtons.push(`<a href="${href}"target="_blank" class="button-link">OpenAPI Documentation ${version.name}</a>`)
+          }
+
+          const buttonList = document.getElementsByClassName('open-documentation-version')[0]
+          buttonList.innerHTML = openapiButtons.join('')
+        })
     </script>
   </body>
 </html>

package/lib/schema.js

@@ -3,7 +3,6 @@
 'use strict'
 
 const pkg = require('../package.json')
-const version = 'v' + pkg.version
 const openApiDefs = require('./openapi-schema-defs')
 const telemetry = require('@platformatic/telemetry').schema
 
@@ -419,7 +418,6 @@ const watch = {
 }
 
 const plugins = {
-  $id: '#plugins',
   type: 'object',
   properties: {
     packages: {
@@ -642,16 +640,22 @@ const openapi = {
   }]
 }
 
+const graphqlBase = {
+  type: 'object',
+  properties: {
+    graphiql: {
+      type: 'boolean'
+    }
+  },
+  additionalProperties: false
+}
+
 const graphql = {
   anyOf: [{
-    type: 'boolean'
+    ...graphqlBase,
+    additionalProperties: false
   }, {
-    type: 'object',
-    properties: {
-      graphiql: {
-        type: 'boolean'
-      }
-    }
+    type: 'boolean'
   }]
 }
 
@@ -695,8 +699,49 @@ const clients = {
   }
 }
 
+const version = {
+  type: 'object',
+  properties: {
+    version: { type: 'string' },
+    openapi: {
+      type: 'object',
+      properties: {
+        prefix: {
+          type: 'string'
+        },
+        path: {
+          type: 'string',
+          resolvePath: true
+        }
+      },
+      additionalProperties: false
+    },
+    plugins
+  },
+  required: ['version'],
+  additionalProperties: false
+}
+
+const versions = {
+  type: 'object',
+  properties: {
+    dir: {
+      type: 'string',
+      description: 'The path to the directory containing the versions mappers',
+      resolvePath: true,
+      default: 'versions'
+    },
+    configs: {
+      type: 'array',
+      items: version
+    }
+  },
+  required: ['dir', 'configs'],
+  additionalProperties: false
+}
+
 const platformaticServiceSchema = {
-  $id: `https://platformatic.dev/schemas/${version}/service`,
+  $id: `https://platformatic.dev/schemas/v${pkg.version}/service`,
   title: 'Platformatic Service',
   type: 'object',
   properties: {
@@ -715,7 +760,8 @@ const platformaticServiceSchema = {
       type: 'string'
     },
     service,
-    clients
+    clients,
+    versions
   },
   additionalProperties: false,
   $defs: openApiDefs
@@ -729,6 +775,7 @@ module.exports.plugins = plugins
 module.exports.watch = watch
 module.exports.openApiDefs = openApiDefs
 module.exports.openApiBase = openApiBase
+module.exports.graphqlBase = graphqlBase
 module.exports.clients = clients
 
 if (require.main === module) {

package/lib/start.js

@@ -58,7 +58,9 @@ async function buildServer (options, app) {
     root.decorate('platformatic', { configManager, config })
     await root.register(app)
     if (!root.hasRoute({ url: '/', method: 'GET' })) {
-      await root.register(require('./root-endpoint'))
+      await root.register(require('./root-endpoint'), {
+        versions: config.versions
+      })
     }
 
     root.decorate('url', {