feat(all-services): add openapi documentation files to arc-saas services

.github/workflows/main.yaml

@@ -14,15 +14,15 @@ jobs:
 
     strategy:
       # The strategy matrix allows running tests across multiple Node.js versions in parallel.
-      # Here, the workflow will execute the same steps for Node.js versions 20, 22, and 24.
+      # Here, the workflow will execute the same steps for Node.js versions 22 and 24.
       matrix:
-        node-version: [20, 22, 24]
+        node-version: [22, 24]
 
     steps:
       # Step 1: Checkout the repository code from GitHub
       - uses: actions/checkout@v3
 
-      # Step 2: Set up the Node.js version based on the current matrix value (20, 22, or 24)
+      # Step 2: Set up the Node.js version based on the current matrix value (22 or 24)
       - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
@@ -50,4 +50,4 @@ jobs:
     steps:
       # Step 1: Print final success message after all Node.js version tests pass
       - name: Final status
-        run: echo "✅ All tests passed for Node.js 20, 22, and 24"
+        run: echo "✅ All tests passed for Node.js 22 and 24"

.github/workflows/trivy.yml

@@ -22,7 +22,7 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Run Trivy vulnerability scanner in repo mode
-        uses: aquasecurity/trivy-action@0.28.0
+        uses: aquasecurity/trivy-action@57a97c7e7821a5776cebc9bb87c984fa69cba8f1 # v0.35.0
         with:
           scan-type: "fs"
           scan-ref: "${{ github.workspace }}"

package.json

@@ -28,7 +28,10 @@
   ],
   "overrides": {
     "semver": "^7.5.2",
-    "qs": "^6.14.1"
+    "qs": "^6.14.1",
+    "form-data":"4.0.4",
+    "underscore":"1.13.8",
+    "undici":"7.24.0"
   },
   "config": {
     "commitizen": {

packages/custom-sf-changelog/package.json

@@ -22,7 +22,7 @@
   ],
   "author": "Akshat Dubey",
   "engines": {
-    "node": "18 || 20"
+    "node": "22 || 24"
   },
   "license": "ISC",
   "dependencies": {

services/orchestrator-service/openapi.json

@@ -0,0 +1,48 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "@sourceloop/ctrl-plane-orchestrator-service",
+    "version": "1.2.0",
+    "description": "ARC SaaS Orchestrator service.",
+    "contact": {
+      "name": "SourceFuse"
+    }
+  },
+  "paths": {
+    "/ping": {
+      "get": {
+        "x-controller-name": "PingController",
+        "x-operation-name": "ping",
+        "tags": [
+          "PingController"
+        ],
+        "responses": {
+          "200": {
+            "description": "Return value of PingController.ping"
+          }
+        },
+        "operationId": "PingController.ping"
+      }
+    },
+    "/": {
+      "get": {
+        "x-controller-name": "HomePageController",
+        "x-operation-name": "homePage",
+        "tags": [
+          "HomePageController"
+        ],
+        "responses": {
+          "200": {
+            "description": "Return value of HomePageController.homePage"
+          }
+        },
+        "operationId": "HomePageController.homePage"
+      }
+    }
+  },
+  "servers": [
+    {
+      "url": "/"
+    }
+  ]
+}

services/orchestrator-service/openapi.md

@@ -0,0 +1,130 @@
+---
+title: "@sourceloop/ctrl-plane-orchestrator-service v1.2.0"
+language_tabs:
+  - javascript: JavaScript
+  - javascript--nodejs: Node.JS
+language_clients:
+  - javascript: request
+  - javascript--nodejs: ""
+toc_footers: []
+includes: []
+search: true
+highlight_theme: darkula
+headingLevel: 2
+
+---
+
+<!-- Generator: Widdershins v4.0.1 -->
+
+<h1 id="-sourceloop-ctrl-plane-orchestrator-service">@sourceloop/ctrl-plane-orchestrator-service v1.2.0</h1>
+
+> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
+
+ARC SaaS Orchestrator service.
+
+Base URLs:
+
+* <a href="/">/</a>
+
+<h1 id="-sourceloop-ctrl-plane-orchestrator-service-pingcontroller">PingController</h1>
+
+## PingController.ping
+
+<a id="opIdPingController.ping"></a>
+
+> Code samples
+
+```javascript
+
+fetch('/ping',
+{
+  method: 'GET'
+
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+```
+
+```javascript--nodejs
+const fetch = require('node-fetch');
+
+fetch('/ping',
+{
+  method: 'GET'
+
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+```
+
+`GET /ping`
+
+<h3 id="pingcontroller.ping-responses">Responses</h3>
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Return value of PingController.ping|None|
+
+<aside class="success">
+This operation does not require authentication
+</aside>
+
+<h1 id="-sourceloop-ctrl-plane-orchestrator-service-homepagecontroller">HomePageController</h1>
+
+## HomePageController.homePage
+
+<a id="opIdHomePageController.homePage"></a>
+
+> Code samples
+
+```javascript
+
+fetch('/',
+{
+  method: 'GET'
+
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+```
+
+```javascript--nodejs
+const fetch = require('node-fetch');
+
+fetch('/',
+{
+  method: 'GET'
+
+})
+.then(function(res) {
+    return res.json();
+}).then(function(body) {
+    console.log(body);
+});
+
+```
+
+`GET /`
+
+<h3 id="homepagecontroller.homepage-responses">Responses</h3>
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Return value of HomePageController.homePage|None|
+
+<aside class="success">
+This operation does not require authentication
+</aside>
+

services/orchestrator-service/package.json

@@ -18,10 +18,10 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "engines": {
-    "node": ">=20"
+    "node": "22 || 24"
   },
   "scripts": {
-    "build": "lb-tsc",
+    "build": "lb-tsc && npm run openapi-spec && npm run apidocs",
     "build:watch": "lb-tsc --watch",
     "lint": "npm run eslint && npm run prettier:check",
     "lint:fix": "npm run eslint:fix && npm run prettier:fix",
@@ -38,8 +38,9 @@
     "resolve-links": "npm run symlink-resolver build ./node_modules/@local",
     "premigrate": "npm run build",
     "migrate": "node ./dist/migrate",
-    "preopenapi-spec": "npm run build",
+    "preopenapi-spec": "lb-tsc",
     "openapi-spec": "node ./dist/openapi-spec",
+    "apidocs": "npx widdershins --language_tabs 'javascript:JavaScript:request' 'javascript--nodejs:Node.JS' --summary openapi.json -o openapi.md",
     "prestart": "npm run clean && npm run openapi-spec",
     "start": "node -r source-map-support/register .",
     "dev": "nodemon --watch src -e ts --exec \"npm run start\"",

services/orchestrator-service/src/application.ts

@@ -0,0 +1,31 @@
+// Copyright (c) 2023 Sourcefuse Technologies
+//
+// This software is released under the MIT License.
+// https://opensource.org/licenses/MIT
+import {BootMixin} from '@loopback/boot';
+import {ApplicationConfig} from '@loopback/core';
+import {RepositoryMixin} from '@loopback/repository';
+import {RestApplication} from '@loopback/rest';
+import * as path from 'node:path';
+import {OrchestratorServiceComponent} from './component';
+
+export {ApplicationConfig};
+
+export class OrchestratorServiceApplication extends BootMixin(
+  RepositoryMixin(RestApplication),
+) {
+  constructor(options: ApplicationConfig = {}) {
+    super(options);
+    this.static('/', path.join(__dirname, '../public'));
+    this.component(OrchestratorServiceComponent);
+
+    this.projectRoot = __dirname;
+    this.bootOptions = {
+      controllers: {
+        dirs: ['controllers'],
+        extensions: ['.controller.js'],
+        nested: true,
+      },
+    };
+  }
+}

services/orchestrator-service/src/openapi-spec.ts

@@ -0,0 +1,30 @@
+// Copyright (c) 2023 Sourcefuse Technologies
+//
+// This software is released under the MIT License.
+// https://opensource.org/licenses/MIT
+import {ApplicationConfig} from '@loopback/core';
+import {OrchestratorServiceApplication} from './application';
+
+const PORT = 3000;
+const ARGV_INDEX = 2;
+
+/**
+ * Export the OpenAPI spec from the application
+ */
+async function exportOpenApiSpec(): Promise<void> {
+  const config: ApplicationConfig = {
+    rest: {
+      port: +(process.env.PORT ?? PORT),
+      host: process.env.HOST ?? 'localhost',
+    },
+  };
+  const outFile = process.argv[ARGV_INDEX] ?? './openapi.json';
+  const app = new OrchestratorServiceApplication(config);
+  await app.boot();
+  await app.exportOpenApiSpec(outFile);
+}
+
+exportOpenApiSpec().catch(err => {
+  console.error('Fail to export OpenAPI spec from the application.', err); //NOSONAR
+  process.exit(1);
+});