@redocly/openapi-core 1.0.0-beta.61 → 1.0.0-beta.65

package/src/js-yaml/index.ts

@@ -0,0 +1,19 @@
+// TODO: add a type for "types" https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/js-yaml/index.d.ts
+// @ts-ignore
+import { JSON_SCHEMA, types, LoadOptions, DumpOptions, load, dump  } from 'js-yaml';
+
+const DEFAULT_SCHEMA_WITHOUT_TIMESTAMP = JSON_SCHEMA.extend({
+  implicit: [types.merge],
+  explicit: [
+    types.binary,
+    types.omap,
+    types.pairs,
+    types.set,
+  ],
+});
+
+export const parseYaml = (str: string, opts?: LoadOptions): unknown =>
+  load(str, {schema: DEFAULT_SCHEMA_WITHOUT_TIMESTAMP, ...opts});
+
+export const stringifyYaml = (obj: any, opts?: DumpOptions): string =>
+  dump(obj, {schema: DEFAULT_SCHEMA_WITHOUT_TIMESTAMP, ...opts});

package/src/oas-types.ts

@@ -34,6 +34,10 @@ export function detectOpenAPI(root: any): OasVersion {
     throw new Error('This doesn’t look like an OpenAPI document.\n');
   }
 
+  if (root.openapi && typeof root.openapi !== 'string') {
+    throw new Error(`Invalid OpenAPI version: should be a string but got "${typeof root.openapi}"`);
+  }
+
   if (root.openapi && root.openapi.startsWith('3.0')) {
     return OasVersion.Version3_0;
   }

package/src/resolve.ts

@@ -1,12 +1,12 @@
 import * as fs from 'fs';
 import * as path from 'path';
 import * as url from 'url';
-import * as yaml from 'js-yaml';
+
 import { OasRef } from './typings/openapi';
 import { isRef, joinPointer, escapePointer, parseRef, isAbsoluteUrl } from './ref-utils';
 import type { YAMLNode, LoadOptions } from 'yaml-ast-parser';
 import { NormalizedNodeType, isNamedType } from './types';
-import { readFileFromUrl } from './utils';
+import { readFileFromUrl, parseYaml } from './utils';
 import { ResolveConfig } from './config/config';
 
 export type CollectedRefs = Map<string /* absoluteFilePath */, Document>;
@@ -52,7 +52,7 @@ export class ResolveError extends Error {
   }
 }
 
-const jsYamlErrorLineColRegexp = /at line (\d+), column (\d+):/;
+const jsYamlErrorLineColRegexp = /\((\d+):(\d+)\)$/;
 
 export class YamlParseError extends Error {
   col: number;
@@ -79,7 +79,7 @@ export function makeDocumentFromString(sourceString: string, absoluteRef: string
   try {
     return {
       source,
-      parsed: yaml.safeLoad(sourceString, { filename: absoluteRef }),
+      parsed: parseYaml(sourceString, { filename: absoluteRef }),
     };
   } catch (e) {
     throw new YamlParseError(e, source);
@@ -133,7 +133,7 @@ export class BaseResolver {
     try {
       return {
         source,
-        parsed: yaml.safeLoad(source.body, { filename: source.absoluteRef }),
+        parsed: parseYaml(source.body, { filename: source.absoluteRef }),
       };
     } catch (e) {
       throw new YamlParseError(e, source);

package/src/rules/__tests__/no-unresolved-refs.test.ts

@@ -83,7 +83,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
               },
             },
           ],
-          "message": "Failed to parse: unexpected end of the stream within a single quoted scalar in \\"fixtures/invalid-yaml.yaml\\" at line 2, column 1:",
+          "message": "Failed to parse: unexpected end of the stream within a single quoted scalar in \\"fixtures/invalid-yaml.yaml\\" (2:1)",
           "ruleId": "no-unresolved-refs",
           "severity": "error",
           "suggest": Array [],
@@ -96,7 +96,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
               "source": "foobar.yaml",
             },
           ],
-          "message": "Can't resolve $ref: unexpected end of the stream within a single quoted scalar in \\"fixtures/invalid-yaml.yaml\\" at line 2, column 1:",
+          "message": "Can't resolve $ref: unexpected end of the stream within a single quoted scalar in \\"fixtures/invalid-yaml.yaml\\" (2:1)",
           "ruleId": "no-unresolved-refs",
           "severity": "error",
           "suggest": Array [],

package/src/rules/common/info-description-override.ts

@@ -0,0 +1,24 @@
+import { Oas3Decorator, Oas2Decorator } from '../../visitors';
+import { readFileAsStringSync } from '../../utils';
+import { UserContext } from '../../walk';
+
+export const InfoDescriptionOverride: Oas3Decorator | Oas2Decorator = ({ filePath }) => {
+  return {
+    Info: {
+      leave(info, { report, location }: UserContext) {
+        if (!filePath)
+          throw new Error(
+            `Parameter "filePath" is not provided for "info-description-override" rule`,
+          );
+        try {
+          info.description = readFileAsStringSync(filePath);
+        } catch (e) {
+          report({
+            message: `Failed to read markdown override file for "info.description".\n${e.message}`,
+            location: location.child('description'),
+          });
+        }
+      },
+    },
+  };
+};

package/src/rules/common/operation-description-override.ts

@@ -0,0 +1,30 @@
+import { Oas3Decorator, Oas2Decorator } from '../../visitors';
+import { Oas2Operation } from '../../typings/swagger';
+import { Oas3Operation } from '../../typings/openapi';
+import { readFileAsStringSync } from '../../utils';
+import { UserContext } from '../../walk';
+
+export const OperationDescriptionOverride: Oas3Decorator | Oas2Decorator = ({ operationIds }) => {
+  return {
+    Operation: {
+      leave(operation: Oas2Operation | Oas3Operation, { report, location }: UserContext) {
+        if (!operation.operationId) return;
+        if (!operationIds)
+          throw new Error(
+            `Parameter "operationIds" is not provided for "operation-description-override" rule`,
+          );
+        const operationId = operation.operationId;
+        if (operationIds[operationId]) {
+          try {
+            operation.description = readFileAsStringSync(operationIds[operationId]);
+          } catch (e) {
+            report({
+              message: `Failed to read markdown override file for operation "${operationId}".\n${e.message}`,
+              location: location.child('operationId').key(),
+            });
+          }
+        }
+      },
+    },
+  };
+};

package/src/rules/common/tag-description-override.ts

@@ -0,0 +1,25 @@
+import { Oas3Decorator, Oas2Decorator } from '../../visitors';
+import { readFileAsStringSync } from '../../utils';
+import { UserContext } from '../../walk';
+
+export const TagDescriptionOverride: Oas3Decorator | Oas2Decorator = ({ tagNames }) => {
+  return {
+    Tag: {
+      leave(tag, { report }: UserContext) {
+        if (!tagNames)
+          throw new Error(
+            `Parameter "tagNames" is not provided for "tag-description-override" rule`,
+          );
+        if (tagNames[tag.name]) {
+          try {
+            tag.description = readFileAsStringSync(tagNames[tag.name]);
+          } catch (e) {
+            report({
+              message: `Failed to read markdown override file for tag "${tag.name}".\n${e.message}`,
+            });
+          }
+        }
+      },
+    },
+  };
+};

package/src/rules/oas2/index.ts

@@ -29,6 +29,9 @@ import { NoIdenticalPaths } from '../common/no-identical-paths';
 import { OperationOperationId } from '../common/operation-operationId';
 import { OperationSummary } from '../common/operation-summary';
 import { NoAmbiguousPaths } from '../common/no-ambiguous-paths';
+import { OperationDescriptionOverride } from '../common/operation-description-override';
+import { TagDescriptionOverride } from '../common/tag-description-override';
+import { InfoDescriptionOverride } from '../common/info-description-override';
 
 export const rules = {
   spec: OasSpec as Oas2Rule,
@@ -66,4 +69,7 @@ export const rules = {
 export const preprocessors = {};
 export const decorators = {
   'registry-dependencies': RegistryDependencies as Oas2Decorator,
+  'operation-description-override': OperationDescriptionOverride as Oas2Decorator,
+  'tag-description-override': TagDescriptionOverride as Oas2Decorator,
+  'info-description-override': InfoDescriptionOverride as Oas2Decorator,
 };

package/src/rules/oas3/index.ts

@@ -1,4 +1,5 @@
 import { Oas3RuleSet } from '../../oas-types';
+import { Oas3Decorator } from '../../visitors';
 import { OasSpec } from '../common/spec';
 import { Operation2xxResponse } from '../common/operation-2xx-response';
 import { OperationIdUnique } from '../common/operation-operationId-unique';
@@ -37,8 +38,9 @@ import { OperationOperationId } from '../common/operation-operationId';
 import { OperationSummary } from '../common/operation-summary';
 import { NoAmbiguousPaths } from '../common/no-ambiguous-paths';
 import { NoEmptyEnumServers } from './no-servers-empty-enum';
-
-import { Oas3Decorator } from '../../visitors';
+import { OperationDescriptionOverride } from '../common/operation-description-override';
+import { TagDescriptionOverride } from '../common/tag-description-override';
+import { InfoDescriptionOverride } from '../common/info-description-override';
 
 export const rules = {
   spec: OasSpec,
@@ -78,11 +80,14 @@ export const rules = {
   'no-identical-paths': NoIdenticalPaths,
   'no-ambiguous-paths': NoAmbiguousPaths,
   'no-undefined-server-variable': NoUndefinedServerVariable,
-  'no-servers-empty-enum': NoEmptyEnumServers
+  'no-servers-empty-enum': NoEmptyEnumServers,
 } as Oas3RuleSet;
 
 export const preprocessors = {};
 
 export const decorators = {
   'registry-dependencies': RegistryDependencies as Oas3Decorator,
+  'operation-description-override': OperationDescriptionOverride as Oas3Decorator,
+  'tag-description-override': TagDescriptionOverride as Oas3Decorator,
+  'info-description-override': InfoDescriptionOverride as Oas3Decorator,
 };