openapi-modifier
Version:
This package allows you to automate the process of modifying OpenAPI specifications by applying a set of predefined rules
121 lines (120 loc) • 4.58 kB
JavaScript
"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const index_1 = __importDefault(require("./index"));
describe('remove-operation-id rule', () => {
test('regular', () => {
const fakeLogger = global.createFakeLogger();
const fakeOpenAPIFile = global.createFakeOpenAPIFile({
paths: {
'/pets': {
get: {
summary: '',
operationId: 'listPets',
tags: [],
responses: {},
},
},
'/pet/:id': {
get: {
summary: '',
operationId: 'petDetails',
tags: [],
responses: {},
},
},
},
});
expect(index_1.default.processDocument(fakeOpenAPIFile, {
ignore: [],
}, fakeLogger, { ruleName: '' })).toEqual(Object.assign(Object.assign({}, fakeOpenAPIFile), { document: Object.assign(Object.assign({}, fakeOpenAPIFile.document), { paths: {
'/pets': {
get: {
summary: '',
tags: [],
responses: {},
},
},
'/pet/:id': {
get: {
summary: '',
tags: [],
responses: {},
},
},
} }) }));
expect(fakeLogger.warning).toBeCalledTimes(0);
});
test('usage option: ignore', () => {
const fakeLogger = global.createFakeLogger();
const fakeOpenAPIFile = global.createFakeOpenAPIFile({
paths: {
'/pets': {
get: {
summary: '',
operationId: 'listPets',
tags: [],
responses: {},
},
},
'/pet/:id': {
get: {
summary: '',
operationId: 'petDetails',
tags: [],
responses: {},
},
},
},
});
expect(index_1.default.processDocument(fakeOpenAPIFile, {
ignore: ['listPets'],
}, fakeLogger, { ruleName: '' })).toEqual(Object.assign(Object.assign({}, fakeOpenAPIFile), { document: Object.assign(Object.assign({}, fakeOpenAPIFile.document), { paths: {
'/pets': {
get: {
summary: '',
operationId: 'listPets',
tags: [],
responses: {},
},
},
'/pet/:id': {
get: {
summary: '',
tags: [],
responses: {},
},
},
} }) }));
expect(fakeLogger.warning).toBeCalledTimes(0);
});
test('usage option: ignore, logger warning', () => {
const fakeLogger = global.createFakeLogger();
const fakeOpenAPIFile = global.createFakeOpenAPIFile({
paths: {
'/pets': {
get: {
operationId: 'listPets',
summary: '',
tags: [],
responses: {},
},
},
},
});
expect(index_1.default.processDocument(fakeOpenAPIFile, {
ignore: ['OperationId'],
}, fakeLogger, { ruleName: '' })).toEqual(Object.assign(Object.assign({}, fakeOpenAPIFile), { document: Object.assign(Object.assign({}, fakeOpenAPIFile.document), { paths: {
'/pets': {
get: {
summary: '',
tags: [],
responses: {},
},
},
} }) }));
expect(fakeLogger.warning).toBeCalledLoggerMethod(/OperationId/, 1);
});
});