fix(repository-json-schema): fix $ref typo (#963)

* fix(repository-json-schema): fix $ref typo * fix(repository-json-schema): fix README
loopbackio · Feb 6, 2018 · a438729 · a438729
1 parent a2368ce
commit a438729
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 9 deletions.
diff --git a/...openapi-v2/test/unit/controller-spec/controller-decorators/param-decorators/param.test.ts b/...openapi-v2/test/unit/controller-spec/controller-decorators/param-decorators/param.test.ts
@@ -325,7 +325,7 @@ describe('Routing metadata for parameters', () => {
             type: 'string',
           },
           foo: {
-            $ref: '#definitions/Foo',
+            $ref: '#/definitions/Foo',
           },
         },
       });

diff --git a/packages/repository-json-schema/README.md b/packages/repository-json-schema/README.md
@@ -30,6 +30,7 @@ The value of `jsonSchema` will be:
 
 ```json
 {
+  "title": "MyModel",
   "properties": {
     "name": {
       "type": "string"

diff --git a/packages/repository-json-schema/src/build-schema.ts b/packages/repository-json-schema/src/build-schema.ts
@@ -101,7 +101,7 @@ export function metaToJsonProperty(meta: PropertyDefinition): JsonDefinition {
   }
 
   const propDef = isComplexType(ctor)
-    ? {$ref: `#definitions/${ctor.name}`}
+    ? {$ref: `#/definitions/${ctor.name}`}
     : {type: ctor.name.toLowerCase()};
 
   if (meta.array) {

diff --git a/packages/repository-json-schema/test/integration/build-schema.test.ts b/packages/repository-json-schema/test/integration/build-schema.test.ts
@@ -139,7 +139,7 @@ describe('build-schema', () => {
           const jsonSchema = modelToJsonSchema(TestModel);
           expect(jsonSchema.properties).to.deepEqual({
             cusType: {
-              $ref: '#definitions/CustomType',
+              $ref: '#/definitions/CustomType',
             },
           });
           expect(jsonSchema).to.not.have.key('definitions');
@@ -159,7 +159,7 @@ describe('build-schema', () => {
           const jsonSchema = modelToJsonSchema(TestModel);
           expect(jsonSchema.properties).to.deepEqual({
             cusType: {
-              $ref: '#definitions/CustomType',
+              $ref: '#/definitions/CustomType',
             },
           });
           expect(jsonSchema.definitions).to.deepEqual({
@@ -195,7 +195,7 @@ describe('build-schema', () => {
           const schemaDefs = jsonSchema.definitions;
           expect(schemaProps).to.deepEqual({
             cusBar: {
-              $ref: '#definitions/CustomTypeBar',
+              $ref: '#/definitions/CustomTypeBar',
             },
           });
           expect(schemaDefs).to.deepEqual({
@@ -213,7 +213,7 @@ describe('build-schema', () => {
                 prop: {
                   type: 'array',
                   items: {
-                    $ref: '#definitions/CustomTypeFoo',
+                    $ref: '#/definitions/CustomTypeFoo',
                   },
                 },
               },
@@ -254,7 +254,7 @@ describe('build-schema', () => {
           cusArr: {
             type: 'array',
             items: {
-              $ref: '#definitions/CustomType',
+              $ref: '#/definitions/CustomType',
             },
           },
         });

diff --git a/packages/repository-json-schema/test/unit/build-schema.test.ts b/packages/repository-json-schema/test/unit/build-schema.test.ts
@@ -63,7 +63,7 @@ describe('build-schema', () => {
     it('converts complex types', () => {
       class CustomType {}
       expect(metaToJsonProperty({type: CustomType})).to.eql({
-        $ref: '#definitions/CustomType',
+        $ref: '#/definitions/CustomType',
       });
     });
 
@@ -78,7 +78,7 @@ describe('build-schema', () => {
       class CustomType {}
       expect(metaToJsonProperty({array: true, type: CustomType})).to.eql({
         type: 'array',
-        items: {$ref: '#definitions/CustomType'},
+        items: {$ref: '#/definitions/CustomType'},
       });
     });
   });