@redocly/openapi-core 1.14.0 → 1.16.0

package/src/rules/common/__tests__/no-invalid-schema-examples.test.ts

@@ -0,0 +1,51 @@
+import { outdent } from 'outdent';
+import { lintDocument } from '../../../lint';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
+import { BaseResolver } from '../../../resolve';
+
+describe('no-invalid-schema-examples', () => {
+  it('should report on invalid falsy example', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: 3.1.0
+        components:
+          schemas:
+            Car:
+              type: object
+              properties:
+                color:
+                  type: string
+                  example: 0
+      `,
+      'foobar.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'no-invalid-schema-examples': 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      [
+        {
+          "from": {
+            "pointer": "#/components/schemas/Car/properties/color",
+            "source": "foobar.yaml",
+          },
+          "location": [
+            {
+              "pointer": "#/components/schemas/Car/properties/color/example",
+              "reportOnKey": false,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Example value must conform to the schema: type must be string.",
+          "ruleId": "no-invalid-schema-examples",
+          "severity": "error",
+          "suggest": [],
+        },
+      ]
+    `);
+  });
+});

package/src/rules/common/no-invalid-parameter-examples.ts

@@ -7,7 +7,7 @@ export const NoInvalidParameterExamples: any = (opts: any) => {
   return {
     Parameter: {
       leave(parameter: Oas3Parameter, ctx: UserContext) {
-        if (parameter.example) {
+        if (parameter.example !== undefined) {
           validateExample(
             parameter.example,
             parameter.schema!,

package/src/rules/common/no-invalid-schema-examples.ts

@@ -18,7 +18,7 @@ export const NoInvalidSchemaExamples: any = (opts: any) => {
             );
           }
         }
-        if (schema.example) {
+        if (schema.example !== undefined) {
           validateExample(schema.example, schema, ctx.location.child('example'), ctx, true);
         }
       },

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

@@ -137,6 +137,58 @@ describe('no-invalid-media-type-examples', () => {
     `);
   });
 
+  it('should report on invalid example with a falsy value', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: 3.1.0
+        paths:
+          /test:
+            get:
+              responses:
+                '200':
+                  content:
+                    application/json:
+                      schema:
+                        type: string
+                      example: false
+      `,
+      'foobar.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({
+        'no-invalid-media-type-examples': {
+          severity: 'error',
+          allowAdditionalProperties: false,
+        },
+      }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      [
+        {
+          "from": {
+            "pointer": "#/paths/~1test/get/responses/200/content/application~1json",
+            "source": "foobar.yaml",
+          },
+          "location": [
+            {
+              "pointer": "#/paths/~1test/get/responses/200/content/application~1json/example",
+              "reportOnKey": false,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "Example value must conform to the schema: type must be string.",
+          "ruleId": "no-invalid-media-type-examples",
+          "severity": "error",
+          "suggest": [],
+        },
+      ]
+    `);
+  });
+
   it('should not report on valid example with allowAdditionalProperties', async () => {
     const document = parseYamlToDocument(
       outdent`

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

@@ -12,7 +12,7 @@ export const ValidContentExamples: Oas3Rule = (opts) => {
       leave(mediaType, ctx: UserContext) {
         const { location, resolve } = ctx;
         if (!mediaType.schema) return;
-        if (mediaType.example) {
+        if (mediaType.example !== undefined) {
           resolveAndValidateExample(mediaType.example, location.child('example'));
         } else if (mediaType.examples) {
           for (const exampleName of Object.keys(mediaType.examples)) {

package/src/types/redocly-yaml.ts

@@ -256,7 +256,6 @@ const createConfigRoot = (nodeTypes: Record<string, NodeType>): NodeType => ({
     ...nodeTypes.rootRedoclyConfigSchema.properties,
     ...ConfigStyleguide.properties,
     apis: 'ConfigApis', // Override apis with internal format
-    theme: 'ConfigRootTheme', // Override theme with internal format
     'features.openapi': 'ConfigReferenceDocs', // deprecated
     'features.mockServer': 'ConfigMockServer', // deprecated
     organization: { type: 'string' },
@@ -315,14 +314,6 @@ const ConfigHTTP: NodeType = {
   },
 };
 
-const createConfigRootTheme = (nodeTypes: Record<string, NodeType>): NodeType => ({
-  ...nodeTypes['rootRedoclyConfigSchema.theme'],
-  properties: {
-    ...nodeTypes['rootRedoclyConfigSchema.theme']?.properties,
-    openapi: 'ConfigReferenceDocs', // Override theme.openapi with internal format
-  },
-});
-
 const Rules: NodeType = {
   properties: {},
   additionalProperties: (value: unknown, key: string) => {
@@ -932,10 +923,10 @@ const GenerateCodeSamples: NodeType = {
   required: ['languages'],
 };
 
+// TODO: deprecated
 const ConfigReferenceDocs: NodeType = {
-  // TODO: partially invalid @Viacheslav
   properties: {
-    theme: 'ConfigTheme', // TODO: deprecated @Viacheslav
+    theme: 'ConfigTheme',
     corsProxyUrl: { type: 'string' },
     ctrlFHijack: { type: 'boolean' },
     defaultSampleLanguage: { type: 'string' },
@@ -1072,9 +1063,8 @@ export const createConfigTypes = (extraSchemas: JSONSchema) => {
 
   return {
     ...CoreConfigTypes,
-    ConfigRoot: createConfigRoot(nodeTypes),
+    ConfigRoot: createConfigRoot(nodeTypes), // This is the REAL config root type
     ConfigApisProperties: createConfigApisProperties(nodeTypes),
-    ConfigRootTheme: createConfigRootTheme(nodeTypes),
     ...nodeTypes,
   };
 };

package/src/utils.ts

@@ -5,9 +5,10 @@ import fetch from 'node-fetch';
 import * as pluralize from 'pluralize';
 import { parseYaml } from './js-yaml';
 import { UserContext } from './walk';
-import { HttpResolveConfig } from './config';
 import { env } from './env';
 import { logger, colorize } from './logger';
+import { HttpResolveConfig } from './config';
+import { HttpsProxyAgent } from 'https-proxy-agent';
 
 export { parseYaml, stringifyYaml } from './js-yaml';
 
@@ -278,3 +279,8 @@ export async function pause(ms: number): Promise<void> {
 function getUpdatedFieldName(updatedField: string, updatedObject?: string) {
   return `${typeof updatedObject !== 'undefined' ? `${updatedObject}.` : ''}${updatedField}`;
 }
+
+export function getProxyAgent() {
+  const proxy = process.env.HTTPS_PROXY || process.env.HTTP_PROXY;
+  return proxy ? new HttpsProxyAgent(proxy) : undefined;
+}