fix: include example path in valid-example

stoplightio · Aug 18, 2019 · 0e3844f · 0e3844f
1 parent 0a6377c
commit 0e3844f
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 10 deletions.
diff --git a/src/__tests__/linter.test.ts b/src/__tests__/linter.test.ts
@@ -565,8 +565,8 @@ responses:: !!foo
       }),
       expect.objectContaining({
         code: 'valid-example',
-        message: '"foo" property type should be number',
-        path: ['components', 'schemas', 'foo'],
+        message: '"example" property type should be number',
+        path: ['components', 'schemas', 'foo', 'example'],
       }),
       expect.objectContaining({
         code: 'oas3-schema',
@@ -586,8 +586,8 @@ responses:: !!foo
       expect.arrayContaining([
         expect.objectContaining({
           code: 'valid-example',
-          message: '"schema" property can\'t resolve reference #/parameters/missing from id #',
-          path: ['paths', '/todos/{todoId}', 'put', 'parameters', '1', 'schema'],
+          message: '"example" property can\'t resolve reference #/parameters/missing from id #',
+          path: ['paths', '/todos/{todoId}', 'put', 'parameters', '1', 'schema', 'example'],
         }),
       ]),
     );

diff --git a/src/functions/__tests__/schema-path.test.ts b/src/functions/__tests__/schema-path.test.ts
@@ -61,7 +61,7 @@ describe('schema', () => {
     };
     expect(runSchemaPath(target, fieldToCheck, path)).toEqual([
       {
-        path: [],
+        path: ['example'],
         message: "should have required property 'url'",
       },
     ]);
@@ -79,7 +79,7 @@ describe('schema', () => {
     expect(runSchemaPath(target, fieldToCheck, path)).toEqual([
       {
         message: 'format should match format "url"',
-        path: [],
+        path: ['example'],
       },
     ]);
   });

diff --git a/src/functions/schema-path.ts b/src/functions/schema-path.ts
@@ -29,5 +29,12 @@ export const schemaPath: IFunction<ISchemaPathOptions> = (targetVal, opts, paths
     console.error(error);
   }
 
+  if (opts.field) {
+    paths.given.push(opts.field);
+    if (paths.target) {
+      paths.target.push(opts.field);
+    }
+  }
+
   return schema(relevantObject, { schema: schemaObject }, paths, otherValues);
 };
diff --git a/src/rulesets/oas2/__tests__/valid-example.ts b/src/rulesets/oas2/__tests__/valid-example.ts
@@ -222,7 +222,7 @@ describe('valid-example', () => {
     expect(results).toEqual([
       expect.objectContaining({
         code: 'valid-example',
-        message: '"c" property type should be string',
+        message: '"example" property type should be string',
         path: [
           'paths',
           '/pet',
@@ -236,6 +236,7 @@ describe('valid-example', () => {
           'b',
           'properties',
           'c',
+          'example',
         ],
         range: expect.any(Object),
         severity: DiagnosticSeverity.Warning,

diff --git a/src/rulesets/oas3/__tests__/valid-example.ts b/src/rulesets/oas3/__tests__/valid-example.ts
@@ -125,8 +125,8 @@ describe('valid-example', () => {
     expect(results).toEqual([
       expect.objectContaining({
         code: 'valid-example',
-        message: '"schema" property format should match format "email"',
-        path: ['paths', '/pet', 'post', 'requestBody', 'content', '*/*', 'schema'],
+        message: '"example" property format should match format "email"',
+        path: ['paths', '/pet', 'post', 'requestBody', 'content', '*/*', 'schema', 'example'],
         range: expect.any(Object),
         severity: DiagnosticSeverity.Warning,
       }),
@@ -169,7 +169,7 @@ describe('valid-example', () => {
       expect(results).toEqual([
         expect.objectContaining({
           code: 'valid-example',
-          message: `"ip_address" property format should match format "${format}"`,
+          message: `"example" property format should match format "${format}"`, // hm, ip_address is likely to be more meaningful no?
         }),
       ]);
     },