@redocly/openapi-core 1.19.0 → 1.20.0

package/src/lint.ts

@@ -2,7 +2,7 @@ import { rootRedoclyConfigSchema } from '@redocly/config';
 import { BaseResolver, resolveDocument, makeDocumentFromString } from './resolve';
 import { normalizeVisitors } from './visitors';
 import { walkDocument } from './walk';
-import { StyleguideConfig, Config, initRules } from './config';
+import { initRules } from './config';
 import { normalizeTypes } from './types';
 import { releaseAjvInstance } from './rules/ajv';
 import { SpecVersion, getMajorSpecVersion, detectSpec, getTypes } from './oas-types';
@@ -10,6 +10,7 @@ import { createConfigTypes } from './types/redocly-yaml';
 import { Spec } from './rules/common/spec';
 import { NoUnresolvedRefs } from './rules/no-unresolved-refs';
 
+import type { StyleguideConfig, Config } from './config';
 import type { Document, ResolvedRefMap } from './resolve';
 import type { ProblemSeverity, WalkContext } from './walk';
 import type { NodeType } from './types';

package/src/logger.ts

@@ -1,9 +1,9 @@
 import * as colorette from 'colorette';
-export { options as colorOptions } from 'colorette';
-
 import { isBrowser } from './env';
 import { identity } from './utils';
 
+export { options as colorOptions } from 'colorette';
+
 export const colorize = new Proxy(colorette, {
   get(target: typeof colorette, prop: string): typeof identity {
     if (isBrowser) {

package/src/oas-types.ts

@@ -1,21 +1,11 @@
-import type {
-  Oas3Rule,
-  Oas3Preprocessor,
-  Oas2Rule,
-  Oas2Preprocessor,
-  Async2Preprocessor,
-  Async2Rule,
-  Async3Preprocessor,
-  Async3Rule,
-  ArazzoPreprocessor,
-  ArazzoRule,
-} from './visitors';
 import { Oas2Types } from './types/oas2';
 import { Oas3Types } from './types/oas3';
 import { Oas3_1Types } from './types/oas3_1';
 import { AsyncApi2Types } from './types/asyncapi2';
 import { AsyncApi3Types } from './types/asyncapi3';
 import { ArazzoTypes } from './types/arazzo';
+import { isPlainObject } from './utils';
+
 import type {
   BuiltInAsync2RuleId,
   BuiltInAsync3RuleId,
@@ -24,7 +14,18 @@ import type {
   BuiltInOAS2RuleId,
   BuiltInOAS3RuleId,
 } from './types/redocly-yaml';
-import { isPlainObject } from './utils';
+import type {
+  Oas3Rule,
+  Oas3Preprocessor,
+  Oas2Rule,
+  Oas2Preprocessor,
+  Async2Preprocessor,
+  Async2Rule,
+  Async3Preprocessor,
+  Async3Rule,
+  ArazzoPreprocessor,
+  ArazzoRule,
+} from './visitors';
 
 export enum SpecVersion {
   OAS2 = 'oas2',

package/src/redocly/domains.ts

@@ -1,4 +1,4 @@
-import { Region } from '../config/types';
+import type { Region } from '../config/types';
 
 let redoclyDomain = 'redocly.com';
 

package/src/redocly/index.ts

@@ -3,11 +3,8 @@ import { resolve } from 'path';
 import { homedir } from 'os';
 import { RegistryApi } from './registry-api';
 import { env } from '../env';
-import { RegionalToken, RegionalTokenWithValidity } from './redocly-client-types';
 import { isNotEmptyObject } from '../utils';
 import { colorize } from '../logger';
-
-import type { AccessTokens, Region } from '../config/types';
 import {
   AVAILABLE_REGIONS,
   DEFAULT_REGION,
@@ -16,6 +13,9 @@ import {
   setRedoclyDomain,
 } from './domains';
 
+import type { RegionalToken, RegionalTokenWithValidity } from './redocly-client-types';
+import type { AccessTokens, Region } from '../config/types';
+
 export const TOKEN_FILENAME = '.redocly-config.json';
 
 export class RedoclyClient {

package/src/redocly/registry-api.ts

@@ -1,4 +1,8 @@
-import fetch, { RequestInit, HeadersInit } from 'node-fetch';
+import fetch from 'node-fetch';
+import { getProxyAgent, isNotEmptyObject } from '../utils';
+import { getRedoclyDomain } from './domains';
+
+import type { RequestInit, HeadersInit } from 'node-fetch';
 import type {
   NotFoundProblemResponse,
   PrepareFileuploadOKResponse,
@@ -6,8 +10,6 @@ import type {
   PushApiParams,
 } from './registry-api-types';
 import type { AccessTokens, Region } from '../config/types';
-import { getProxyAgent, isNotEmptyObject } from '../utils';
-import { getRedoclyDomain } from './domains';
 
 const version = require('../../package.json').version;
 

package/src/ref-utils.ts

@@ -1,7 +1,8 @@
-import { Source } from './resolve';
-import { OasRef } from './typings/openapi';
 import { isTruthy } from './utils';
 
+import type { Source } from './resolve';
+import type { OasRef } from './typings/openapi';
+
 export function joinPointer(base: string, key: string | number) {
   if (base === '') base = '#/';
   return base[base.length - 1] === '/' ? base + key : base + '/' + key;
@@ -60,6 +61,7 @@ export function pointerBaseName(pointer: string) {
 }
 
 export function refBaseName(ref: string) {
+  // eslint-disable-next-line no-useless-escape
   const parts = ref.split(/[\/\\]/); // split by '\' and '/'
   return parts[parts.length - 1].replace(/\.[^.]+$/, ''); // replace extension with empty string
 }

package/src/resolve.ts

@@ -1,11 +1,13 @@
 import * as fs from 'fs';
 import * as path from 'path';
-import { OasRef } from './typings/openapi';
 import { isRef, joinPointer, escapePointer, parseRef, isAbsoluteUrl, isAnchor } from './ref-utils';
-import type { YAMLNode, LoadOptions } from 'yaml-ast-parser';
-import { NormalizedNodeType, isNamedType, SpecExtension } from './types';
+import { isNamedType, SpecExtension } from './types';
 import { readFileFromUrl, parseYaml, nextTick } from './utils';
-import { ResolveConfig } from './config/types';
+
+import type { YAMLNode, LoadOptions } from 'yaml-ast-parser';
+import type { NormalizedNodeType } from './types';
+import type { ResolveConfig } from './config/types';
+import type { OasRef } from './typings/openapi';
 
 export type CollectedRefs = Map<string /* absoluteFilePath */, Document>;
 

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

@@ -22,7 +22,9 @@ describe('oas3 boolean-parameter-prefixes', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'no-unresolved-refs': 'error',
+        rules: {
+          'no-unresolved-refs': 'error',
+        },
       }),
     });
 
@@ -62,7 +64,9 @@ describe('oas3 boolean-parameter-prefixes', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'no-unresolved-refs': 'error',
+        rules: {
+          'no-unresolved-refs': 'error',
+        },
       }),
     });
 
@@ -119,7 +123,9 @@ describe('oas3 boolean-parameter-prefixes', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'no-unresolved-refs': 'error',
+        rules: {
+          'no-unresolved-refs': 'error',
+        },
       }),
     });
 
@@ -143,7 +149,9 @@ describe('oas3 boolean-parameter-prefixes', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'no-unresolved-refs': 'error',
+        rules: {
+          'no-unresolved-refs': 'error',
+        },
       }),
     });
 
@@ -190,7 +198,9 @@ describe('oas3 boolean-parameter-prefixes', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'no-unresolved-refs': 'error',
+        rules: {
+          'no-unresolved-refs': 'error',
+        },
       }),
     });
 
@@ -219,7 +229,9 @@ describe('oas3 boolean-parameter-prefixes', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'no-unresolved-refs': 'error',
+        rules: {
+          'no-unresolved-refs': 'error',
+        },
       }),
     });
 
@@ -248,7 +260,9 @@ describe('oas3 boolean-parameter-prefixes', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'no-unresolved-refs': 'error',
+        rules: {
+          'no-unresolved-refs': 'error',
+        },
       }),
     });
 

package/src/rules/ajv.ts

@@ -1,6 +1,7 @@
 import Ajv from '@redocly/ajv/dist/2020';
-import { Location, escapePointer } from '../ref-utils';
+import { escapePointer } from '../ref-utils';
 
+import type { Location } from '../ref-utils';
 import type { ValidateFunction, ErrorObject } from '@redocly/ajv/dist/2020';
 import type { ResolveFn } from '../walk';
 

package/src/rules/arazzo/__tests__/parameters-no-body-inside-in.test.ts

@@ -0,0 +1,76 @@
+import { outdent } from 'outdent';
+import { lintDocument } from '../../../lint';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
+import { BaseResolver } from '../../../resolve';
+import { StyleguideConfig } from '../../../config';
+import { ArazzoRule } from '../../../visitors';
+
+describe('Arazzo parameters-no-body-inside-in', () => {
+  const document = parseYamlToDocument(
+    outdent`
+      arazzo: '1.0.0'
+      info:
+        title: Cool API
+        version: 1.0.0
+        description: A cool API
+      sourceDescriptions:
+        - name: museum-api
+          type: openapi
+          url: openapi.yaml
+      workflows:
+        - workflowId: get-museum-hours
+          description: This workflow demonstrates how to get the museum opening hours and buy tickets.
+          parameters:
+            - in: body
+              name: Authorization
+              value: Basic Og==
+          steps:
+            - stepId: get-museum-hours
+              description: >-
+                Get museum hours by resolving request details with getMuseumHours operationId from openapi.yaml description.
+              operationId: museum-api.getMuseumHours
+              successCriteria:
+                - condition: $statusCode == 200
+    `,
+    'arazzo.yaml'
+  );
+
+  it('should not report on `body` inside parameter `in` field', async () => {
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ rules: {} }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
+  });
+
+  it('should report on `body` inside parameter `in` field', async () => {
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        rules: {},
+        arazzoRules: { 'parameters-no-body-inside-in': 'error' },
+      }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      [
+        {
+          "location": [
+            {
+              "pointer": "#/workflows/0/parameters/0/in",
+              "reportOnKey": false,
+              "source": "arazzo.yaml",
+            },
+          ],
+          "message": "The \`body\` value of the \`in\` property is not supported by Spot.",
+          "ruleId": "parameters-no-body-inside-in",
+          "severity": "error",
+          "suggest": [],
+        },
+      ]
+    `);
+  });
+});

package/src/rules/arazzo/index.ts

@@ -1,11 +1,14 @@
-import { ArazzoRule } from '../../visitors';
 import { Spec } from '../common/spec';
-import type { ArazzoRuleSet } from '../../oas-types';
 import { Assertions } from '../common/assertions';
+import { ParametersNoBodyInsideIn } from '../spot/parameters-no-body-inside-in';
+
+import type { ArazzoRule } from '../../visitors';
+import type { ArazzoRuleSet } from '../../oas-types';
 
 export const rules: ArazzoRuleSet<'built-in'> = {
   spec: Spec as ArazzoRule,
   assertions: Assertions as ArazzoRule,
+  'parameters-no-body-inside-in': ParametersNoBodyInsideIn as ArazzoRule,
 };
 
 export const preprocessors = {};

package/src/rules/async2/__tests__/channels-kebab-case.test.ts

@@ -23,7 +23,7 @@ describe('Async2 channels-kebab-case', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'channels-kebab-case': 'error' }),
+      config: await makeConfig({ rules: { 'channels-kebab-case': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -64,7 +64,7 @@ describe('Async2 channels-kebab-case', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'channels-kebab-case': 'error' }),
+      config: await makeConfig({ rules: { 'channels-kebab-case': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -106,8 +106,10 @@ describe('Async2 channels-kebab-case', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'paths-kebab-case': 'error',
-        'no-path-trailing-slash': 'off',
+        rules: {
+          'paths-kebab-case': 'error',
+          'no-path-trailing-slash': 'off',
+        },
       }),
     });
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
@@ -133,7 +135,9 @@ describe('Async2 channels-kebab-case', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'paths-kebab-case': 'error',
+        rules: {
+          'paths-kebab-case': 'error',
+        },
       }),
     });
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);

package/src/rules/async2/__tests__/no-channel-trailing-slash.test.ts

@@ -23,7 +23,7 @@ describe('no-channel-trailing-slash', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-channel-trailing-slash': 'error' }),
+      config: await makeConfig({ rules: { 'no-channel-trailing-slash': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -64,7 +64,7 @@ describe('no-channel-trailing-slash', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-channel-trailing-slash': 'error' }),
+      config: await makeConfig({ rules: { 'no-channel-trailing-slash': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
@@ -89,7 +89,7 @@ describe('no-channel-trailing-slash', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-channel-trailing-slash': 'error' }),
+      config: await makeConfig({ rules: { 'no-channel-trailing-slash': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);

package/src/rules/async2/channels-kebab-case.ts

@@ -1,5 +1,5 @@
-import { Async2Rule } from '../../visitors';
-import { UserContext } from '../../walk';
+import type { Async2Rule } from '../../visitors';
+import type { UserContext } from '../../walk';
 
 export const ChannelsKebabCase: Async2Rule = () => {
   return {

package/src/rules/async2/index.ts

@@ -1,18 +1,21 @@
-import { Async2Rule } from '../../visitors';
 import { Assertions } from '../common/assertions';
 import { Spec } from '../common/spec';
 import { InfoContact } from '../common/info-contact';
+import { InfoLicenseStrict } from '../common/info-license-strict';
 import { OperationOperationId } from '../common/operation-operationId';
 import { TagDescription } from '../common/tag-description';
 import { TagsAlphabetical } from '../common/tags-alphabetical';
 import { ChannelsKebabCase } from './channels-kebab-case';
 import { NoChannelTrailingSlash } from './no-channel-trailing-slash';
+
+import type { Async2Rule } from '../../visitors';
 import type { Async2RuleSet } from '../../oas-types';
 
 export const rules: Async2RuleSet<'built-in'> = {
   spec: Spec as Async2Rule,
   assertions: Assertions as Async2Rule,
   'info-contact': InfoContact as Async2Rule,
+  'info-license-strict': InfoLicenseStrict as Async2Rule,
   'operation-operationId': OperationOperationId as Async2Rule,
   'channels-kebab-case': ChannelsKebabCase,
   'no-channel-trailing-slash': NoChannelTrailingSlash,

package/src/rules/async2/no-channel-trailing-slash.ts

@@ -1,5 +1,5 @@
-import { Async2Rule } from '../../visitors';
-import { UserContext } from '../../walk';
+import type { Async2Rule } from '../../visitors';
+import type { UserContext } from '../../walk';
 
 export const NoChannelTrailingSlash: Async2Rule = () => {
   return {

package/src/rules/async3/__tests__/channels-kebab-case.test.ts

@@ -23,7 +23,7 @@ describe('Async2 channels-kebab-case', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'channels-kebab-case': 'error' }),
+      config: await makeConfig({ rules: { 'channels-kebab-case': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -64,7 +64,7 @@ describe('Async2 channels-kebab-case', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'channels-kebab-case': 'error' }),
+      config: await makeConfig({ rules: { 'channels-kebab-case': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
@@ -106,8 +106,10 @@ describe('Async2 channels-kebab-case', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'paths-kebab-case': 'error',
-        'no-path-trailing-slash': 'off',
+        rules: {
+          'paths-kebab-case': 'error',
+          'no-path-trailing-slash': 'off',
+        },
       }),
     });
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
@@ -133,7 +135,9 @@ describe('Async2 channels-kebab-case', () => {
       externalRefResolver: new BaseResolver(),
       document,
       config: await makeConfig({
-        'paths-kebab-case': 'error',
+        rules: {
+          'paths-kebab-case': 'error',
+        },
       }),
     });
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);

package/src/rules/async3/__tests__/no-channel-trailing-slash.test.ts

@@ -23,7 +23,7 @@ describe('no-channel-trailing-slash', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-channel-trailing-slash': 'error' }),
+      config: await makeConfig({ rules: { 'no-channel-trailing-slash': 'error' } }),
     });
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
       [
@@ -63,7 +63,7 @@ describe('no-channel-trailing-slash', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-channel-trailing-slash': 'error' }),
+      config: await makeConfig({ rules: { 'no-channel-trailing-slash': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
@@ -88,7 +88,7 @@ describe('no-channel-trailing-slash', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: await makeConfig({ 'no-channel-trailing-slash': 'error' }),
+      config: await makeConfig({ rules: { 'no-channel-trailing-slash': 'error' } }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);

package/src/rules/async3/channels-kebab-case.ts

@@ -1,6 +1,6 @@
-import { Channel } from '../../typings/asyncapi3';
-import { Async3Rule } from '../../visitors';
-import { UserContext } from '../../walk';
+import type { Channel } from '../../typings/asyncapi3';
+import type { Async3Rule } from '../../visitors';
+import type { UserContext } from '../../walk';
 
 export const ChannelsKebabCase: Async3Rule = () => {
   return {

package/src/rules/async3/index.ts

@@ -1,18 +1,21 @@
-import { Async3Rule } from '../../visitors';
 import { Assertions } from '../common/assertions';
 import { Spec } from '../common/spec';
 import { InfoContact } from '../common/info-contact';
+import { InfoLicenseStrict } from '../common/info-license-strict';
 import { OperationOperationId } from '../common/operation-operationId';
 import { TagDescription } from '../common/tag-description';
 import { TagsAlphabetical } from '../common/tags-alphabetical';
 import { ChannelsKebabCase } from './channels-kebab-case';
 import { NoChannelTrailingSlash } from './no-channel-trailing-slash';
+
+import type { Async3Rule } from '../../visitors';
 import type { Async3RuleSet } from '../../oas-types';
 
 export const rules: Async3RuleSet<'built-in'> = {
   spec: Spec as Async3Rule,
   assertions: Assertions as Async3Rule,
   'info-contact': InfoContact as Async3Rule,
+  'info-license-strict': InfoLicenseStrict as Async3Rule,
   'operation-operationId': OperationOperationId as Async3Rule,
   'channels-kebab-case': ChannelsKebabCase,
   'no-channel-trailing-slash': NoChannelTrailingSlash,

package/src/rules/async3/no-channel-trailing-slash.ts

@@ -1,6 +1,6 @@
-import { Async3Rule } from '../../visitors';
-import { UserContext } from '../../walk';
-import { Channel } from '../../typings/asyncapi3';
+import type { Async3Rule } from '../../visitors';
+import type { UserContext } from '../../walk';
+import type { Channel } from '../../typings/asyncapi3';
 
 export const NoChannelTrailingSlash: Async3Rule = () => {
   return {