Refactor API schema to remove 'id' from required fields and adjust parameter handling for arrays

Author: qertis

index.js

@@ -61,7 +61,7 @@ async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, se
     ],
     'tags': [],
   };
-  const requiredSchema = ['method', 'id', 'jsonrpc'];
+  const requiredSchema = ['method', 'jsonrpc'];
   prepare: for (const module of documents) {
     let isJsonRpc = false;
 
@@ -121,7 +121,6 @@ async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, se
                     default: apiName,
                     description: `API method ${apiName}`,
                   },
-                  // todo делать разграничение для notification request (без id)
                   id: {
                     type: 'integer',
                     default: 1,
@@ -155,7 +154,23 @@ async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, se
           if (parameter.type.names[0] === 'object') {
             return accumulator;
           }
-          const [type] = parameter.type.names;
+          let [type] = parameter.type.names;
+          let items;
+          switch (type) {
+            case 'Array.<string>': {
+              type = 'array';
+              items = { type: 'number' };
+              break;
+            }
+            case 'Array.<number>': {
+              type = 'array';
+              items = { type: 'string' };
+              break;
+            }
+            default: {
+              break;
+            }
+          }
           const description = parameter.description;
           let name;
           try {
@@ -171,6 +186,7 @@ async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, se
             [name]: {
               type,
               description,
+              items,
             },
           };
           return accumulator;
@@ -179,12 +195,11 @@ async function openapiJsonrpcJsdoc({ files, securitySchemes = {}, packageUrl, se
           title: 'Parameters',
           type: 'object',
           'default': exampleJSON,
-          required: requiredSchema,
+          required: [],
           properties: {},
         },
       );
       const schemaPostJsdoc = schema.post.requestBody.content['application/json'].schema;
-      schemaPostJsdoc.required.push('params');
       schemaPostJsdoc.properties.params = propertiesParameters;
     }
     temporaryDocument.paths[`${api}${apiName}`] = schema;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-jsonrpc-jsdoc",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "Transform JSDoc-annotated JSON-RPC 2.0 methods into OpenAPI 3.0 specifications. Auto-generates REST API documentation with complete schemas, parameters, and endpoint definitions.",
   "main": "index.js",
   "scripts": {

test/api/v1.js

@@ -4,6 +4,7 @@
  * @param {object} parameters - params
  * @param {string} parameters.id - id
  * @param {string} [parameters.test] - test
+ * @param {string[]} parameters.array - array
  * @tags api, api-v1, api
  * @example
  * {

test/index.test.js

@@ -64,7 +64,7 @@ test('t1', t => {
   t.true(Array.isArray(v1Test.post.parameters));
   const v1RequestBodySchema = v1Test.post.requestBody.content['application/json'].schema;
   t.is(v1RequestBodySchema.type, 'object');
-  t.true(v1RequestBodySchema.required.includes('id'));
+  t.true(v1RequestBodySchema.required.includes('method'));
 });
 
 test('t2', t => {