UNPKG

@redocly/openapi-core

Version:

See https://github.com/Redocly/openapi-cli

92 lines (82 loc) 2.5 kB
import { outdent } from 'outdent'; import { lintDocument } from '../../../lint'; import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils'; import { BaseResolver } from '../../../resolve'; describe('Oas3 operation-2xx-response', () => { it('should report missing 2xx response', async () => { const document = parseYamlToDocument( outdent` openapi: 3.0.0 paths: '/test': put: responses: 400: description: bad response `, 'foobar.yaml', ); const results = await lintDocument({ externalRefResolver: new BaseResolver(), document, config: makeConfig({ 'operation-2xx-response': 'error' }), }); expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(` Array [ Object { "location": Array [ Object { "pointer": "#/paths/~1test/put/responses", "reportOnKey": true, "source": "foobar.yaml", }, ], "message": "Operation must have at least one \`2xx\` response.", "ruleId": "operation-2xx-response", "severity": "error", "suggest": Array [], }, ] `); }); it('should not report for present 2xx response', async () => { const document = parseYamlToDocument( outdent` openapi: 3.0.0 paths: '/test/': put: responses: 200: description: ok `, 'foobar.yaml', ); const results = await lintDocument({ externalRefResolver: new BaseResolver(), document, config: makeConfig({ 'operation-2xx-response': 'error' }), }); expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`); }); it('should not report for present default', async () => { const document = parseYamlToDocument( outdent` openapi: 3.0.0 paths: '/test/': put: responses: default: description: ok `, 'foobar.yaml', ); const results = await lintDocument({ externalRefResolver: new BaseResolver(), document, config: makeConfig({ 'operation-2xx-response': 'error' }), }); expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`); }); });