@redocly/openapi-core 1.18.1 → 1.20.0

package/src/rules/oas3/no-empty-servers.ts

@@ -1,4 +1,4 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Rule } from '../../visitors';
 
 export const NoEmptyServers: Oas3Rule = () => {
   return {

package/src/rules/oas3/no-example-value-and-externalValue.ts

@@ -1,4 +1,4 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Rule } from '../../visitors';
 
 export const NoExampleValueAndExternalValue: Oas3Rule = () => {
   return {

package/src/rules/oas3/no-invalid-media-type-examples.ts

@@ -1,8 +1,10 @@
-import { Oas3Rule } from '../../visitors';
-import { Location, isRef } from '../../ref-utils';
-import { Oas3Example } from '../../typings/openapi';
+import { isRef } from '../../ref-utils';
 import { getAdditionalPropertiesOption, validateExample } from '../utils';
-import { UserContext } from '../../walk';
+
+import type { Oas3Rule } from '../../visitors';
+import type { Location } from '../../ref-utils';
+import type { Oas3Example } from '../../typings/openapi';
+import type { UserContext } from '../../walk';
 
 export const ValidContentExamples: Oas3Rule = (opts) => {
   const allowAdditionalProperties = getAdditionalPropertiesOption(opts) ?? false;

package/src/rules/oas3/no-server-example.com.ts

@@ -1,8 +1,9 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Rule } from '../../visitors';
 
 export const NoServerExample: Oas3Rule = () => {
   return {
     Server(server, { report, location }) {
+      // eslint-disable-next-line no-useless-escape
       const pattern = /^(.*[\/.])?(example\.com|localhost)([\/:?].*|$)/;
       if (server.url && pattern.test(server.url)) {
         report({

package/src/rules/oas3/no-server-trailing-slash.ts

@@ -1,4 +1,4 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Rule } from '../../visitors';
 
 export const NoServerTrailingSlash: Oas3Rule = () => {
   return {

package/src/rules/oas3/no-server-variables-empty-enum.ts

@@ -1,5 +1,5 @@
-import { Oas3Server } from 'core/src/typings/openapi';
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Server } from '../../typings/openapi';
+import type { Oas3Rule } from '../../visitors';
 
 enum enumError {
   empty = 'empty',

package/src/rules/oas3/no-undefined-server-variable.ts

@@ -1,4 +1,4 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Rule } from '../../visitors';
 
 export const NoUndefinedServerVariable: Oas3Rule = () => {
   return {

package/src/rules/oas3/no-unused-components.ts

@@ -1,5 +1,5 @@
-import { Oas3Rule } from '../../visitors';
-import { Location } from '../../ref-utils';
+import type { Oas3Rule } from '../../visitors';
+import type { Location } from '../../ref-utils';
 
 export const NoUnusedComponents: Oas3Rule = () => {
   const components = new Map<string, { used: boolean; location: Location; name: string }>();

package/src/rules/oas3/operation-4xx-problem-details-rfc7807.ts

@@ -1,6 +1,7 @@
+import { validateDefinedAndNonEmpty } from '../utils';
+
 import type { Oas3Rule } from '../../visitors';
 import type { UserContext } from '../../walk';
-import { validateDefinedAndNonEmpty } from '../utils';
 
 /**
  * Validation according to rfc7807 - https://datatracker.ietf.org/doc/html/rfc7807

package/src/rules/oas3/request-mime-type.ts

@@ -1,6 +1,7 @@
+import { validateMimeTypeOAS3 } from '../../utils';
+
 import type { Oas3Rule } from '../../visitors';
 import type { UserContext } from '../../walk';
-import { validateMimeTypeOAS3 } from '../../utils';
 
 export const RequestMimeType: Oas3Rule = ({ allowedValues }) => {
   return {

package/src/rules/oas3/response-contains-property.ts

@@ -1,7 +1,8 @@
-import { Oas3Rule } from '../../visitors';
-import { UserContext } from '../../walk';
 import { getMatchingStatusCodeRange } from '../../utils';
 
+import type { Oas3Rule } from '../../visitors';
+import type { UserContext } from '../../walk';
+
 export const ResponseContainsProperty: Oas3Rule = (options) => {
   const names: Record<string, string[]> = options.names || {};
   let key: string | number;

package/src/rules/oas3/response-mime-type.ts

@@ -1,6 +1,7 @@
+import { validateMimeTypeOAS3 } from '../../utils';
+
 import type { Oas3Rule } from '../../visitors';
 import type { UserContext } from '../../walk';
-import { validateMimeTypeOAS3 } from '../../utils';
 
 export const ResponseMimeType: Oas3Rule = ({ allowedValues }) => {
   return {

package/src/rules/oas3/spec-components-invalid-map-name.ts

@@ -1,6 +1,6 @@
-import { Oas3Rule } from '../../visitors';
-import { Problem, UserContext } from '../../walk';
-import { Location } from '../../ref-utils';
+import type { Oas3Rule } from '../../visitors';
+import type { Problem, UserContext } from '../../walk';
+import type { Location } from '../../ref-utils';
 
 export const SpecComponentsInvalidMapName: Oas3Rule = () => {
   const KEYS_REGEX = '^[a-zA-Z0-9\\.\\-_]+$';

package/src/rules/other/stats.ts

@@ -1,6 +1,6 @@
-import { Oas3Parameter, OasRef, Oas3Tag } from '../../typings/openapi';
-import { Oas2Parameter } from '../../typings/swagger';
-import { StatsAccumulator } from '../../typings/common';
+import type { Oas3Parameter, OasRef, Oas3Tag } from '../../typings/openapi';
+import type { Oas2Parameter } from '../../typings/swagger';
+import type { StatsAccumulator } from '../../typings/common';
 
 export const Stats = (statsAccumulator: StatsAccumulator) => {
   return {
@@ -35,9 +35,11 @@ export const Stats = (statsAccumulator: StatsAccumulator) => {
     WebhooksMap: {
       Operation: {
         leave(operation: any) {
-          operation.tags.forEach((tag: string) => {
-            statsAccumulator.tags.items!.add(tag);
-          });
+          statsAccumulator.webhooks.total++;
+          operation.tags &&
+            operation.tags.forEach((tag: string) => {
+              statsAccumulator.tags.items!.add(tag);
+            });
         },
       },
     },

package/src/rules/spot/parameters-no-body-inside-in.ts

@@ -0,0 +1,17 @@
+import type { ArazzoRule } from '../../visitors';
+import type { UserContext } from '../../walk';
+
+export const ParametersNoBodyInsideIn: ArazzoRule = () => {
+  return {
+    Parameter: {
+      enter(parameter, { report, location }: UserContext) {
+        if (parameter.in === 'body') {
+          report({
+            message: 'The `body` value of the `in` property is not supported by Spot.',
+            location: location.child(['in']),
+          });
+        }
+      },
+    },
+  };
+};

package/src/rules/utils.ts

@@ -1,9 +1,14 @@
 import levenshtein = require('js-levenshtein');
-import { UserContext } from '../walk';
 import { Location } from '../ref-utils';
 import { validateJsonSchema } from './ajv';
-import { Oas3Schema, Oas3_1Schema, Referenced } from '../typings/openapi';
-import { showErrorForDeprecatedField, showWarningForDeprecatedField } from '../utils';
+import {
+  isPlainObject,
+  showErrorForDeprecatedField,
+  showWarningForDeprecatedField,
+} from '../utils';
+
+import type { Oas3Schema, Oas3_1Schema, Referenced } from '../typings/openapi';
+import type { UserContext } from '../walk';
 
 export function oasTypeOf(value: unknown) {
   if (Array.isArray(value)) {
@@ -47,12 +52,18 @@ export function missingRequiredField(type: string, field: string): string {
   return `${type} object should contain \`${field}\` field.`;
 }
 
+export function missingRequiredOneOfFields(type: string, fields: string[]): string {
+  return `${type} object should contain one of the fields: ${fields
+    .map((field) => `\`${field}\``)
+    .join(', ')}.`;
+}
+
 export function fieldNonEmpty(type: string, field: string): string {
   return `${type} object \`${field}\` must be non-empty string.`;
 }
 
 export function validateDefinedAndNonEmpty(fieldName: string, value: any, ctx: UserContext) {
-  if (typeof value !== 'object') {
+  if (!isPlainObject(value)) {
     return;
   }
 
@@ -69,6 +80,32 @@ export function validateDefinedAndNonEmpty(fieldName: string, value: any, ctx: U
   }
 }
 
+export function validateOneOfDefinedAndNonEmpty(
+  fieldNames: string[],
+  value: any,
+  ctx: UserContext
+) {
+  if (!isPlainObject(value)) {
+    return;
+  }
+
+  if (!fieldNames.some((fieldName) => value.hasOwnProperty(fieldName))) {
+    ctx.report({
+      message: missingRequiredOneOfFields(ctx.type.name, fieldNames),
+      location: ctx.location.key(),
+    });
+  }
+
+  for (const fieldName of fieldNames) {
+    if (value.hasOwnProperty(fieldName) && !value[fieldName]) {
+      ctx.report({
+        message: fieldNonEmpty(ctx.type.name, fieldName),
+        location: ctx.location.child([fieldName]).key(),
+      });
+    }
+  }
+}
+
 export function getSuggest(given: string, variants: string[]): string[] {
   if (given === null) return variants;