@redocly/openapi-core 1.34.4 → 2.0.0-next.0

package/src/rules/oas3/__tests__/spec/spec.test.ts

@@ -1,307 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef } from '../../../../../__tests__/utils';
-import { StyleguideConfig, defaultPlugin, resolvePlugins, resolvePreset } from '../../../../config';
-
-import { BaseResolver } from '../../../../resolve';
-
-import type { Plugin, ResolvedStyleguideConfig } from '../../../../config';
-
-describe('Oas3 Structural visitor basic', () => {
-  let plugins: Plugin[];
-  let presets: ResolvedStyleguideConfig;
-  let allConfig: StyleguideConfig;
-
-  beforeAll(async () => {
-    plugins = await resolvePlugins([defaultPlugin]);
-    presets = resolvePreset('all', plugins);
-    allConfig = new StyleguideConfig({ ...presets, plugins });
-  });
-
-  it('should report wrong types', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          tags:
-            - 25.3
-            - test
-          servers:
-          - url: 'http://redocly-example.com'
-            variables:
-              a:
-                default: test
-                enum:
-                  - 123
-                  - test
-          info:
-            title: Test
-            version: '1.0'
-            description: test description
-            contact:
-              name: string
-              url: []
-              email: false
-            license: invalid
-          paths: {}
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: allConfig,
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "from": undefined,
-          "location": [
-            {
-              "pointer": "#/info/contact/url",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Expected type \`string\` but got \`array\`.",
-          "ruleId": "struct",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "from": undefined,
-          "location": [
-            {
-              "pointer": "#/info/contact/email",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Expected type \`string\` but got \`boolean\`.",
-          "ruleId": "struct",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "from": undefined,
-          "location": [
-            {
-              "pointer": "#/info/license",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Expected type \`License\` (object) but got \`string\`",
-          "ruleId": "struct",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "from": {
-            "pointer": "#/servers/0/url",
-            "source": "foobar.yaml",
-          },
-          "location": [
-            {
-              "pointer": "#/servers/0/variables/a",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "The \`a\` variable is not used in the server's \`url\` field.",
-          "ruleId": "no-undefined-server-variable",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "from": undefined,
-          "location": [
-            {
-              "pointer": "#/servers/0/variables/a/enum/0",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Expected type \`string\` but got \`integer\`.",
-          "ruleId": "struct",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "from": undefined,
-          "location": [
-            {
-              "pointer": "#/tags/0",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Expected type \`Tag\` (object) but got \`number\`",
-          "ruleId": "struct",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "from": undefined,
-          "location": [
-            {
-              "pointer": "#/tags/1",
-              "reportOnKey": false,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Expected type \`Tag\` (object) but got \`string\`",
-          "ruleId": "struct",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  it('should report unexpected properties', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          components1: 1
-          info:
-            title: Test
-            version: '1.0'
-            description: test description
-            license:
-              name: MIT
-              url: google.com
-            contact:
-              name: string
-              test: blah
-              x-test: vendor
-          paths: {}
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: allConfig,
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "from": undefined,
-          "location": [
-            {
-              "pointer": "#/components1",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Property \`components1\` is not expected here.",
-          "ruleId": "struct",
-          "severity": "error",
-          "suggest": [
-            "components",
-          ],
-        },
-        {
-          "location": [
-            {
-              "pointer": "#/openapi",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Servers must be present.",
-          "ruleId": "no-empty-servers",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "from": undefined,
-          "location": [
-            {
-              "pointer": "#/info/contact/test",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Property \`test\` is not expected here.",
-          "ruleId": "struct",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  it('should report required properties missing', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-          openapi: 3.0.0
-          info:
-            version: '1.0'
-            description: test description
-            license:
-              name: MIT
-              url: google.com
-            contact:
-              name: string
-        `,
-      'foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: allConfig,
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      [
-        {
-          "from": undefined,
-          "location": [
-            {
-              "pointer": "#/",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "The field \`paths\` must be present on this level.",
-          "ruleId": "struct",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "location": [
-            {
-              "pointer": "#/openapi",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "Servers must be present.",
-          "ruleId": "no-empty-servers",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "from": undefined,
-          "location": [
-            {
-              "pointer": "#/info",
-              "reportOnKey": true,
-              "source": "foobar.yaml",
-            },
-          ],
-          "message": "The field \`title\` must be present on this level.",
-          "ruleId": "struct",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-});

package/src/rules/oas3/__tests__/spec/utils.ts

@@ -1,32 +0,0 @@
-import { StyleguideConfig, RuleConfig, resolveStyleguideConfig } from '../../../../config';
-import { parseYamlToDocument } from '../../../../../__tests__/utils';
-import { lintDocument } from '../../../../lint';
-import { BaseResolver } from '../../../../resolve';
-
-export async function validateDoc(
-  source: string,
-  rules: Record<string, RuleConfig> = { spec: 'error' }
-) {
-  const document = parseYamlToDocument(source, 'foobar.yaml');
-
-  const results = await lintDocument({
-    externalRefResolver: new BaseResolver(),
-    document,
-    config: new StyleguideConfig(
-      await resolveStyleguideConfig({
-        styleguideConfig: {
-          plugins: [],
-          extends: [],
-          rules,
-        },
-      })
-    ),
-  });
-
-  return results.map((res) => {
-    return {
-      message: res.message,
-      location: res.location[0].pointer || '',
-    };
-  });
-}

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

@@ -1,282 +0,0 @@
-import { makeConfig, parseYamlToDocument } from '../../../../__tests__/utils';
-import { outdent } from 'outdent';
-import { lintDocument } from '../../../lint';
-import { BaseResolver } from '../../../resolve';
-
-describe('Oas3 spec-components-invalid-map-name', () => {
-  it('should report about invalid keys inside components', async () => {
-    const document = parseYamlToDocument(outdent`
-      openapi: 3.0.0
-      info:
-        version: 3.0.0
-      components:
-        parameters:
-          my Param:
-            name: param
-            description: param
-            in: path
-        examples:
-          invalid identifier:
-            description: 'Some description'
-            value: 21      
-        responses: 
-          400 status:
-            description: bad request   
-        schemas: 
-          first schema:
-            type: integer
-            format: int64     
-		`);
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: {
-          'spec-components-invalid-map-name': 'error',
-        },
-      }),
-    });
-
-    expect(results).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/components/parameters/my Param",
-              "reportOnKey": true,
-              "source": Source {
-                "absoluteRef": "",
-                "body": "openapi: 3.0.0
-      info:
-        version: 3.0.0
-      components:
-        parameters:
-          my Param:
-            name: param
-            description: param
-            in: path
-        examples:
-          invalid identifier:
-            description: 'Some description'
-            value: 21      
-        responses: 
-          400 status:
-            description: bad request   
-        schemas: 
-          first schema:
-            type: integer
-            format: int64     ",
-                "mimeType": undefined,
-              },
-            },
-          ],
-          "message": "The map key in parameters "my Param" does not match the regular expression "^[a-zA-Z0-9\\.\\-_]+$"",
-          "ruleId": "spec-components-invalid-map-name",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "location": [
-            {
-              "pointer": "#/components/schemas/first schema",
-              "reportOnKey": true,
-              "source": Source {
-                "absoluteRef": "",
-                "body": "openapi: 3.0.0
-      info:
-        version: 3.0.0
-      components:
-        parameters:
-          my Param:
-            name: param
-            description: param
-            in: path
-        examples:
-          invalid identifier:
-            description: 'Some description'
-            value: 21      
-        responses: 
-          400 status:
-            description: bad request   
-        schemas: 
-          first schema:
-            type: integer
-            format: int64     ",
-                "mimeType": undefined,
-              },
-            },
-          ],
-          "message": "The map key in schemas "first schema" does not match the regular expression "^[a-zA-Z0-9\\.\\-_]+$"",
-          "ruleId": "spec-components-invalid-map-name",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "location": [
-            {
-              "pointer": "#/components/responses/400 status",
-              "reportOnKey": true,
-              "source": Source {
-                "absoluteRef": "",
-                "body": "openapi: 3.0.0
-      info:
-        version: 3.0.0
-      components:
-        parameters:
-          my Param:
-            name: param
-            description: param
-            in: path
-        examples:
-          invalid identifier:
-            description: 'Some description'
-            value: 21      
-        responses: 
-          400 status:
-            description: bad request   
-        schemas: 
-          first schema:
-            type: integer
-            format: int64     ",
-                "mimeType": undefined,
-              },
-            },
-          ],
-          "message": "The map key in responses "400 status" does not match the regular expression "^[a-zA-Z0-9\\.\\-_]+$"",
-          "ruleId": "spec-components-invalid-map-name",
-          "severity": "error",
-          "suggest": [],
-        },
-        {
-          "location": [
-            {
-              "pointer": "#/components/examples/invalid identifier",
-              "reportOnKey": true,
-              "source": Source {
-                "absoluteRef": "",
-                "body": "openapi: 3.0.0
-      info:
-        version: 3.0.0
-      components:
-        parameters:
-          my Param:
-            name: param
-            description: param
-            in: path
-        examples:
-          invalid identifier:
-            description: 'Some description'
-            value: 21      
-        responses: 
-          400 status:
-            description: bad request   
-        schemas: 
-          first schema:
-            type: integer
-            format: int64     ",
-                "mimeType": undefined,
-              },
-            },
-          ],
-          "message": "The map key in examples "invalid identifier" does not match the regular expression "^[a-zA-Z0-9\\.\\-_]+$"",
-          "ruleId": "spec-components-invalid-map-name",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-
-  it('should not report a key of the example does not match the regular expression', async () => {
-    const document = parseYamlToDocument(outdent`
-      openapi: 3.0.0
-      info:
-        version: 3.0.0
-      paths:
-        /store/subscribe:
-          post:
-            parameters:
-              - name: petId
-                in: path
-                schema:
-                  type: integer
-                  format: int64
-                examples:
-                  valid-identifier-1.key:
-                      description: 'Some description'
-                      value: 21
-		`);
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: {
-          'spec-components-invalid-map-name': 'error',
-        },
-      }),
-    });
-
-    expect(results).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should not report invalid keys inside nested examples', async () => {
-    const document = parseYamlToDocument(outdent`
-      openapi: 3.0.0
-      info:
-        version: 3.0.0
-      components:
-        parameters:
-          my Param:
-            name: param
-            description: param
-            in: path
-            examples:
-              valid identifier:
-                description: 'Some description'
-                value: 21 
-		`);
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: {
-          'spec-components-invalid-map-name': 'error',
-        },
-      }),
-    });
-
-    expect(results).toMatchInlineSnapshot(`
-      [
-        {
-          "location": [
-            {
-              "pointer": "#/components/parameters/my Param",
-              "reportOnKey": true,
-              "source": Source {
-                "absoluteRef": "",
-                "body": "openapi: 3.0.0
-      info:
-        version: 3.0.0
-      components:
-        parameters:
-          my Param:
-            name: param
-            description: param
-            in: path
-            examples:
-              valid identifier:
-                description: 'Some description'
-                value: 21 ",
-                "mimeType": undefined,
-              },
-            },
-          ],
-          "message": "The map key in parameters "my Param" does not match the regular expression "^[a-zA-Z0-9\\.\\-_]+$"",
-          "ruleId": "spec-components-invalid-map-name",
-          "severity": "error",
-          "suggest": [],
-        },
-      ]
-    `);
-  });
-});

package/src/rules/oas3/__tests__/utils/lint-document-for-test.ts

@@ -1,23 +0,0 @@
-import { BaseResolver, Document } from '../../../../resolve';
-import { makeConfig, parseYamlToDocument } from '../../../../../__tests__/utils';
-import { lintDocument } from '../../../../lint';
-import { RuleConfig } from '../../../../config';
-
-export async function lintDocumentForTest(
-  rules: Record<string, RuleConfig>,
-  document: Document,
-  additionalDocuments: { absoluteRef: string; body: string }[]
-) {
-  const baseResolver = new BaseResolver();
-  additionalDocuments.forEach((item) =>
-    baseResolver.cache.set(
-      item.absoluteRef,
-      Promise.resolve(parseYamlToDocument(item.body, item.absoluteRef))
-    )
-  );
-  return await lintDocument({
-    externalRefResolver: baseResolver,
-    document,
-    config: await makeConfig({ rules }),
-  });
-}

package/src/rules/oas3/array-parameter-serialization.ts

@@ -1,47 +0,0 @@
-import { isRef } from '../../ref-utils';
-
-import type { Oas3Rule, Oas3Visitor } from '../../visitors';
-import type { Oas3_1Schema, Oas3Parameter } from '../../typings/openapi';
-
-export type ArrayParameterSerializationOptions = {
-  in?: string[];
-};
-
-export const ArrayParameterSerialization: Oas3Rule = (
-  options: ArrayParameterSerializationOptions
-): Oas3Visitor => {
-  return {
-    Parameter: {
-      leave(node, ctx) {
-        if (!node.schema) {
-          return;
-        }
-        const schema = (
-          isRef(node.schema) ? ctx.resolve(node.schema).node : node.schema
-        ) as Oas3_1Schema;
-
-        if (
-          schema &&
-          shouldReportMissingStyleAndExplode(node as Oas3Parameter<Oas3_1Schema>, schema, options)
-        ) {
-          ctx.report({
-            message: `Parameter \`${node.name}\` should have \`style\` and \`explode \` fields`,
-            location: ctx.location,
-          });
-        }
-      },
-    },
-  };
-};
-
-function shouldReportMissingStyleAndExplode(
-  node: Oas3Parameter<Oas3_1Schema>,
-  schema: Oas3_1Schema,
-  options: ArrayParameterSerializationOptions
-) {
-  return (
-    (schema.type === 'array' || schema.items || schema.prefixItems) &&
-    (node.style === undefined || node.explode === undefined) &&
-    (!options.in || (node.in && options.in?.includes(node.in)))
-  );
-}