CLOUDP-306573: IPA rule - plaintext repsonse has example #628
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| import testRule from './__helpers__/testRule'; | ||
| import { DiagnosticSeverity } from '@stoplight/types'; | ||
|
|
||
| testRule('xgen-IPA-117-plaintext-response-must-have-example', [ | ||
| { | ||
| name: 'valid responses', | ||
| document: { | ||
| paths: { | ||
| '/resource': { | ||
| get: { | ||
| responses: { | ||
| 200: { | ||
| content: { | ||
| 'application/vnd.atlas.2023-01-01+csv': { | ||
| example: 'test', | ||
| schema: {}, | ||
| }, | ||
| 'text/plain': { | ||
| schema: { | ||
| example: 'test', | ||
| type: 'string', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| // Ignores non-2xx | ||
| 400: { | ||
| content: { | ||
| 'text/plain': { | ||
| schema: {}, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| // Ignores JSON/YAML | ||
| '/resourceTwo': { | ||
| get: { | ||
| responses: { | ||
| 200: { | ||
| content: { | ||
| 'application/vnd.atlas.2024-08-05+json': { | ||
| type: 'string', | ||
| }, | ||
| 'application/vnd.atlas.2024-08-05+yaml': { | ||
| type: 'string', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [], | ||
| }, | ||
| { | ||
| name: 'invalid resources', | ||
| document: { | ||
| paths: { | ||
| '/resource': { | ||
| get: { | ||
| responses: { | ||
| 200: { | ||
| content: { | ||
| 'application/vnd.atlas.2022-01-01+csv': { | ||
| schema: {}, | ||
| }, | ||
| 'application/vnd.atlas.2023-01-01+csv': { | ||
| schema: {}, | ||
| }, | ||
| 'text/plain': { | ||
| schema: { | ||
| type: 'string', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [ | ||
| { | ||
| code: 'xgen-IPA-117-plaintext-response-must-have-example', | ||
| message: 'For APIs that respond with plain text, for example CSV, API producers must provide an example.', | ||
| path: ['paths', '/resource', 'get', 'responses', '200', 'content', 'application/vnd.atlas.2022-01-01+csv'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| { | ||
| code: 'xgen-IPA-117-plaintext-response-must-have-example', | ||
| message: 'For APIs that respond with plain text, for example CSV, API producers must provide an example.', | ||
| path: ['paths', '/resource', 'get', 'responses', '200', 'content', 'application/vnd.atlas.2023-01-01+csv'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| { | ||
| code: 'xgen-IPA-117-plaintext-response-must-have-example', | ||
| message: 'For APIs that respond with plain text, for example CSV, API producers must provide an example.', | ||
| path: ['paths', '/resource', 'get', 'responses', '200', 'content', 'text/plain'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| name: 'invalid resources with exceptions', | ||
| document: { | ||
| paths: { | ||
| '/resource': { | ||
| get: { | ||
| responses: { | ||
| 200: { | ||
| content: { | ||
| 'application/vnd.atlas.2022-01-01+csv': { | ||
| schema: {}, | ||
| 'x-xgen-IPA-exception': { | ||
| 'xgen-IPA-117-plaintext-response-must-have-example': 'reason', | ||
| }, | ||
| }, | ||
| 'application/vnd.atlas.2023-01-01+csv': { | ||
| schema: {}, | ||
| 'x-xgen-IPA-exception': { | ||
| 'xgen-IPA-117-plaintext-response-must-have-example': 'reason', | ||
| }, | ||
| }, | ||
| 'text/plain': { | ||
| schema: { | ||
| type: 'string', | ||
| }, | ||
| 'x-xgen-IPA-exception': { | ||
| 'xgen-IPA-117-plaintext-response-must-have-example': 'reason', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [], | ||
| }, | ||
| ]); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| import { hasException } from './utils/exceptions.js'; | ||
| import { | ||
| collectAdoption, | ||
| collectAndReturnViolation, | ||
| collectException, | ||
| handleInternalError, | ||
| } from './utils/collectionUtils.js'; | ||
| import { resolveObject } from './utils/componentUtils.js'; | ||
|
|
||
| const RULE_NAME = 'xgen-IPA-117-plaintext-response-must-have-example'; | ||
| const ERROR_MESSAGE = 'For APIs that respond with plain text, for example CSV, API producers must provide an example.'; | ||
|
|
||
| /** | ||
| * For APIs that respond with plain text, for example CSV, API producers must provide an example. | ||
| * | ||
| * @param {object} input - A response media type | ||
| * @param {{allowedTypes: string[]}} opts - Allowed type suffixes, if the type ends with one of these, it is ignored | ||
| * @param {object} context - The context object containing the path and documentInventory | ||
| */ | ||
| export default (input, { allowedTypes }, { documentInventory, path }) => { | ||
| const responseCode = path[4]; | ||
|
|
||
| // Ignore non-2xx responses | ||
| if (!responseCode.startsWith('2')) { | ||
| return; | ||
| } | ||
|
|
||
| // Ignore allowed types | ||
| if (allowedTypes.some((type) => input.endsWith(type))) { | ||
| return; | ||
| } | ||
|
|
||
| const response = resolveObject(documentInventory.resolved, path); | ||
|
|
||
| if (hasException(response, RULE_NAME)) { | ||
| collectException(response, RULE_NAME, path); | ||
| return; | ||
| } | ||
|
|
||
| const errors = checkViolationsAndReturnErrors(response, path); | ||
| if (errors.length !== 0) { | ||
| return collectAndReturnViolation(path, RULE_NAME, errors); | ||
| } | ||
| collectAdoption(path, RULE_NAME); | ||
| }; | ||
|
|
||
| function checkViolationsAndReturnErrors(response, path) { | ||
| try { | ||
| if (response['example'] || (response['schema'] && response['schema']['example'])) { | ||
| return []; | ||
| } | ||
| return [{ path, message: ERROR_MESSAGE }]; | ||
| } catch (e) { | ||
| handleInternalError(RULE_NAME, path, e); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❤️