79 lines
2.4 KiB
Plaintext
79 lines
2.4 KiB
Plaintext
import { outdent } from 'outdent';
|
|
import { lintDocument } from '../../../lint';
|
|
import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
|
|
import { BaseResolver } from '../../../resolve';
|
|
|
|
describe('Arazzo sourceDescription-type', () => {
|
|
const document = parseYamlToDocument(
|
|
outdent`
|
|
arazzo: '1.0.1'
|
|
info:
|
|
title: Cool API
|
|
version: 1.0.0
|
|
description: A cool API
|
|
sourceDescriptions:
|
|
- name: museum-api
|
|
type: openapi
|
|
url: openapi.yaml
|
|
- name: api
|
|
type: none
|
|
x-serverUrl: 'http://localhost/api'
|
|
workflows:
|
|
- workflowId: get-museum-hours
|
|
description: This workflow demonstrates how to get the museum opening hours and buy tickets.
|
|
parameters:
|
|
- in: header
|
|
name: Authorization
|
|
value: Basic Og==
|
|
steps:
|
|
- stepId: get-museum-hours
|
|
description: >-
|
|
Get museum hours by resolving request details with getMuseumHours operationId from openapi.yaml description.
|
|
operationId: museum-api.getMuseumHours
|
|
successCriteria:
|
|
- condition: $statusCode == 200
|
|
`,
|
|
'arazzo.yaml'
|
|
);
|
|
|
|
it('should report on sourceDescription with type `none`', async () => {
|
|
const results = await lintDocument({
|
|
externalRefResolver: new BaseResolver(),
|
|
document,
|
|
config: await makeConfig({
|
|
rules: { 'sourceDescription-type': 'error' },
|
|
}),
|
|
});
|
|
|
|
expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
|
|
[
|
|
{
|
|
"location": [
|
|
{
|
|
"pointer": "#/sourceDescriptions/1",
|
|
"reportOnKey": false,
|
|
"source": "arazzo.yaml",
|
|
},
|
|
],
|
|
"message": "The \`type\` property of the \`sourceDescription\` object must be either \`openapi\` or \`arazzo\`.",
|
|
"ruleId": "sourceDescription-type",
|
|
"severity": "error",
|
|
"suggest": [],
|
|
},
|
|
]
|
|
`);
|
|
});
|
|
|
|
it('should not report on sourceDescription with type `none`', async () => {
|
|
const results = await lintDocument({
|
|
externalRefResolver: new BaseResolver(),
|
|
document,
|
|
config: await makeConfig({
|
|
rules: { 'sourceDescription-type': 'off' },
|
|
}),
|
|
});
|
|
|
|
expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
|
|
});
|
|
});
|