@redocly/openapi-core
Version:
See https://github.com/Redocly/openapi-cli
66 lines (59 loc) • 2.05 kB
text/typescript
import { outdent } from 'outdent';
import { lintDocument } from '../../../lint';
import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
import { BaseResolver } from '../../../resolve';
describe('Oas3 oas3-no-example-value-and-externalValue', () => {
it('oas3-no-example-value-and-externalValue: should report on example object with both value and external value', async () => {
const document = parseYamlToDocument(
outdent`
openapi: 3.0.0
components:
examples:
some:
value: 12
externalValue: https://1.1.1.1
`,
'foobar.yaml',
);
const results = await lintDocument({
externalRefResolver: new BaseResolver(),
document,
config: makeConfig({ 'no-example-value-and-externalValue': 'error' }),
});
expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
Array [
Object {
"location": Array [
Object {
"pointer": "#/components/examples/some/value",
"reportOnKey": true,
"source": "foobar.yaml",
},
],
"message": "Example object can have either \`value\` or \`externalValue\` fields.",
"ruleId": "no-example-value-and-externalValue",
"severity": "error",
"suggest": Array [],
},
]
`);
});
it('oas3-no-example-value-and-externalValue: should not report on example object with value OR external value', async () => {
const document = parseYamlToDocument(
outdent`
openapi: 3.0.0
components:
examples:
some:
value: 12
`,
'foobar.yaml',
);
const results = await lintDocument({
externalRefResolver: new BaseResolver(),
document,
config: makeConfig({ 'no-example-value-and-externalValue': 'error' }),
});
expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
});
});