fix: show readonly in openapi spec of model property if it is generated

Signed-off-by: Muhammad Aaqil <[email protected]>
loopbackio · Oct 3, 2024 · 2809bb2 · 2809bb2
1 parent 0bc6eba
commit 2809bb2
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/packages/repository-json-schema/src/__tests__/unit/build-schema.unit.ts b/packages/repository-json-schema/src/__tests__/unit/build-schema.unit.ts
@@ -203,6 +203,20 @@ describe('build-schema', () => {
       });
     });
 
+    it('show generated', () => {
+      expect(
+        metaToJsonProperty({
+          type: String,
+          description: 'test',
+          generated: true,
+        }),
+      ).to.eql({
+        type: 'string',
+        description: 'test',
+        readOnly: true,
+      });
+    });
+
     it('keeps AJV keywords', () => {
       const schema = metaToJsonProperty({
         type: String,

diff --git a/packages/repository-json-schema/src/build-schema.ts b/packages/repository-json-schema/src/build-schema.ts
@@ -271,6 +271,9 @@ export function metaToJsonProperty(meta: PropertyDefinition): JsonSchema {
   } else {
     result = propDef;
   }
+  if (meta.generated) {
+    result.readOnly = true;
+  }
 
   const wrappedType = stringTypeToWrapper(propertyType);
   const resolvedType = resolveType(wrappedType);