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

package/src/rules/oas2/__tests__/spec/operation.test.ts

@@ -1,123 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDoc } from './utils';
-
-describe('OpenAPI Schema 2.0', () => {
-  it('should not report of a valid GET operation object', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths:
-        '/ping':
-          get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should not report of a valid PUT operation object', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths:
-        '/ping':
-          put:
-            tags:
-              - pet
-            summary: Update an existing pet
-            description: ''
-            operationId: updatePet
-            responses:
-              '400':
-                description: Invalid ID supplied
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should not report of a valid Post operation object', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths:
-        '/ping':
-          post:
-            tags:
-              - pet
-            summary: uploads an image
-            description: ''
-            operationId: uploadFile
-            parameters:
-              - name: petId
-                in: path
-                description: ID of pet to update
-                required: true
-                type: integer
-                format: int64
-            responses:
-              '200':
-                description: successful operation
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should not report of a valid delete operation object', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths:
-        '/ping':
-          delete:
-            tags:
-              - store
-            summary: Delete purchase order by ID
-            description: >-
-              For valid response try integer IDs with value < 1000. Anything above
-              1000 or nonintegers will generate API errors
-            operationId: deleteOrder
-            parameters:
-              - name: orderId
-                in: path
-                description: ID of the order that needs to be deleted
-                required: true
-                type: string
-                minimum: 1
-            responses:
-              '400':
-                description: Invalid ID supplied
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`[]`);
-  });
-});

package/src/rules/oas2/__tests__/spec/paths.test.ts

@@ -1,245 +0,0 @@
-import { outdent } from 'outdent';
-import { lintDoc } from './utils';
-
-describe('OpenAPI Schema', () => {
-  it('should not report if Path object is valid ', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths:
-        '/ping':
-          get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should not report if Path object is empty ', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths: {}
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should report if Path object is not present ', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`
-      [
-        {
-          "location": "#/",
-          "message": "The field \`paths\` must be present on this level.",
-        },
-      ]
-    `);
-  });
-
-  it('should not report if Path object is empty ', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths: {}
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`[]`);
-  });
-
-  //Check: no error
-  it('should report if the field name is not begin with a forward slash (/) ', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths:
-        'ping':
-          get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`
-      [
-        {
-          "location": "#/paths/ping",
-          "message": "Property \`ping\` is not expected here.",
-        },
-      ]
-    `);
-  });
-
-  it('should report if paths are considered identical and invalid', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths:
-        /pets/{petId}:
-          get:
-            responses:
-              '200':
-                description: example description
-        /pets/{name}:
-          get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        'paths-identical': 'error',
-      })
-    ).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should not report valid matching URLs', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths:
-        '/pets/{petId}':
-          get:
-            responses:
-              '200':
-                description: example description
-        '/pets/mine':
-           get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should not report in case of ambiguous matching ', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths:
-        '/{entity}/me':
-          get:
-            responses:
-              '200':
-                description: example description
-        '/books/{id}':
-          get:
-            responses:
-              '200':
-                description: example description
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should not report if Path Item is empty ', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths:
-        '/ping': {}
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`[]`);
-  });
-
-  it('should not report of a valid Parameter Object', async () => {
-    const source = outdent`
-      swagger: '2.0'
-      info:
-        title: Test
-        version: '1.0'
-
-      paths:
-        /pet:
-          parameters:
-            - name: Accept-Language
-              in: header
-              description: "test"
-              required: false
-              type: string
-              default: en-AU
-          post:
-            tags:
-              - pet
-            summary: Add a new pet to the store
-            description: Add new pet to the store inventory.
-            operationId: addPet
-            responses:
-              '405':
-                description: Invalid input
-    `;
-
-    expect(
-      await lintDoc(source, {
-        spec: 'error',
-      })
-    ).toMatchInlineSnapshot(`[]`);
-  });
-});

package/src/rules/oas2/__tests__/spec/referenceableScalars.test.ts

@@ -1,37 +0,0 @@
-import { outdent } from 'outdent';
-import {
-  parseYamlToDocument,
-  replaceSourceWithRef,
-  makeConfig,
-} from '../../../../../__tests__/utils';
-import { lintDocument } from '../../../../lint';
-import { BaseResolver } from '../../../../resolve';
-
-describe('Referenceable scalars', () => {
-  it('should not report $ref description', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-        swagger: '2.0'
-        info:
-          title: Test
-          version: '1.0'
-          description:
-            $ref: fixtures/description.md
-        paths: {}
-      `,
-      __dirname + '/foobar.yaml'
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({
-        rules: {
-          spec: 'error',
-        },
-      }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
-  });
-});

package/src/rules/oas2/__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 lintDoc(
-  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/oas2/boolean-parameter-prefixes.ts

@@ -1,26 +0,0 @@
-import type { Oas2Rule } from '../../visitors';
-
-export type BooleanParameterPrefixesOptions = {
-  prefixes?: string[];
-};
-
-export const BooleanParameterPrefixes: Oas2Rule = (options: BooleanParameterPrefixesOptions) => {
-  const prefixes = options.prefixes || ['is', 'has'];
-  const regexp = new RegExp(`^(${prefixes.join('|')})[A-Z-_]`);
-  const wrappedPrefixes = prefixes.map((p) => `\`${p}\``);
-  const prefixesString =
-    wrappedPrefixes.length === 1
-      ? wrappedPrefixes[0]
-      : wrappedPrefixes.slice(0, -1).join(', ') + ' or ' + wrappedPrefixes[prefixes.length - 1];
-
-  return {
-    Parameter(param, { report, location }) {
-      if (param.type === 'boolean' && !regexp.test(param.name)) {
-        report({
-          message: `Boolean parameter \`${param.name}\` should have ${prefixesString} prefix.`,
-          location: location.child('name'),
-        });
-      }
-    },
-  };
-};

package/src/rules/oas2/index.ts

@@ -1,102 +0,0 @@
-import { Struct } from '../common/struct';
-import { NoInvalidSchemaExamples } from '../common/no-invalid-schema-examples';
-import { NoInvalidParameterExamples } from '../common/no-invalid-parameter-examples';
-import { InfoContact } from '../common/info-contact';
-import { InfoLicense } from '../common/info-license';
-import { InfoLicenseUrl } from '../common/info-license-url';
-import { InfoLicenseStrict } from '../common/info-license-strict';
-import { BooleanParameterPrefixes } from './boolean-parameter-prefixes';
-import { TagDescription } from '../common/tag-description';
-import { TagsAlphabetical } from '../common/tags-alphabetical';
-import { PathsKebabCase } from '../common/paths-kebab-case';
-import { NoEnumTypeMismatch } from '../common/no-enum-type-mismatch';
-import { NoPathTrailingSlash } from '../common/no-path-trailing-slash';
-import { Operation2xxResponse } from '../common/operation-2xx-response';
-import { Operation4xxResponse } from '../common/operation-4xx-response';
-import { Assertions } from '../common/assertions';
-import { OperationIdUnique } from '../common/operation-operationId-unique';
-import { OperationParametersUnique } from '../common/operation-parameters-unique';
-import { PathParamsDefined } from '../common/path-params-defined';
-import { OperationTagDefined } from '../common/operation-tag-defined';
-import { PathDeclarationMustExist } from '../common/path-declaration-must-exist';
-import { OperationIdUrlSafe } from '../common/operation-operationId-url-safe';
-import { OperationDescription } from '../common/operation-description';
-import { PathNotIncludeQuery } from '../common/path-not-include-query';
-import { ParameterDescription } from '../common/parameter-description';
-import { OperationSingularTag } from '../common/operation-singular-tag';
-import { SecurityDefined } from '../common/security-defined';
-import { NoUnresolvedRefs } from '../no-unresolved-refs';
-import { PathHttpVerbsOrder } from '../common/path-http-verbs-order';
-import { NoIdenticalPaths } from '../common/no-identical-paths';
-import { OperationOperationId } from '../common/operation-operationId';
-import { OperationSummary } from '../common/operation-summary';
-import { NoAmbiguousPaths } from '../common/no-ambiguous-paths';
-import { NoHttpVerbsInPaths } from '../common/no-http-verbs-in-paths';
-import { PathExcludesPatterns } from '../common/path-excludes-patterns';
-import { RequestMimeType } from './request-mime-type';
-import { ResponseMimeType } from './response-mime-type';
-import { PathSegmentPlural } from '../common/path-segment-plural';
-import { ResponseContainsHeader } from '../common/response-contains-header';
-import { ResponseContainsProperty } from './response-contains-property';
-import { ScalarPropertyMissingExample } from '../common/scalar-property-missing-example';
-import { RequiredStringPropertyMissingMinLength } from '../common/required-string-property-missing-min-length';
-import { SpecStrictRefs } from '../common/spec-strict-refs';
-import { NoRequiredSchemaPropertiesUndefined } from '../common/no-required-schema-properties-undefined';
-import { NoSchemaTypeMismatch } from '../common/no-schema-type-mismatch';
-
-import type { Oas2Rule } from '../../visitors';
-import type { Oas2RuleSet } from '../../oas-types';
-
-export const rules: Oas2RuleSet<'built-in'> = {
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-  //@ts-ignore TODO: This is depricated property `spec` and should be removed in the future
-  spec: Struct as Oas2Rule,
-  struct: Struct as Oas2Rule,
-  'no-invalid-schema-examples': NoInvalidSchemaExamples as Oas2Rule,
-  'no-invalid-parameter-examples': NoInvalidParameterExamples,
-  'info-contact': InfoContact as Oas2Rule,
-  'info-license': InfoLicense as Oas2Rule,
-  'info-license-url': InfoLicenseUrl as Oas2Rule,
-  'info-license-strict': InfoLicenseStrict as Oas2Rule,
-  'tag-description': TagDescription as Oas2Rule,
-  'tags-alphabetical': TagsAlphabetical as Oas2Rule,
-  'paths-kebab-case': PathsKebabCase as Oas2Rule,
-  'no-enum-type-mismatch': NoEnumTypeMismatch as Oas2Rule,
-  'boolean-parameter-prefixes': BooleanParameterPrefixes as Oas2Rule,
-  'no-path-trailing-slash': NoPathTrailingSlash as Oas2Rule,
-  'operation-2xx-response': Operation2xxResponse as Oas2Rule,
-  'operation-4xx-response': Operation4xxResponse as Oas2Rule,
-  assertions: Assertions as Oas2Rule,
-  'operation-operationId-unique': OperationIdUnique as Oas2Rule,
-  'operation-parameters-unique': OperationParametersUnique as Oas2Rule,
-  'path-parameters-defined': PathParamsDefined as Oas2Rule,
-  'operation-tag-defined': OperationTagDefined as Oas2Rule,
-  'path-declaration-must-exist': PathDeclarationMustExist as Oas2Rule,
-  'operation-operationId-url-safe': OperationIdUrlSafe as Oas2Rule,
-  'operation-operationId': OperationOperationId as Oas2Rule,
-  'operation-summary': OperationSummary as Oas2Rule,
-  'operation-description': OperationDescription as Oas2Rule,
-  'path-not-include-query': PathNotIncludeQuery as Oas2Rule,
-  'path-params-defined': PathParamsDefined as Oas2Rule,
-  'parameter-description': ParameterDescription as Oas2Rule,
-  'operation-singular-tag': OperationSingularTag as Oas2Rule,
-  'security-defined': SecurityDefined as Oas2Rule,
-  'no-unresolved-refs': NoUnresolvedRefs as Oas2Rule,
-  'no-identical-paths': NoIdenticalPaths as Oas2Rule,
-  'no-ambiguous-paths': NoAmbiguousPaths as Oas2Rule,
-  'path-http-verbs-order': PathHttpVerbsOrder as Oas2Rule,
-  'no-http-verbs-in-paths': NoHttpVerbsInPaths as Oas2Rule,
-  'path-excludes-patterns': PathExcludesPatterns as Oas2Rule,
-  'request-mime-type': RequestMimeType as Oas2Rule,
-  'response-mime-type': ResponseMimeType as Oas2Rule,
-  'path-segment-plural': PathSegmentPlural as Oas2Rule,
-  'response-contains-header': ResponseContainsHeader as Oas2Rule,
-  'response-contains-property': ResponseContainsProperty as Oas2Rule,
-  'scalar-property-missing-example': ScalarPropertyMissingExample as Oas2Rule,
-  'required-string-property-missing-min-length': RequiredStringPropertyMissingMinLength as Oas2Rule,
-  'spec-strict-refs': SpecStrictRefs as Oas2Rule,
-  'no-required-schema-properties-undefined': NoRequiredSchemaPropertiesUndefined as Oas2Rule,
-  'no-schema-type-mismatch': NoSchemaTypeMismatch as Oas2Rule,
-};
-
-export const preprocessors = {};

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

@@ -1,17 +0,0 @@
-import { validateMimeType } from '../../utils';
-
-import type { Oas2Rule } from '../../visitors';
-import type { UserContext } from '../../walk';
-
-export const RequestMimeType: Oas2Rule = ({ allowedValues }) => {
-  return {
-    Root(root, ctx: UserContext) {
-      validateMimeType({ type: 'consumes', value: root }, ctx, allowedValues);
-    },
-    Operation: {
-      leave(operation, ctx: UserContext) {
-        validateMimeType({ type: 'consumes', value: operation }, ctx, allowedValues);
-      },
-    },
-  };
-};

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

@@ -1,37 +0,0 @@
-import { getMatchingStatusCodeRange } from '../../utils';
-
-import type { Oas2Rule } from '../../visitors';
-import type { UserContext } from '../../walk';
-
-export const ResponseContainsProperty: Oas2Rule = (options) => {
-  const names: Record<string, string[]> = options.names || {};
-  let key: string | number;
-  return {
-    Operation: {
-      Response: {
-        skip: (_response, key) => {
-          return `${key}` === '204';
-        },
-        enter: (_response, ctx: UserContext) => {
-          key = ctx.key;
-        },
-        Schema(schema, { report, location }) {
-          if (schema.type !== 'object') return;
-          const expectedProperties =
-            names[key] ||
-            names[getMatchingStatusCodeRange(key)] ||
-            names[getMatchingStatusCodeRange(key).toLowerCase()] ||
-            [];
-          for (const expectedProperty of expectedProperties) {
-            if (!schema.properties?.[expectedProperty]) {
-              report({
-                message: `Response object must contain a top-level "${expectedProperty}" property.`,
-                location: location.child('properties').key(),
-              });
-            }
-          }
-        },
-      },
-    },
-  };
-};

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

@@ -1,17 +0,0 @@
-import { validateMimeType } from '../../utils';
-
-import type { Oas2Rule } from '../../visitors';
-import type { UserContext } from '../../walk';
-
-export const ResponseMimeType: Oas2Rule = ({ allowedValues }) => {
-  return {
-    Root(root, ctx: UserContext) {
-      validateMimeType({ type: 'produces', value: root }, ctx, allowedValues);
-    },
-    Operation: {
-      leave(operation, ctx: UserContext) {
-        validateMimeType({ type: 'produces', value: operation }, ctx, allowedValues);
-      },
-    },
-  };
-};