Refactor OpenAPI schema references to use unified OASInput; remove deprecated input schemas in ToolsService

Author: pasibun

api/openapi.yaml

@@ -94,7 +94,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/CreateBrunoCollectionInput"
+              $ref: "#/components/schemas/OASInput"
       responses:
         "200":
           description: OK
@@ -124,7 +124,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/ConvertOASInput"
+              $ref: "#/components/schemas/OASInput"
       responses:
         "200":
           description: OK
@@ -154,7 +154,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/DereferenceOASInput"
+              $ref: "#/components/schemas/OASInput"
       responses:
         "200":
           description: OK
@@ -184,7 +184,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/GenerateOASInput"
+              $ref: "#/components/schemas/OASInput"
       responses:
         "200":
           description: OK
@@ -214,7 +214,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/ValidatorOpenAPIPostInput"
+              $ref: "#/components/schemas/OASInput"
       responses:
         "200":
           content:
@@ -248,7 +248,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/CreatePostmanCollectionInput"
+              $ref: "#/components/schemas/OASInput"
       responses:
         "200":
           description: OK
@@ -295,47 +295,7 @@ components:
         arazzoUrl:
           type: string
       type: object
-    ConvertOASInput:
-      example:
-        oasUrl: oasUrl
-        oasBody: oasBody
-      properties:
-        oasBody:
-          type: string
-        oasUrl:
-          type: string
-      type: object
-    CreateBrunoCollectionInput:
-      example:
-        oasUrl: oasUrl
-        oasBody: oasBody
-      properties:
-        oasBody:
-          type: string
-        oasUrl:
-          type: string
-      type: object
-    CreatePostmanCollectionInput:
-      example:
-        oasUrl: oasUrl
-        oasBody: oasBody
-      properties:
-        oasBody:
-          type: string
-        oasUrl:
-          type: string
-      type: object
-    DereferenceOASInput:
-      example:
-        oasUrl: oasUrl
-        oasBody: oasBody
-      properties:
-        oasBody:
-          type: string
-        oasUrl:
-          type: string
-      type: object
-    GenerateOASInput:
+    OASInput:
       example:
         oasUrl: oasUrl
         oasBody: oasBody
@@ -471,16 +431,6 @@ components:
         email:
           type: string
       type: object
-    ValidatorOpenAPIPostInput:
-      example:
-        oasUrl: oasUrl
-        oasBody: oasBody
-      properties:
-        oasBody:
-          type: string
-        oasUrl:
-          type: string
-      type: object
   securitySchemes:
     apiKey:
       in: header

expressServer.js

@@ -1,4 +1,3 @@
-// const { Middleware } = require('swagger-express-middleware');
 const http = require('node:http');
 const fs = require('node:fs');
 const path = require('node:path');
@@ -72,7 +71,7 @@ class ExpressServer {
       const pathItem = schema.paths[pathKey];
       for (const method of methods) {
         const operation = pathItem[method];
-        if (operation?.operationId) {
+        if (operation && operation.operationId) {
           const normalizedId = ExpressServer.sanitizeOperationId(operation.operationId);
           if (normalizedId && normalizedId !== operation.operationId) {
             operation['x-original-operationId'] = operation.operationId;
@@ -88,7 +87,7 @@ class ExpressServer {
     this.app = express();
     try {
       this.schema = jsYaml.safeLoad(fs.readFileSync(openApiYaml));
-      if (this.schema?.components) {
+      if (this.schema && this.schema?.components) {
         const { components } = this.schema;
         const componentMirrors = [
           'schemas',

services/ToolsService.js

@@ -31,10 +31,10 @@ const arazzo = async (params) => {
  * Converteer OpenAPI 3.0/3.1
  * Zet OpenAPI 3.0 om naar 3.1 of andersom. Body: { oasUrl } of { oasBody } (stringified JSON of YAML).
  *
- * convertOASInput ConvertOASInput  (optional)
+ * oASInput OASInput  (optional)
  * no response value expected for this operation
  */
-// const convertOAS = async ({ convertOASInput }) => {
+// const convertOAS = async ({ oASInput }) => {
 const convertOAS = async (params) => {
   try {
     const mockResult = await Service.applyMock('ToolsService', 'convertOAS', params);
@@ -57,10 +57,10 @@ const convertOAS = async (params) => {
  * Maak Bruno-collectie (POST)
  * Converteert OpenAPI naar Bruno ZIP. Body: { oasUrl } of { oasBody } (stringified JSON of YAML).
  *
- * createBrunoCollectionInput CreateBrunoCollectionInput  (optional)
+ * oASInput OASInput  (optional)
  * no response value expected for this operation
  */
-// const createBrunoCollection = async ({ createBrunoCollectionInput }) => {
+// const createBrunoCollection = async ({ oASInput }) => {
 const createBrunoCollection = async (params) => {
   try {
     const mockResult = await Service.applyMock('ToolsService', 'createBrunoCollection', params);
@@ -83,10 +83,10 @@ const createBrunoCollection = async (params) => {
  * Maak Postman-collectie (POST)
  * Converteert OpenAPI naar Postman Collection JSON. Body: { oasUrl } of { oasBody } (stringified JSON of YAML).
  *
- * createPostmanCollectionInput CreatePostmanCollectionInput  (optional)
+ * oASInput OASInput  (optional)
  * no response value expected for this operation
  */
-// const createPostmanCollection = async ({ createPostmanCollectionInput }) => {
+// const createPostmanCollection = async ({ oASInput }) => {
 const createPostmanCollection = async (params) => {
   try {
     const mockResult = await Service.applyMock('ToolsService', 'createPostmanCollection', params);
@@ -109,10 +109,10 @@ const createPostmanCollection = async (params) => {
  * Dereference OpenAPI
  * Haalt externe $ref verwijzingen op en levert één compleet OpenAPI document terug. Body: { oasUrl } of { oasBody }.
  *
- * dereferenceOASInput DereferenceOASInput  (optional)
+ * oASInput OASInput  (optional)
  * no response value expected for this operation
  */
-// const dereferenceOAS = async ({ dereferenceOASInput }) => {
+// const dereferenceOAS = async ({ oASInput }) => {
 const dereferenceOAS = async (params) => {
   try {
     const mockResult = await Service.applyMock('ToolsService', 'dereferenceOAS', params);
@@ -135,10 +135,10 @@ const dereferenceOAS = async (params) => {
  * Generate OpenAPI
  * Zet OpenAPI 3.0 om naar 3.1 of andersom. Body: { oasUrl } of { oasBody } (stringified JSON of YAML).
  *
- * generateOASInput GenerateOASInput  (optional)
+ * oASInput OASInput  (optional)
  * no response value expected for this operation
  */
-// const generateOAS = async ({ generateOASInput }) => {
+// const generateOAS = async ({ oASInput }) => {
 const generateOAS = async (params) => {
   try {
     const mockResult = await Service.applyMock('ToolsService', 'generateOAS', params);
@@ -187,10 +187,10 @@ const untrustClient = async (params) => {
  * Validate OpenAPI (POST)
  * Valideert een OpenAPI specificatie met de DON ADR ruleset. Body: { oasUrl } of { oasBody } (stringified JSON of YAML).
  *
- * validatorOpenAPIPostInput ValidatorOpenAPIPostInput  (optional)
+ * oASInput OASInput  (optional)
  * returns ModelsLintResult
  */
-// const validatorOpenAPIPost = async ({ validatorOpenAPIPostInput }) => {
+// const validatorOpenAPIPost = async ({ oASInput }) => {
 const validatorOpenAPIPost = async (params) => {
   try {
     const mockResult = await Service.applyMock('ToolsService', 'validatorOpenAPIPost', params);