@redocly/openapi-core 1.0.0-beta.96 → 1.0.0-beta.99

package/lib/bundle.d.ts

@@ -18,6 +18,7 @@ export declare function bundle(opts: {
     base?: string;
     skipRedoclyRegistryRefs?: boolean;
     removeUnusedComponents?: boolean;
+    keepUrlRefs?: boolean;
 }): Promise<{
     bundle: Document;
     problems: import("./walk").NormalizedProblem[];
@@ -34,6 +35,7 @@ export declare function bundleDocument(opts: {
     dereference?: boolean;
     skipRedoclyRegistryRefs?: boolean;
     removeUnusedComponents?: boolean;
+    keepUrlRefs?: boolean;
 }): Promise<{
     bundle: Document;
     problems: import("./walk").NormalizedProblem[];

package/lib/bundle.js

@@ -48,7 +48,7 @@ function bundle(opts) {
 exports.bundle = bundle;
 function bundleDocument(opts) {
     return __awaiter(this, void 0, void 0, function* () {
-        const { document, config, customTypes, externalRefResolver, dereference = false, skipRedoclyRegistryRefs = false, removeUnusedComponents = false, } = opts;
+        const { document, config, customTypes, externalRefResolver, dereference = false, skipRedoclyRegistryRefs = false, removeUnusedComponents = false, keepUrlRefs = false, } = opts;
         const oasVersion = oas_types_1.detectOpenAPI(document.parsed);
         const oasMajorVersion = oas_types_1.openAPIMajor(oasVersion);
         const rules = config.getRulesForOasVersion(oasMajorVersion);
@@ -84,7 +84,7 @@ function bundleDocument(opts) {
             {
                 severity: 'error',
                 ruleId: 'bundler',
-                visitor: makeBundleVisitor(oasMajorVersion, dereference, skipRedoclyRegistryRefs, document, resolvedRefMap),
+                visitor: makeBundleVisitor(oasMajorVersion, dereference, skipRedoclyRegistryRefs, document, resolvedRefMap, keepUrlRefs),
             },
             ...decorators,
         ], types);
@@ -146,7 +146,7 @@ function mapTypeToComponent(typeName, version) {
 }
 exports.mapTypeToComponent = mapTypeToComponent;
 // function oas3Move
-function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDocument, resolvedRefMap) {
+function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDocument, resolvedRefMap, keepUrlRefs) {
     let components;
     const visitor = {
         ref: {
@@ -165,6 +165,9 @@ function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDo
                 if (skipRedoclyRegistryRefs && redocly_1.isRedoclyRegistryURL(node.$ref)) {
                     return;
                 }
+                if (keepUrlRefs && ref_utils_1.isAbsoluteUrl(node.$ref)) {
+                    return;
+                }
                 const componentType = mapTypeToComponent(ctx.type.name, version);
                 if (!componentType) {
                     replaceRef(node, resolved, ctx);

package/lib/config/all.js

@@ -41,6 +41,7 @@ exports.default = {
         spec: 'error',
         'no-invalid-schema-examples': 'error',
         'no-invalid-parameter-examples': 'error',
+        'scalar-property-missing-example': 'error',
     },
     oas3_0Rules: {
         'no-invalid-media-type-examples': 'error',

package/lib/config/config-resolvers.d.ts

@@ -8,7 +8,7 @@ export declare function resolveApis({ rawConfig, configPath, resolver, }: {
     configPath?: string;
     resolver?: BaseResolver;
 }): Promise<Record<string, ResolvedApi>>;
-export declare function resolveLint({ lintConfig, configPath, resolver, }: {
+export declare function resolveLint(lintOpts: {
     lintConfig?: LintRawConfig;
     configPath?: string;
     resolver?: BaseResolver;

package/lib/config/config-resolvers.js

@@ -141,7 +141,7 @@ function resolveApis({ rawConfig, configPath = '', resolver, }) {
     });
 }
 exports.resolveApis = resolveApis;
-function resolveLint({ lintConfig, configPath = '', resolver = new resolve_1.BaseResolver(), }, parentConfigPaths = [], extendPaths = []) {
+function resolveAndMergeNestedLint({ lintConfig, configPath = '', resolver = new resolve_1.BaseResolver(), }, parentConfigPaths = [], extendPaths = []) {
     var _a, _b, _c;
     return __awaiter(this, void 0, void 0, function* () {
         if (parentConfigPaths.includes(configPath)) {
@@ -162,7 +162,7 @@ function resolveLint({ lintConfig, configPath = '', resolver = new resolve_1.Bas
                     ? new URL(presetItem, configPath).href
                     : path.resolve(path.dirname(configPath), presetItem);
             const extendedLintConfig = yield loadExtendLintConfig(pathItem, resolver);
-            return yield resolveLint({
+            return yield resolveAndMergeNestedLint({
                 lintConfig: extendedLintConfig,
                 configPath: pathItem,
                 resolver: resolver,
@@ -175,6 +175,12 @@ function resolveLint({ lintConfig, configPath = '', resolver = new resolve_1.Bas
         return Object.assign(Object.assign({}, lint), { extendPaths: (_c = lint.extendPaths) === null || _c === void 0 ? void 0 : _c.filter((path) => path && !ref_utils_1.isAbsoluteUrl(path)), plugins: utils_1.getUniquePlugins(mergedPlugins), recommendedFallback: lintConfig === null || lintConfig === void 0 ? void 0 : lintConfig.recommendedFallback, doNotResolveExamples: lintConfig === null || lintConfig === void 0 ? void 0 : lintConfig.doNotResolveExamples });
     });
 }
+function resolveLint(lintOpts, parentConfigPaths = [], extendPaths = []) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const resolvedLint = yield resolveAndMergeNestedLint(lintOpts, parentConfigPaths, extendPaths);
+        return Object.assign(Object.assign({}, resolvedLint), { rules: resolvedLint.rules && groupLintAssertionRules(resolvedLint.rules) });
+    });
+}
 exports.resolveLint = resolveLint;
 function resolvePreset(presetName, plugins) {
     var _a;
@@ -211,3 +217,26 @@ function getMergedLintRawConfig(configLint, apiLint) {
     const resultLint = Object.assign(Object.assign(Object.assign({}, configLint), apiLint), { rules: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.rules), apiLint === null || apiLint === void 0 ? void 0 : apiLint.rules), oas2Rules: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas2Rules), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas2Rules), oas3_0Rules: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas3_0Rules), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas3_0Rules), oas3_1Rules: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas3_1Rules), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas3_1Rules), preprocessors: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.preprocessors), apiLint === null || apiLint === void 0 ? void 0 : apiLint.preprocessors), oas2Preprocessors: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas2Preprocessors), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas2Preprocessors), oas3_0Preprocessors: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas3_0Preprocessors), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas3_0Preprocessors), oas3_1Preprocessors: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas3_1Preprocessors), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas3_1Preprocessors), decorators: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.decorators), apiLint === null || apiLint === void 0 ? void 0 : apiLint.decorators), oas2Decorators: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas2Decorators), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas2Decorators), oas3_0Decorators: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas3_0Decorators), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas3_0Decorators), oas3_1Decorators: Object.assign(Object.assign({}, configLint === null || configLint === void 0 ? void 0 : configLint.oas3_1Decorators), apiLint === null || apiLint === void 0 ? void 0 : apiLint.oas3_1Decorators), recommendedFallback: (apiLint === null || apiLint === void 0 ? void 0 : apiLint.extends) ? false : configLint.recommendedFallback });
     return resultLint;
 }
+function groupLintAssertionRules(rules) {
+    if (!rules) {
+        return rules;
+    }
+    // Create a new record to avoid mutating original
+    const transformedRules = {};
+    // Collect assertion rules
+    const assertions = [];
+    for (const [ruleKey, rule] of Object.entries(rules)) {
+        if (ruleKey.startsWith('assert/') && typeof rule === 'object' && rule !== null) {
+            const assertion = rule;
+            assertions.push(Object.assign(Object.assign({}, assertion), { assertionId: ruleKey.replace('assert/', '') }));
+        }
+        else {
+            // If it's not an assertion, keep it as is
+            transformedRules[ruleKey] = rule;
+        }
+    }
+    if (assertions.length > 0) {
+        transformedRules.assertions = assertions;
+    }
+    return transformedRules;
+}

package/lib/config/config.d.ts

@@ -1,11 +1,14 @@
+/// <reference types="node" />
 import { NormalizedProblem } from '../walk';
 import { OasVersion, OasMajorVersion, Oas2RuleSet, Oas3RuleSet } from '../oas-types';
 import type { NodeType } from '../types';
 import type { DecoratorConfig, Plugin, PreprocessorConfig, Region, ResolveConfig, ResolvedApi, ResolvedConfig, ResolvedLintConfig, RuleConfig } from './types';
+export declare const env: NodeJS.ProcessEnv;
 export declare const IGNORE_FILE = ".redocly.lint-ignore.yaml";
 export declare const DEFAULT_REGION = "us";
 export declare const DOMAINS: {
-    [region in Region]: string;
+    us: string;
+    eu: string;
 };
 export declare const AVAILABLE_REGIONS: Region[];
 export declare class LintConfig {

package/lib/config/config.js

@@ -1,28 +1,34 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Config = exports.LintConfig = exports.AVAILABLE_REGIONS = exports.DOMAINS = exports.DEFAULT_REGION = exports.IGNORE_FILE = void 0;
+exports.Config = exports.LintConfig = exports.AVAILABLE_REGIONS = exports.DOMAINS = exports.DEFAULT_REGION = exports.IGNORE_FILE = exports.env = void 0;
 const fs = require("fs");
 const path = require("path");
 const js_yaml_1 = require("../js-yaml");
 const utils_1 = require("../utils");
 const oas_types_1 = require("../oas-types");
 const utils_2 = require("./utils");
+// Alias environment here so this file can work in browser environments too.
+exports.env = typeof process !== 'undefined' ? process.env || {} : {};
 exports.IGNORE_FILE = '.redocly.lint-ignore.yaml';
 const IGNORE_BANNER = `# This file instructs Redocly's linter to ignore the rules contained for specific parts of your API.\n` +
     `# See https://redoc.ly/docs/cli/ for more information.\n`;
 exports.DEFAULT_REGION = 'us';
-const REDOCLY_DOMAIN = process.env.REDOCLY_DOMAIN;
-exports.DOMAINS = {
-    us: 'redocly.com',
-    eu: 'eu.redocly.com',
-};
-// FIXME: temporary fix for our lab environments
-if (REDOCLY_DOMAIN === null || REDOCLY_DOMAIN === void 0 ? void 0 : REDOCLY_DOMAIN.endsWith('.redocly.host')) {
-    exports.DOMAINS[REDOCLY_DOMAIN.split('.')[0]] = REDOCLY_DOMAIN;
-}
-if (REDOCLY_DOMAIN === 'redoc.online') {
-    exports.DOMAINS[REDOCLY_DOMAIN] = REDOCLY_DOMAIN;
+function getDomains() {
+    const domains = {
+        us: 'redocly.com',
+        eu: 'eu.redocly.com',
+    };
+    // FIXME: temporary fix for our lab environments
+    const domain = exports.env.REDOCLY_DOMAIN;
+    if (domain === null || domain === void 0 ? void 0 : domain.endsWith('.redocly.host')) {
+        domains[domain.split('.')[0]] = domain;
+    }
+    if (domain === 'redoc.online') {
+        domains[domain] = domain;
+    }
+    return domains;
 }
+exports.DOMAINS = getDomains();
 exports.AVAILABLE_REGIONS = Object.keys(exports.DOMAINS);
 class LintConfig {
     constructor(rawConfig, configFile) {

package/lib/format/format.js

@@ -5,6 +5,7 @@ const path = require("path");
 const colorette_1 = require("colorette");
 const coreVersion = require('../../package.json').version;
 const codeframes_1 = require("./codeframes");
+const config_1 = require("../config");
 const ERROR_MESSAGE = {
     INVALID_SEVERITY_LEVEL: 'Invalid severity level; accepted values: error or warn',
 };
@@ -131,7 +132,7 @@ function formatProblems(problems, opts) {
                         ? Object.assign(Object.assign({}, p.from), { source: {
                                 ref: path.relative(cwd, ((_a = p.from) === null || _a === void 0 ? void 0 : _a.source.absoluteRef) || cwd),
                             } }) : undefined });
-                if (process.env.FORMAT_JSON_WITH_CODEFRAMES) {
+                if (config_1.env.FORMAT_JSON_WITH_CODEFRAMES) {
                     const location = p.location[0]; // TODO: support multiple locations
                     const loc = codeframes_1.getLineColLocation(location);
                     problem.codeframe = codeframes_1.getCodeframe(loc, color);

package/lib/redocly/index.js

@@ -18,27 +18,21 @@ const registry_api_1 = require("./registry-api");
 const config_1 = require("../config/config");
 const utils_1 = require("../utils");
 const TOKEN_FILENAME = '.redocly-config.json';
-let REDOCLY_DOMAIN; // workaround for the isRedoclyRegistryURL, see more below
 class RedoclyClient {
     constructor(region) {
         this.accessTokens = {};
         this.region = this.loadRegion(region);
         this.loadTokens();
-        this.domain = region ? config_1.DOMAINS[region] : process.env.REDOCLY_DOMAIN || config_1.DOMAINS[config_1.DEFAULT_REGION];
-        /*
-         * We can't use process.env here because it is replaced by a const in some client-side bundles,
-         * which breaks assignment.
-         */
-        REDOCLY_DOMAIN = this.domain; // isRedoclyRegistryURL depends on the value to be set
+        this.domain = region ? config_1.DOMAINS[region] : config_1.env.REDOCLY_DOMAIN || config_1.DOMAINS[config_1.DEFAULT_REGION];
+        config_1.env.REDOCLY_DOMAIN = this.domain; // isRedoclyRegistryURL depends on the value to be set
         this.registryApi = new registry_api_1.RegistryApi(this.accessTokens, this.region);
     }
     loadRegion(region) {
         if (region && !config_1.DOMAINS[region]) {
-            process.stdout.write(colorette_1.red(`Invalid argument: region in config file.\nGiven: ${colorette_1.green(region)}, choices: "us", "eu".\n`));
-            process.exit(1);
+            throw new Error(`Invalid argument: region in config file.\nGiven: ${colorette_1.green(region)}, choices: "us", "eu".`);
         }
-        if (process.env.REDOCLY_DOMAIN) {
-            return (config_1.AVAILABLE_REGIONS.find((region) => config_1.DOMAINS[region] === process.env.REDOCLY_DOMAIN) || config_1.DEFAULT_REGION);
+        if (config_1.env.REDOCLY_DOMAIN) {
+            return (config_1.AVAILABLE_REGIONS.find((region) => config_1.DOMAINS[region] === config_1.env.REDOCLY_DOMAIN) || config_1.DEFAULT_REGION);
         }
         return region || config_1.DEFAULT_REGION;
     }
@@ -54,13 +48,7 @@ class RedoclyClient {
     }
     getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
-            const token = this.accessTokens[this.region];
-            // print this only if there is token but invalid
-            if (token && !this.isAuthorizedWithRedoclyByRegion()) {
-                process.stderr.write(`${colorette_1.yellow('Warning:')} invalid Redocly API key. Use "npx @redocly/cli login" to provide your API key\n`);
-                return undefined;
-            }
-            return token;
+            return this.accessTokens[this.region];
         });
     }
     // </backward compatibility: portal>
@@ -76,8 +64,8 @@ class RedoclyClient {
                 [this.region]: credentials.token,
             })));
         }
-        if (process.env.REDOCLY_AUTHORIZATION) {
-            this.setAccessTokens(Object.assign(Object.assign({}, this.accessTokens), { [this.region]: process.env.REDOCLY_AUTHORIZATION }));
+        if (config_1.env.REDOCLY_AUTHORIZATION) {
+            this.setAccessTokens(Object.assign(Object.assign({}, this.accessTokens), { [this.region]: config_1.env.REDOCLY_AUTHORIZATION }));
         }
     }
     getAllTokens() {
@@ -133,19 +121,16 @@ class RedoclyClient {
     login(accessToken, verbose = false) {
         return __awaiter(this, void 0, void 0, function* () {
             const credentialsPath = path_1.resolve(os_1.homedir(), TOKEN_FILENAME);
-            process.stdout.write(colorette_1.gray('\n  Logging in...\n'));
             try {
                 yield this.verifyToken(accessToken, this.region, verbose);
             }
             catch (err) {
-                process.stdout.write(colorette_1.red('Authorization failed. Please check if you entered a valid API key.\n'));
-                process.exit(1);
+                throw new Error('Authorization failed. Please check if you entered a valid API key.');
             }
             const credentials = Object.assign(Object.assign({}, this.readCredentialsFile(credentialsPath)), { [this.region]: accessToken, token: accessToken });
             this.accessTokens = credentials;
             this.registryApi.setAccessTokens(credentials);
             fs_1.writeFileSync(credentialsPath, JSON.stringify(credentials, null, 2));
-            process.stdout.write(colorette_1.green('  Authorization confirmed. ✅\n\n'));
         });
     }
     logout() {
@@ -153,12 +138,11 @@ class RedoclyClient {
         if (fs_1.existsSync(credentialsPath)) {
             fs_1.unlinkSync(credentialsPath);
         }
-        process.stdout.write('Logged out from the Redocly account. ✋\n');
     }
 }
 exports.RedoclyClient = RedoclyClient;
 function isRedoclyRegistryURL(link) {
-    const domain = REDOCLY_DOMAIN || process.env.REDOCLY_DOMAIN || config_1.DOMAINS[config_1.DEFAULT_REGION];
+    const domain = config_1.env.REDOCLY_DOMAIN || config_1.DOMAINS[config_1.DEFAULT_REGION];
     const legacyDomain = domain === 'redocly.com' ? 'redoc.ly' : domain;
     if (!link.startsWith(`https://api.${domain}/registry/`) &&
         !link.startsWith(`https://api.${legacyDomain}/registry/`)) {

package/lib/redocly/registry-api-types.d.ts

@@ -14,6 +14,7 @@ export declare namespace RegistryApiTypes {
         filePaths: string[];
         branch?: string;
         isUpsert?: boolean;
+        isPublic?: boolean;
     }
     export interface PrepareFileuploadOKResponse {
         filePath: string;

package/lib/redocly/registry-api.d.ts

@@ -13,5 +13,5 @@ export declare class RegistryApi {
         organizations: string[];
     }>;
     prepareFileUpload({ organizationId, name, version, filesHash, filename, isUpsert, }: RegistryApiTypes.PrepareFileuploadParams): Promise<RegistryApiTypes.PrepareFileuploadOKResponse>;
-    pushApi({ organizationId, name, version, rootFilePath, filePaths, branch, isUpsert, }: RegistryApiTypes.PushApiParams): Promise<void>;
+    pushApi({ organizationId, name, version, rootFilePath, filePaths, branch, isUpsert, isPublic, }: RegistryApiTypes.PushApiParams): Promise<void>;
 }

package/lib/redocly/registry-api.js

@@ -80,7 +80,7 @@ class RegistryApi {
             throw new Error('Could not prepare file upload');
         });
     }
-    pushApi({ organizationId, name, version, rootFilePath, filePaths, branch, isUpsert, }) {
+    pushApi({ organizationId, name, version, rootFilePath, filePaths, branch, isUpsert, isPublic, }) {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield this.request(`/${organizationId}/${name}/${version}`, {
                 method: 'PUT',
@@ -93,6 +93,7 @@ class RegistryApi {
                     filePaths,
                     branch,
                     isUpsert,
+                    isPublic,
                 }),
             }, this.region);
             if (response.ok) {

package/lib/ref-utils.js

@@ -67,6 +67,7 @@ function isMappingRef(mapping) {
     // TODO: proper detection of mapping refs
     return (mapping.startsWith('#') ||
         mapping.startsWith('https://') ||
+        mapping.startsWith('http://') ||
         mapping.startsWith('./') ||
         mapping.startsWith('../') ||
         mapping.indexOf('/') > -1);

package/lib/rules/common/response-contains-header.d.ts

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

package/lib/rules/common/response-contains-header.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseContainsHeader = void 0;
+const utils_1 = require("../../utils");
+const ResponseContainsHeader = (options) => {
+    const names = options.names || {};
+    return {
+        Operation: {
+            Response: {
+                enter: (response, { report, location, key }) => {
+                    var _a;
+                    const expectedHeaders = names[key] ||
+                        names[utils_1.getMatchingStatusCodeRange(key)] ||
+                        names[utils_1.getMatchingStatusCodeRange(key).toLowerCase()] ||
+                        [];
+                    for (const expectedHeader of expectedHeaders) {
+                        if (!((_a = response.headers) === null || _a === void 0 ? void 0 : _a[expectedHeader])) {
+                            report({
+                                message: `Response object must contain a "${expectedHeader}" header.`,
+                                location: location.child('headers').key(),
+                            });
+                        }
+                    }
+                },
+            },
+        },
+    };
+};
+exports.ResponseContainsHeader = ResponseContainsHeader;

package/lib/rules/common/scalar-property-missing-example.d.ts

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

package/lib/rules/common/scalar-property-missing-example.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScalarPropertyMissingExample = void 0;
+const oas_types_1 = require("../../oas-types");
+const SCALAR_TYPES = ['string', 'integer', 'number', 'boolean', 'null'];
+const ScalarPropertyMissingExample = () => {
+    return {
+        SchemaProperties(properties, { report, location, oasVersion, resolve }) {
+            for (const propName of Object.keys(properties)) {
+                const propSchema = resolve(properties[propName]).node;
+                if (!propSchema || !isScalarSchema(propSchema)) {
+                    continue;
+                }
+                if (!propSchema.example && !propSchema.examples) {
+                    report({
+                        message: `Scalar property should have "example"${oasVersion === oas_types_1.OasVersion.Version3_1 ? ' or "examples"' : ''} defined.`,
+                        location: location.child(propName).key(),
+                    });
+                }
+            }
+        },
+    };
+};
+exports.ScalarPropertyMissingExample = ScalarPropertyMissingExample;
+function isScalarSchema(schema) {
+    if (!schema.type) {
+        return false;
+    }
+    if (schema.allOf || schema.anyOf || schema.oneOf) {
+        // Skip allOf/oneOf/anyOf as it's complicated to validate it right now.
+        // We need core support for checking contrstrains through those keywords.
+        return false;
+    }
+    if (schema.format === 'binary') {
+        return false;
+    }
+    if (Array.isArray(schema.type)) {
+        return schema.type.every((t) => SCALAR_TYPES.includes(t));
+    }
+    return SCALAR_TYPES.includes(schema.type);
+}

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

@@ -39,5 +39,8 @@ export declare const rules: {
     'request-mime-type': Oas2Rule;
     'response-mime-type': Oas2Rule;
     'path-segment-plural': Oas2Rule;
+    'response-contains-header': Oas2Rule;
+    'response-contains-property': Oas2Rule;
+    'scalar-property-missing-example': import("../../visitors").Oas3Rule | Oas2Rule;
 };
 export declare const preprocessors: {};

package/lib/rules/oas2/index.js

@@ -39,6 +39,9 @@ const path_excludes_patterns_1 = require("../common/path-excludes-patterns");
 const request_mime_type_1 = require("./request-mime-type");
 const response_mime_type_1 = require("./response-mime-type");
 const path_segment_plural_1 = require("../common/path-segment-plural");
+const response_contains_header_1 = require("../common/response-contains-header");
+const response_contains_property_1 = require("./response-contains-property");
+const scalar_property_missing_example_1 = require("../common/scalar-property-missing-example");
 exports.rules = {
     spec: spec_1.OasSpec,
     'no-invalid-schema-examples': no_invalid_schema_examples_1.NoInvalidSchemaExamples,
@@ -79,5 +82,8 @@ exports.rules = {
     'request-mime-type': request_mime_type_1.RequestMimeType,
     'response-mime-type': response_mime_type_1.ResponseMimeType,
     'path-segment-plural': path_segment_plural_1.PathSegmentPlural,
+    'response-contains-header': response_contains_header_1.ResponseContainsHeader,
+    'response-contains-property': response_contains_property_1.ResponseContainsProperty,
+    'scalar-property-missing-example': scalar_property_missing_example_1.ScalarPropertyMissingExample,
 };
 exports.preprocessors = {};

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

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

package/lib/rules/oas2/response-contains-property.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseContainsProperty = void 0;
+const utils_1 = require("../../utils");
+const ResponseContainsProperty = (options) => {
+    const names = options.names || {};
+    let key;
+    return {
+        Operation: {
+            Response: {
+                skip: (_response, key) => {
+                    return `${key}` === '204';
+                },
+                enter: (_response, ctx) => {
+                    key = ctx.key;
+                },
+                Schema(schema, { report, location }) {
+                    var _a;
+                    if (schema.type !== 'object')
+                        return;
+                    const expectedProperties = names[key] ||
+                        names[utils_1.getMatchingStatusCodeRange(key)] ||
+                        names[utils_1.getMatchingStatusCodeRange(key).toLowerCase()] ||
+                        [];
+                    for (const expectedProperty of expectedProperties) {
+                        if (!((_a = schema.properties) === null || _a === void 0 ? void 0 : _a[expectedProperty])) {
+                            report({
+                                message: `Response object must contain a top-level "${expectedProperty}" property.`,
+                                location: location.child('properties').key(),
+                            });
+                        }
+                    }
+                },
+            },
+        },
+    };
+};
+exports.ResponseContainsProperty = ResponseContainsProperty;

package/lib/rules/oas3/index.js

@@ -47,6 +47,9 @@ const path_segment_plural_1 = require("../common/path-segment-plural");
 const path_excludes_patterns_1 = require("../common/path-excludes-patterns");
 const no_invalid_schema_examples_1 = require("../common/no-invalid-schema-examples");
 const no_invalid_parameter_examples_1 = require("../common/no-invalid-parameter-examples");
+const response_contains_header_1 = require("../common/response-contains-header");
+const response_contains_property_1 = require("./response-contains-property");
+const scalar_property_missing_example_1 = require("../common/scalar-property-missing-example");
 exports.rules = {
     spec: spec_1.OasSpec,
     'info-description': info_description_1.InfoDescription,
@@ -95,5 +98,8 @@ exports.rules = {
     'path-segment-plural': path_segment_plural_1.PathSegmentPlural,
     'no-invalid-schema-examples': no_invalid_schema_examples_1.NoInvalidSchemaExamples,
     'no-invalid-parameter-examples': no_invalid_parameter_examples_1.NoInvalidParameterExamples,
+    'response-contains-header': response_contains_header_1.ResponseContainsHeader,
+    'response-contains-property': response_contains_property_1.ResponseContainsProperty,
+    'scalar-property-missing-example': scalar_property_missing_example_1.ScalarPropertyMissingExample,
 };
 exports.preprocessors = {};

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

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

package/lib/rules/oas3/response-contains-property.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseContainsProperty = void 0;
+const utils_1 = require("../../utils");
+const ResponseContainsProperty = (options) => {
+    const names = options.names || {};
+    let key;
+    return {
+        Operation: {
+            Response: {
+                skip: (_response, key) => {
+                    return `${key}` === '204';
+                },
+                enter: (_response, ctx) => {
+                    key = ctx.key;
+                },
+                MediaType: {
+                    Schema(schema, { report, location }) {
+                        var _a;
+                        if (schema.type !== 'object')
+                            return;
+                        const expectedProperties = names[key] ||
+                            names[utils_1.getMatchingStatusCodeRange(key)] ||
+                            names[utils_1.getMatchingStatusCodeRange(key).toLowerCase()] ||
+                            [];
+                        for (const expectedProperty of expectedProperties) {
+                            if (!((_a = schema.properties) === null || _a === void 0 ? void 0 : _a[expectedProperty])) {
+                                report({
+                                    message: `Response object must contain a top-level "${expectedProperty}" property.`,
+                                    location: location.child('properties').key(),
+                                });
+                            }
+                        }
+                    },
+                },
+            },
+        },
+    };
+};
+exports.ResponseContainsProperty = ResponseContainsProperty;

package/lib/types/oas2.js

@@ -80,7 +80,8 @@ const Operation = {
         deprecated: { type: 'boolean' },
         security: _1.listOf('SecurityRequirement'),
         'x-codeSamples': _1.listOf('XCodeSample'),
-        'x-code-samples': _1.listOf('XCodeSample'), // deprecated
+        'x-code-samples': _1.listOf('XCodeSample'),
+        'x-hideTryItPanel': { type: 'boolean' },
     },
     required: ['responses'],
 };
@@ -275,6 +276,7 @@ const Schema = {
         xml: 'Xml',
         externalDocs: 'ExternalDocs',
         example: { isExample: true },
+        'x-tags': { type: 'array', items: { type: 'string' } },
     },
 };
 const SchemaProperties = {