@redocly/openapi-core 1.0.0-beta.101 → 1.0.0-beta.104

package/src/decorators/__tests__/filter-out.test.ts

@@ -0,0 +1,331 @@
+import { outdent } from 'outdent';
+import { bundleDocument } from '../../bundle';
+import { BaseResolver } from '../../resolve';
+import { makeConfig, parseYamlToDocument, yamlSerializer } from '../../../__tests__/utils';
+
+describe('oas3 filter-out', () => {
+  expect.addSnapshotSerializer(yamlSerializer);
+
+  const inputDoc = parseYamlToDocument(
+    outdent`
+        openapi: 3.0.0
+        paths:
+          /pet:
+            x-audience: Private
+            post:
+              summary: test
+          /user:
+            x-audience: Protected
+            post:
+              summary: test          
+          /order:
+            x-audience: [Private, Protected]
+            post:
+              operationId: storeOrder
+              parameters:
+                - name: api_key
+              callbacks:
+                x-access: protected
+                orderInProgress:
+                  x-internal: true`);
+
+  it('should remove /pet path and y parameter', async () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+      openapi: 3.0.0
+      paths:
+        /pet:
+          x-access: private
+          get:
+            parameters:
+              - $ref: '#/components/parameters/y'
+      components:
+        parameters:
+          x:
+            name: x
+          y:
+            x-access: private
+            name: y  
+    `
+    );
+    const { bundle: res } = await bundleDocument({
+      document: testDocument,
+      externalRefResolver: new BaseResolver(),
+      config: await makeConfig({}, { 'filter-out': { property: 'x-access', value: 'private' } }),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+          openapi: 3.0.0
+          components:
+            parameters:
+              x:
+                name: x
+
+                `);
+  });
+
+  it('should remove only /order path', async () => {
+    const { bundle: res } = await bundleDocument({
+      document: inputDoc,
+      externalRefResolver: new BaseResolver(),
+      config: await makeConfig(
+        {},
+        {
+          'filter-out': {
+            property: 'x-audience',
+            value: ['Private', 'Protected'],
+            matchStrategy: 'all',
+          },
+        }
+      ),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+      openapi: 3.0.0
+      paths:
+        /pet:
+          x-audience: Private
+          post:
+            summary: test
+        /user:
+          x-audience: Protected
+          post:
+            summary: test
+      components: {}
+      
+      `);
+  });
+
+  it('should remove all paths', async () => {
+    const { bundle: res } = await bundleDocument({
+      document: inputDoc,
+      externalRefResolver: new BaseResolver(),
+      config: await makeConfig(
+        {},
+        {
+          'filter-out': {
+            property: 'x-audience',
+            value: ['Private', 'Protected'],
+            matchStrategy: 'any',
+          },
+        }
+      ),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+        openapi: 3.0.0
+        components: {}
+        
+        `);
+  });
+
+  it('should remove requestBody', async () => {
+    const testDoc = parseYamlToDocument(
+      outdent`
+      openapi: 3.0.0
+      paths:
+        /pet:
+          post:
+            summary: test
+            requestBody:
+              content:
+                x-access: private
+                application/x-www-form-urlencoded:
+                  schema:
+                    type: object
+      components: {}
+            
+        `);
+    const { bundle: res } = await bundleDocument({
+      document: testDoc,
+      externalRefResolver: new BaseResolver(),
+      config: await makeConfig(
+        {},
+        {
+          'filter-out': {
+            property: 'x-access',
+            value: 'private',
+            matchStrategy: 'any',
+          },
+        }
+      ),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+      openapi: 3.0.0
+      paths:
+        /pet:
+          post:
+            summary: test
+      components: {}
+
+    `);
+  });
+
+  it('should remove /pet path and /my/path/false path', async () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+      openapi: 3.0.0
+      paths:
+        /pet:
+          get:
+            x-prop: false
+            parameters:
+              - $ref: '#/components/parameters/x'
+        /my/path/false:
+          x-access: private
+          x-prop: false
+          get:
+            parameters:
+              - $ref: '#/components/parameters/x'
+        /my/path/null:
+          x-access: private
+          x-prop: null
+          get:
+            parameters:
+              - $ref: '#/components/parameters/x'
+      components:
+        parameters:
+          x:
+            name: x
+            
+            `);
+    const { bundle: res } = await bundleDocument({
+      document: testDocument,
+      externalRefResolver: new BaseResolver(),
+      config: await makeConfig({}, { 'filter-out': { property: 'x-prop', value: false } }),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+      openapi: 3.0.0
+      paths:
+        /my/path/null:
+          x-access: private
+          x-prop: null
+          get:
+            parameters:
+              - $ref: '#/components/parameters/x'
+      components:
+        parameters:
+          x:
+            name: x
+
+            `);
+  });
+
+  it('should remove /my/path/null path ', async () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+      openapi: 3.0.0
+      paths:
+        /pet:
+          x-access: private
+          get:
+            x-prop: false
+            parameters:
+              - $ref: '#/components/parameters/y'
+        /my/path/false:
+          x-access: private
+          x-prop: false
+          get:
+            parameters:
+              - $ref: '#/components/parameters/y'
+        /my/path/null:
+          x-access: private
+          x-prop: null
+          get:
+            parameters:
+              - $ref: '#/components/parameters/y'
+      components:
+        parameters:
+          x:
+            name: x
+            
+            `);
+    const { bundle: res } = await bundleDocument({
+      document: testDocument,
+      externalRefResolver: new BaseResolver(),
+      config: await makeConfig({}, { 'filter-out': { property: 'x-prop', value: null } }),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+      openapi: 3.0.0
+      paths:
+        /pet:
+          x-access: private
+          get:
+            x-prop: false
+            parameters:
+              - $ref: '#/components/parameters/y'
+        /my/path/false:
+          x-access: private
+          x-prop: false
+          get:
+            parameters:
+              - $ref: '#/components/parameters/y'
+      components:
+        parameters:
+          x:
+            name: x
+
+            `);
+  });
+});
+
+describe('oas2 filter-out', () => {
+  it('should clean all parameters and responses ', async () => {
+    const testDoc = parseYamlToDocument(
+      outdent`
+        swagger: '2.0'
+        host: api.instagram.com
+        paths:
+          '/geographies/{geo-id}/media/recent':
+            get:
+              parameters:
+                - description: The geography ID.
+                  x-access: private
+                  in: path
+                  name: geo-id
+                  required: true
+                  type: string
+                - description: Max number of media to return.
+                  x-access: protected
+                  format: int32
+                  in: query
+                  name: count
+                  required: false
+                  type: integer
+              responses:
+                $ref: '#/components/response/200'
+        components:
+          response:
+            '200':
+                  description: List of recent media entries.
+                  x-access: [protected, public]            
+      `
+    );
+    const { bundle: res } = await bundleDocument({
+      document: testDoc,
+      externalRefResolver: new BaseResolver(),
+      config: await makeConfig(
+        {},
+        {
+          'filter-out': {
+            property: 'x-access',
+            value: ['private', 'protected'],
+            matchStrategy: 'any',
+          },
+        }
+      ),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+      swagger: '2.0'
+      host: api.instagram.com
+      paths:
+        /geographies/{geo-id}/media/recent:
+          get: {}
+      components:
+        response:
+          '200':
+            description: List of recent media entries.
+            x-access:
+              - protected
+              - public
+
+    `);
+  });
+});

package/src/decorators/common/filters/filter-helper.ts

@@ -0,0 +1,72 @@
+import { UserContext } from '../../../walk';
+import { isRef } from '../../../ref-utils';
+import { isEmptyArray, isEmptyObject, isPlainObject } from '../../../utils';
+
+export function filter(node: any, ctx: UserContext, criteria: (item: any) => boolean) {
+  const { parent, key } = ctx;
+  let didDelete = false;
+  if (Array.isArray(node)) {
+    for (let i = 0; i < node.length; i++) {
+      if (isRef(node[i])) {
+        const resolved = ctx.resolve(node[i]);
+        if (criteria(resolved.node)) {
+          node.splice(i, 1);
+          didDelete = true;
+          i--;
+        }
+      }
+      if (criteria(node[i])) {
+        node.splice(i, 1);
+        didDelete = true;
+        i--;
+      }
+    }
+  } else if (isPlainObject(node)) {
+    for (const key of Object.keys(node)) {
+      node = node as any;
+      if (isRef(node[key])) {
+        const resolved = ctx.resolve(node[key]);
+        if (criteria(resolved.node)) {
+          delete node[key];
+          didDelete = true;
+        }
+      }
+      if (criteria(node[key])) {
+        delete node[key];
+        didDelete = true;
+      }
+    }
+  }
+  if (didDelete && (isEmptyObject(node) || isEmptyArray(node))) {
+    delete parent[key];
+  }
+}
+
+export function checkIfMatchByStrategy(
+  nodeValue: any,
+  decoratorValue: any,
+  strategy: 'all' | 'any'
+): boolean {
+  if (nodeValue===undefined || decoratorValue===undefined) {
+    return false;
+  }
+
+  if (!Array.isArray(decoratorValue) && !Array.isArray(nodeValue)) {
+    return nodeValue === decoratorValue;
+  }
+
+  decoratorValue = toArrayIfNeeded<string>(decoratorValue);
+  nodeValue = toArrayIfNeeded<string>(nodeValue);
+
+  if (strategy === 'any') {
+    return decoratorValue.some((item: string) => nodeValue.includes(item));
+  }
+  if (strategy === 'all') {
+    return decoratorValue.every((item: string) => nodeValue.includes(item));
+  }
+  return false;
+}
+
+function toArrayIfNeeded<T>(value: T | T[]): T[] {
+  return Array.isArray(value) ? value : [value];
+}

package/src/decorators/common/filters/filter-in.ts

@@ -0,0 +1,18 @@
+import { Oas2Decorator, Oas3Decorator } from '../../../visitors';
+import { checkIfMatchByStrategy, filter } from './filter-helper';
+
+const DEFAULT_STRATEGY = 'any';
+
+export const FilterIn: Oas3Decorator | Oas2Decorator = ({ property, value, matchStrategy }) => {
+  const strategy = matchStrategy || DEFAULT_STRATEGY;
+  const filterInCriteria = (item: any) =>
+    item?.[property] && !checkIfMatchByStrategy(item?.[property], value, strategy);
+
+  return {
+    any: {
+      enter: (node, ctx) => {
+        filter(node, ctx, filterInCriteria);
+      },
+    },
+  };
+};

package/src/decorators/common/filters/filter-out.ts

@@ -0,0 +1,18 @@
+import { Oas2Decorator, Oas3Decorator } from '../../../visitors';
+import { checkIfMatchByStrategy, filter } from './filter-helper';
+
+const DEFAULT_STRATEGY = 'any';
+
+export const FilterOut: Oas3Decorator | Oas2Decorator = ({ property, value, matchStrategy }) => {
+  const strategy = matchStrategy || DEFAULT_STRATEGY;
+  const filterOutCriteria = (item: any) =>
+    checkIfMatchByStrategy(item?.[property], value, strategy);
+
+  return {
+    any: {
+      enter: (node, ctx) => {
+        filter(node, ctx, filterOutCriteria);
+      },
+    },
+  };
+};

package/src/decorators/oas2/index.ts

@@ -4,11 +4,15 @@ import { OperationDescriptionOverride } from '../common/operation-description-ov
 import { TagDescriptionOverride } from '../common/tag-description-override';
 import { InfoDescriptionOverride } from '../common/info-description-override';
 import { RemoveXInternal } from '../common/remove-x-internal';
+import { FilterIn } from '../common/filters/filter-in';
+import { FilterOut } from '../common/filters/filter-out';
 
 export const decorators = {
   'registry-dependencies': RegistryDependencies as Oas2Decorator,
   'operation-description-override': OperationDescriptionOverride as Oas2Decorator,
   'tag-description-override': TagDescriptionOverride as Oas2Decorator,
   'info-description-override': InfoDescriptionOverride as Oas2Decorator,
-  'remove-x-internal': RemoveXInternal as Oas2Decorator
+  'remove-x-internal': RemoveXInternal as Oas2Decorator,
+  'filter-in': FilterIn as Oas2Decorator,
+  'filter-out': FilterOut as Oas2Decorator,
 };

package/src/decorators/oas3/index.ts

@@ -4,11 +4,15 @@ import { OperationDescriptionOverride } from '../common/operation-description-ov
 import { TagDescriptionOverride } from '../common/tag-description-override';
 import { InfoDescriptionOverride } from '../common/info-description-override';
 import { RemoveXInternal } from '../common/remove-x-internal';
+import { FilterIn } from '../common/filters/filter-in';
+import { FilterOut } from '../common/filters/filter-out';
 
 export const decorators = {
   'registry-dependencies': RegistryDependencies as Oas3Decorator,
   'operation-description-override': OperationDescriptionOverride as Oas3Decorator,
   'tag-description-override': TagDescriptionOverride as Oas3Decorator,
   'info-description-override': InfoDescriptionOverride as Oas3Decorator,
-  'remove-x-internal': RemoveXInternal as Oas3Decorator
+  'remove-x-internal': RemoveXInternal as Oas3Decorator,
+  'filter-in': FilterIn as Oas3Decorator,
+  'filter-out': FilterOut as Oas3Decorator,
 };

package/src/index.ts

@@ -33,6 +33,7 @@ export {
   getConfig,
   findConfig,
   CONFIG_FILE_NAMES,
+  RuleSeverity
 } from './config';
 
 

package/src/lint.ts

@@ -94,9 +94,10 @@ export async function lintDocument(opts: {
 }
 
 export async function lintConfig(opts: {
-  document: Document,
+  document: Document
+  severity?: ProblemSeverity 
 }) {
-  const { document } = opts;
+  const { document, severity } = opts;
 
   const ctx: WalkContext = {
     problems: [],
@@ -110,7 +111,7 @@ export async function lintConfig(opts: {
   });
 
   const types = normalizeTypes(ConfigTypes, config);
-  const rules = [{ severity: 'error' as ProblemSeverity, ruleId: 'spec', visitor: OasSpec({ severity: 'error' }) }];
+  const rules = [{ severity: severity || 'error', ruleId: 'configuration spec', visitor: OasSpec({ severity: 'error' }) }];
   const normalizedVisitors = normalizeVisitors(rules, types);
 
   walkDocument({

package/src/redocly/registry-api-types.ts

@@ -17,6 +17,8 @@ export namespace RegistryApiTypes {
     branch?: string;
     isUpsert?: boolean;
     isPublic?: boolean;
+    batchId?: string;
+    batchSize?: number;
   }
 
   export interface PrepareFileuploadOKResponse {

package/src/redocly/registry-api.ts

@@ -105,6 +105,8 @@ export class RegistryApi {
     branch,
     isUpsert,
     isPublic,
+    batchId,
+    batchSize
   }: RegistryApiTypes.PushApiParams) {
     const response = await this.request(
       `/${organizationId}/${name}/${version}`,
@@ -120,6 +122,8 @@ export class RegistryApi {
           branch,
           isUpsert,
           isPublic,
+          batchId,
+          batchSize
         }),
       },
       this.region,

package/src/rules/ajv.ts

@@ -8,7 +8,7 @@ export function releaseAjvInstance() {
   ajvInstance = null;
 }
 
-function getAjv(resolve: ResolveFn<any>, disallowAdditionalProperties: boolean) {
+function getAjv(resolve: ResolveFn, disallowAdditionalProperties: boolean) {
   if (!ajvInstance) {
     ajvInstance = new Ajv({
       schemaId: '$id',
@@ -23,7 +23,7 @@ function getAjv(resolve: ResolveFn<any>, disallowAdditionalProperties: boolean)
       defaultAdditionalProperties: !disallowAdditionalProperties,
       loadSchemaSync(base: string, $ref: string) {
         const resolvedRef = resolve({ $ref }, base.split('#')[0]);
-        if (!resolvedRef || !resolvedRef.location) return undefined;
+        if (!resolvedRef || !resolvedRef.location) return false;
         return { $id: resolvedRef.location.absolutePointer, ...resolvedRef.node };
       },
       logger: false,
@@ -35,7 +35,7 @@ function getAjv(resolve: ResolveFn<any>, disallowAdditionalProperties: boolean)
 function getAjvValidator(
   schema: any,
   loc: Location,
-  resolve: ResolveFn<any>,
+  resolve: ResolveFn,
   disallowAdditionalProperties: boolean,
 ): ValidateFunction | undefined {
   const ajv = getAjv(resolve, disallowAdditionalProperties);
@@ -52,7 +52,7 @@ export function validateJsonSchema(
   schema: any,
   schemaLoc: Location,
   instancePath: string,
-  resolve: ResolveFn<any>,
+  resolve: ResolveFn,
   disallowAdditionalProperties: boolean,
 ): { valid: boolean; errors: (ErrorObject & { suggest?: string[] })[] } {
   const validate = getAjvValidator(schema, schemaLoc, resolve, disallowAdditionalProperties);