feat: show index information in openapi specs

Signed-off-by: Muhammad Aaqil <[email protected]>
loopbackio · Oct 20, 2024 · 811e7d9 · 811e7d9
1 parent 5ef9137
commit 811e7d9
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 0 deletions.
diff --git a/packages/openapi-v3/src/json-to-schema.ts b/packages/openapi-v3/src/json-to-schema.ts
@@ -143,6 +143,10 @@ export function jsonToSchemaObject(
   if (matched) {
     result['x-typescript-type'] = matched[1];
   }
+  const indexInfoMatched = result.description?.match(/\{"indexInfo".*$/s);
+  if (indexInfoMatched) {
+    result['x-index-info'] = indexInfoMatched[1];
+  }
   return result;
 }
 

diff --git a/packages/repository-json-schema/src/__tests__/integration/build-schema.integration.ts b/packages/repository-json-schema/src/__tests__/integration/build-schema.integration.ts
@@ -485,6 +485,26 @@ describe('build-schema', () => {
           },
         });
       });
+      it('adds index info in description', () => {
+        @model()
+        class TestModel {
+          @property({
+            type: 'string',
+            required: true,
+            index: {unique: true},
+            jsonSchema: {
+              format: 'email',
+              maxLength: 50,
+              minLength: 5,
+            },
+          })
+          email: string;
+        }
+        const jsonSchema = modelToJsonSchema(TestModel);
+        expect(jsonSchema.description).to.eql(
+          '{"indexInfo":{"email":{"unique":true}}}',
+        );
+      });
 
       context('with custom type properties', () => {
         it('properly converts undecorated custom type properties', () => {
@@ -728,6 +748,7 @@ describe('build-schema', () => {
             @property({
               type: 'string',
               required: true,
+              index: {unique: true},
               jsonSchema: {
                 format: 'email',
                 maxLength: 50,

diff --git a/packages/repository-json-schema/src/build-schema.ts b/packages/repository-json-schema/src/build-schema.ts
@@ -486,6 +486,43 @@ export function modelToJsonSchema<T extends object>(
       continue;
     }
 
+    const index = meta.properties[p].index;
+    let indexInfo: {} = {};
+    if (index && Object.keys(index).length) {
+      indexInfo = {[p]: index};
+    }
+    if (indexInfo && Object.keys(indexInfo).length) {
+      if (result.description === undefined) result.description = '';
+      if (result.description.includes('indexInfo')) {
+        const indexInfoMatched = result.description.match(/\{"indexInfo".*$/s);
+        if (indexInfoMatched) {
+          const {indexInfo: existingIndexInfo} = JSON.parse(
+            indexInfoMatched[0],
+          );
+          existingIndexInfo[Object.keys(indexInfo)[0]] = {
+            ...indexInfo,
+          };
+          result.description = result.description.replace(
+            /\{"indexInfo".*$/s,
+            '',
+          );
+          if (result.description) {
+            result.description =
+              result.description +
+              `, ${JSON.stringify({indexInfo: existingIndexInfo})}`;
+          } else {
+            result.description = `${JSON.stringify({indexInfo: existingIndexInfo})}`;
+          }
+        }
+      } else {
+        if (result.description) {
+          result.description =
+            result.description + `, ${JSON.stringify({indexInfo})}`;
+        } else {
+          result.description = `${JSON.stringify({indexInfo})}`;
+        }
+      }
+    }
     if (meta.properties[p].type == null) {
       // Circular import of model classes can lead to this situation
       throw new Error(

diff --git a/packages/rest/src/validation/ajv-factory.provider.ts b/packages/rest/src/validation/ajv-factory.provider.ts
@@ -63,6 +63,7 @@ export class AjvFactoryProvider implements Provider<AjvFactory> {
       const ajvInst = new AjvCtor(ajvOptions);
       ajvInst.addKeyword('components');
       ajvInst.addKeyword('x-typescript-type');
+      ajvInst.addKeyword('x-index-info');
 
       ajvKeywords(ajvInst, validationOptions.ajvKeywords);