fix: multi create type

fix: multi patch
feathersjs-ecosystem · Dec 27, 2023 · 97d4b96 · 97d4b96
1 parent 236bcff
commit 97d4b96
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 4 deletions.
diff --git a/lib/openapi.js b/lib/openapi.js
@@ -12,7 +12,6 @@ const defaultMethods = [
   { operation: 'update', method: 'update', id: true, httpMethod: 'put', multi: false },
   { operation: 'patch', method: 'patch', id: true, httpMethod: 'patch', multi: false },
   { operation: 'remove', method: 'remove', id: true, httpMethod: 'delete', multi: false },
-  { operation: 'createMulti', method: 'create', id: false, httpMethod: 'post', multi: true },
   { operation: 'updateMulti', method: 'update', id: false, httpMethod: 'put', multi: true },
   { operation: 'patchMulti', method: 'patch', id: false, httpMethod: 'patch', multi: true },
   { operation: 'removeMulti', method: 'remove', id: false, httpMethod: 'delete', multi: true }
@@ -49,7 +48,7 @@ function ignoreService (service, path, includeConfig, ignoreConfig) {
 
 function determineMultiOperations (service) {
   if (service.options && service.options.multi) {
-    const operations = service.options.multi === true ? ['remove', 'update', 'patch', 'create'] : service.options.multi
+    const operations = service.options.multi === true ? serviceMethods : service.options.multi;
     return operations.filter((operation) => _.isFunction(service[operation]));
   }
 

diff --git a/lib/utils.js b/lib/utils.js
@@ -201,8 +201,15 @@ exports.createSwaggerServiceOptions = function createSwaggerServiceOptions ({ sc
 
       if (dataSchema) {
         const dataSchemeName = dataSchema.$id || `${baseSchemeName}Data`;
+        const dataListSchemeName = `${dataSchemeName}List`;
+
         serviceDocs.schemas[dataSchemeName] = transformSchemaFn(dataSchema);
+        serviceDocs.schemas[dataListSchemeName] = {
+          type: 'array',
+          items: { $ref: `#/components/schemas/${dataSchemeName}` }
+        };
         serviceDocs.refs.createRequest = dataSchemeName;
+        serviceDocs.refs.createMultiRequest = { refs: [dataSchemeName, dataListSchemeName], type: 'oneOf' };
         serviceDocs.refs.updateRequest = dataSchemeName;
       }
 
@@ -218,8 +225,16 @@ exports.createSwaggerServiceOptions = function createSwaggerServiceOptions ({ sc
 
       if (patchSchema) {
         const patchSchemaName = patchSchema.$id || `${baseSchemeName}PatchData`;
+        const patchListSchemeName = `${patchSchemaName}List`;
+
         serviceDocs.schemas[patchSchemaName] = transformSchemaFn(patchSchema);
+        serviceDocs.schemas[patchListSchemeName] = {
+          type: 'array',
+          items: { $ref: `#/components/schemas/${patchSchemaName}` }
+        };
+
         serviceDocs.refs.patchRequest = patchSchemaName;
+        serviceDocs.refs.patchMultiRequest = patchListSchemeName;
       }
 
       if (!docs || !docs.model) {

diff --git a/lib/v3/generator.js b/lib/v3/generator.js
@@ -219,7 +219,7 @@ class OpenApiV3Generator extends AbstractApiGenerator {
         const multi = multiOperations.includes('create');
         return {
           tags,
-          description: 'Creates a new resource with data.',
+          description: multi ? 'Creates one or multiple resources.' : 'Creates a new resource with data.',
           requestBody: {
             required: true,
             content: multi ? jsonSchemaRef(refs.createMultiRequest) : jsonSchemaRef(refs.createRequest)

diff --git a/test/v3/expected-memory-spec-multi-only.json b/test/v3/expected-memory-spec-multi-only.json
@@ -6,7 +6,7 @@
   "paths": {
     "/message": {
       "post": {
-        "description": "Creates a new resource with data.",
+        "description": "Creates one or multiple resources.",
         "parameters": [],
         "requestBody": {
           "content": {

diff --git a/test/v3/expected-memory-spec-pagination-find.json b/test/v3/expected-memory-spec-pagination-find.json
@@ -17,6 +17,7 @@
         "type": "array"
       },
       "messagePagination": {
+        "required": true,
         "title": "message pagination result",
         "type": "object",
         "properties": {