@redocly/openapi-core 1.19.0 → 1.20.0

package/lib/rules/common/tag-description.d.ts

@@ -1,2 +1,2 @@
-import { Oas3Rule, Oas2Rule } from '../../visitors';
+import type { Oas3Rule, Oas2Rule } from '../../visitors';
 export declare const TagDescription: Oas3Rule | Oas2Rule;

package/lib/rules/common/tags-alphabetical.d.ts

@@ -1,2 +1,2 @@
-import { Oas3Rule, Oas2Rule } from '../../visitors';
+import type { Oas3Rule, Oas2Rule } from '../../visitors';
 export declare const TagsAlphabetical: Oas3Rule | Oas2Rule;

package/lib/rules/no-unresolved-refs.d.ts

@@ -1,5 +1,5 @@
-import { Oas3Rule } from '../visitors';
-import { ResolveResult, Problem } from '../walk';
-import { Location } from '../ref-utils';
+import type { Oas3Rule } from '../visitors';
+import type { ResolveResult, Problem } from '../walk';
+import type { Location } from '../ref-utils';
 export declare const NoUnresolvedRefs: Oas3Rule;
 export declare function reportUnresolvedRef(resolved: ResolveResult<any>, report: (m: Problem) => void, location: Location): void;

package/lib/rules/oas2/boolean-parameter-prefixes.d.ts

@@ -1,4 +1,4 @@
-import { Oas2Rule } from '../../visitors';
+import type { Oas2Rule } from '../../visitors';
 export type BooleanParameterPrefixesOptions = {
     prefixes?: string[];
 };

package/lib/rules/oas2/index.d.ts

@@ -1,3 +1,3 @@
-import type { Oas2RuleSet } from 'core/src/oas-types';
+import type { Oas2RuleSet } from '../../oas-types';
 export declare const rules: Oas2RuleSet<'built-in'>;
 export declare const preprocessors: {};

package/lib/rules/oas2/index.js

@@ -7,6 +7,7 @@ const no_invalid_parameter_examples_1 = require("../common/no-invalid-parameter-
 const info_contact_1 = require("../common/info-contact");
 const info_license_1 = require("../common/info-license");
 const info_license_url_1 = require("../common/info-license-url");
+const info_license_strict_1 = require("../common/info-license-strict");
 const boolean_parameter_prefixes_1 = require("./boolean-parameter-prefixes");
 const tag_description_1 = require("../common/tag-description");
 const tags_alphabetical_1 = require("../common/tags-alphabetical");
@@ -51,6 +52,7 @@ exports.rules = {
     'info-contact': info_contact_1.InfoContact,
     'info-license': info_license_1.InfoLicense,
     'info-license-url': info_license_url_1.InfoLicenseUrl,
+    'info-license-strict': info_license_strict_1.InfoLicenseStrict,
     'tag-description': tag_description_1.TagDescription,
     'tags-alphabetical': tags_alphabetical_1.TagsAlphabetical,
     'paths-kebab-case': paths_kebab_case_1.PathsKebabCase,

package/lib/rules/oas2/response-contains-property.d.ts

@@ -1,2 +1,2 @@
-import { Oas2Rule } from '../../visitors';
+import type { Oas2Rule } from '../../visitors';
 export declare const ResponseContainsProperty: Oas2Rule;

package/lib/rules/oas3/array-parameter-serialization.d.ts

@@ -1,4 +1,4 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Rule } from '../../visitors';
 export type ArrayParameterSerializationOptions = {
     in?: string[];
 };

package/lib/rules/oas3/boolean-parameter-prefixes.d.ts

@@ -1,4 +1,4 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Rule } from '../../visitors';
 export type BooleanParameterPrefixesOptions = {
     prefixes?: string[];
 };

package/lib/rules/oas3/component-name-unique.d.ts

@@ -1,2 +1,2 @@
-import { Oas2Rule, Oas3Rule } from '../../visitors';
+import type { Oas2Rule, Oas3Rule } from '../../visitors';
 export declare const ComponentNameUnique: Oas3Rule | Oas2Rule;

package/lib/rules/oas3/index.d.ts

@@ -1,3 +1,3 @@
-import { Oas3RuleSet } from '../../oas-types';
+import type { Oas3RuleSet } from '../../oas-types';
 export declare const rules: Oas3RuleSet<'built-in'>;
 export declare const preprocessors: {};

package/lib/rules/oas3/index.js

@@ -21,6 +21,7 @@ const tag_description_1 = require("../common/tag-description");
 const info_contact_1 = require("../common/info-contact");
 const info_license_1 = require("../common/info-license");
 const info_license_url_1 = require("../common/info-license-url");
+const info_license_strict_1 = require("../common/info-license-strict");
 const operation_description_1 = require("../common/operation-description");
 const no_unused_components_1 = require("./no-unused-components");
 const path_not_include_query_1 = require("../common/path-not-include-query");
@@ -61,6 +62,7 @@ exports.rules = {
     'info-contact': info_contact_1.InfoContact,
     'info-license': info_license_1.InfoLicense,
     'info-license-url': info_license_url_1.InfoLicenseUrl,
+    'info-license-strict': info_license_strict_1.InfoLicenseStrict,
     'operation-2xx-response': operation_2xx_response_1.Operation2xxResponse,
     'operation-4xx-response': operation_4xx_response_1.Operation4xxResponse,
     'operation-4xx-problem-details-rfc7807': operation_4xx_problem_details_rfc7807_1.Operation4xxProblemDetailsRfc7807,

package/lib/rules/oas3/no-empty-servers.d.ts

@@ -1,2 +1,2 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Rule } from '../../visitors';
 export declare const NoEmptyServers: Oas3Rule;

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

@@ -1,2 +1,2 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Rule } from '../../visitors';
 export declare const NoExampleValueAndExternalValue: Oas3Rule;

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

@@ -1,2 +1,2 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Rule } from '../../visitors';
 export declare const ValidContentExamples: Oas3Rule;

package/lib/rules/oas3/no-server-example.com.d.ts

@@ -1,2 +1,2 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Rule } from '../../visitors';
 export declare const NoServerExample: Oas3Rule;

package/lib/rules/oas3/no-server-example.com.js

@@ -4,6 +4,7 @@ exports.NoServerExample = void 0;
 const NoServerExample = () => {
     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/lib/rules/oas3/no-server-trailing-slash.d.ts

@@ -1,2 +1,2 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Rule } from '../../visitors';
 export declare const NoServerTrailingSlash: Oas3Rule;

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

@@ -1,2 +1,2 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Rule } from '../../visitors';
 export declare const NoServerVariablesEmptyEnum: Oas3Rule;

package/lib/rules/oas3/no-undefined-server-variable.d.ts

@@ -1,2 +1,2 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Rule } from '../../visitors';
 export declare const NoUndefinedServerVariable: Oas3Rule;

package/lib/rules/oas3/no-unused-components.d.ts

@@ -1,2 +1,2 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Rule } from '../../visitors';
 export declare const NoUnusedComponents: Oas3Rule;

package/lib/rules/oas3/response-contains-property.d.ts

@@ -1,2 +1,2 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Rule } from '../../visitors';
 export declare const ResponseContainsProperty: Oas3Rule;

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

@@ -1,2 +1,2 @@
-import { Oas3Rule } from '../../visitors';
+import type { Oas3Rule } from '../../visitors';
 export declare const SpecComponentsInvalidMapName: Oas3Rule;

package/lib/rules/other/stats.d.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 declare const Stats: (statsAccumulator: StatsAccumulator) => {
     ExternalDocs: {
         leave(): void;

package/lib/rules/other/stats.js

@@ -34,9 +34,11 @@ const Stats = (statsAccumulator) => {
         WebhooksMap: {
             Operation: {
                 leave(operation) {
-                    operation.tags.forEach((tag) => {
-                        statsAccumulator.tags.items.add(tag);
-                    });
+                    statsAccumulator.webhooks.total++;
+                    operation.tags &&
+                        operation.tags.forEach((tag) => {
+                            statsAccumulator.tags.items.add(tag);
+                        });
                 },
             },
         },

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

@@ -0,0 +1,2 @@
+import type { ArazzoRule } from '../../visitors';
+export declare const ParametersNoBodyInsideIn: ArazzoRule;

package/lib/rules/spot/parameters-no-body-inside-in.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParametersNoBodyInsideIn = void 0;
+const ParametersNoBodyInsideIn = () => {
+    return {
+        Parameter: {
+            enter(parameter, { report, location }) {
+                if (parameter.in === 'body') {
+                    report({
+                        message: 'The `body` value of the `in` property is not supported by Spot.',
+                        location: location.child(['in']),
+                    });
+                }
+            },
+        },
+    };
+};
+exports.ParametersNoBodyInsideIn = ParametersNoBodyInsideIn;

package/lib/rules/utils.d.ts

@@ -1,6 +1,6 @@
-import { UserContext } from '../walk';
 import { Location } from '../ref-utils';
-import { Oas3Schema, Oas3_1Schema, Referenced } from '../typings/openapi';
+import type { Oas3Schema, Oas3_1Schema, Referenced } from '../typings/openapi';
+import type { UserContext } from '../walk';
 export declare function oasTypeOf(value: unknown): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "integer" | "array" | "null";
 /**
  * Checks if value matches specified JSON schema type
@@ -11,8 +11,10 @@ export declare function oasTypeOf(value: unknown): "string" | "number" | "bigint
  */
 export declare function matchesJsonSchemaType(value: unknown, type: string, nullable: boolean): boolean;
 export declare function missingRequiredField(type: string, field: string): string;
+export declare function missingRequiredOneOfFields(type: string, fields: string[]): string;
 export declare function fieldNonEmpty(type: string, field: string): string;
 export declare function validateDefinedAndNonEmpty(fieldName: string, value: any, ctx: UserContext): void;
+export declare function validateOneOfDefinedAndNonEmpty(fieldNames: string[], value: any, ctx: UserContext): void;
 export declare function getSuggest(given: string, variants: string[]): string[];
 export declare function validateExample(example: any, schema: Referenced<Oas3Schema | Oas3_1Schema>, dataLoc: Location, { resolve, location, report }: UserContext, allowAdditionalProperties: boolean): void;
 export declare function getAdditionalPropertiesOption(opts: Record<string, any>): boolean;

package/lib/rules/utils.js

@@ -3,8 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.oasTypeOf = oasTypeOf;
 exports.matchesJsonSchemaType = matchesJsonSchemaType;
 exports.missingRequiredField = missingRequiredField;
+exports.missingRequiredOneOfFields = missingRequiredOneOfFields;
 exports.fieldNonEmpty = fieldNonEmpty;
 exports.validateDefinedAndNonEmpty = validateDefinedAndNonEmpty;
+exports.validateOneOfDefinedAndNonEmpty = validateOneOfDefinedAndNonEmpty;
 exports.getSuggest = getSuggest;
 exports.validateExample = validateExample;
 exports.getAdditionalPropertiesOption = getAdditionalPropertiesOption;
@@ -55,11 +57,16 @@ function matchesJsonSchemaType(value, type, nullable) {
 function missingRequiredField(type, field) {
     return `${type} object should contain \`${field}\` field.`;
 }
+function missingRequiredOneOfFields(type, fields) {
+    return `${type} object should contain one of the fields: ${fields
+        .map((field) => `\`${field}\``)
+        .join(', ')}.`;
+}
 function fieldNonEmpty(type, field) {
     return `${type} object \`${field}\` must be non-empty string.`;
 }
 function validateDefinedAndNonEmpty(fieldName, value, ctx) {
-    if (typeof value !== 'object') {
+    if (!(0, utils_1.isPlainObject)(value)) {
         return;
     }
     if (value[fieldName] === undefined) {
@@ -75,6 +82,25 @@ function validateDefinedAndNonEmpty(fieldName, value, ctx) {
         });
     }
 }
+function validateOneOfDefinedAndNonEmpty(fieldNames, value, ctx) {
+    if (!(0, utils_1.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(),
+            });
+        }
+    }
+}
 function getSuggest(given, variants) {
     if (given === null)
         return variants;