CLOUDP-302982: IPA-104 - Get object should have suffix "Response" #465
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,263 @@ | ||||||
| import testRule from './__helpers__/testRule'; | ||||||
| import { DiagnosticSeverity } from '@stoplight/types'; | ||||||
|
|
||||||
| const componentSchemas = { | ||||||
| schemas: { | ||||||
| SchemaResponse: { | ||||||
| type: 'object', | ||||||
| }, | ||||||
| Schema: { | ||||||
| type: 'object', | ||||||
| }, | ||||||
| }, | ||||||
| }; | ||||||
|
|
||||||
| testRule('xgen-IPA-104-get-method-returns-response-suffixed-object', [ | ||||||
| { | ||||||
| name: 'valid schema names names', | ||||||
| document: { | ||||||
| paths: { | ||||||
| '/resource/{id}': { | ||||||
| get: { | ||||||
| responses: { | ||||||
| 200: { | ||||||
| content: { | ||||||
| 'application/vnd.atlas.2023-01-01+json': { | ||||||
| schema: { | ||||||
| $ref: '#/components/schemas/SchemaResponse', | ||||||
| }, | ||||||
| }, | ||||||
| 'application/vnd.atlas.2024-01-01+json': { | ||||||
| schema: { | ||||||
| $ref: '#/components/schemas/SchemaResponse', | ||||||
|
There was a problem hiding this comment. What would be our approach for inline schemas (properties defined here). There was a problem hiding this comment. Currently the rule will fail and tell the API producer to implement a schema ref, same approach as we did in #473 |
||||||
| }, | ||||||
| }, | ||||||
| 'application/vnd.atlas.2025-01-01+json': { | ||||||
| schema: { | ||||||
| type: 'array', | ||||||
| items: { | ||||||
| $ref: '#/components/schemas/SchemaResponse', | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| 400: { | ||||||
| content: { | ||||||
| 'application/vnd.atlas.2023-01-01+json': { | ||||||
| schema: { | ||||||
| $ref: '#/components/schemas/Schema', | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| '/resourceTwo/{id}': { | ||||||
| get: { | ||||||
| responses: { | ||||||
| 200: { | ||||||
| content: { | ||||||
| 'application/vnd.atlas.2024-08-05+json': { | ||||||
| type: 'string', | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| '/resource/{id}/singleton': { | ||||||
| get: { | ||||||
| responses: { | ||||||
| 200: { | ||||||
| content: { | ||||||
| 'application/vnd.atlas.2024-08-05+json': { | ||||||
| schema: { | ||||||
| $ref: '#/components/schemas/SchemaResponse', | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| components: componentSchemas, | ||||||
| }, | ||||||
| errors: [], | ||||||
| }, | ||||||
| { | ||||||
| name: 'invalid resources', | ||||||
| document: { | ||||||
| paths: { | ||||||
| '/resource/{id}': { | ||||||
| get: { | ||||||
| responses: { | ||||||
| 200: { | ||||||
| content: { | ||||||
| 'application/vnd.atlas.2023-01-01+json': { | ||||||
| schema: { | ||||||
| $ref: '#/components/schemas/Schema', | ||||||
| }, | ||||||
| }, | ||||||
| 'application/vnd.atlas.2024-01-01+json': { | ||||||
| schema: { | ||||||
| $ref: '#/components/schemas/Schema', | ||||||
| }, | ||||||
| }, | ||||||
| 'application/vnd.atlas.2025-01-01+json': { | ||||||
| schema: { | ||||||
| type: 'array', | ||||||
| items: { | ||||||
| $ref: '#/components/schemas/Schema', | ||||||
|
There was a problem hiding this comment. example to ignore
Suggested change
|
||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| '/resource/{id}/singleton': { | ||||||
| get: { | ||||||
| responses: { | ||||||
| 200: { | ||||||
|
There was a problem hiding this comment. Optional: Test for two 2xx response codes. There was a problem hiding this comment. That would be an invalid json since we cannot have two keys of the same value |
||||||
| content: { | ||||||
| 'application/vnd.atlas.2024-08-05+json': { | ||||||
| schema: { | ||||||
| $ref: '#/components/schemas/Schema', | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| components: componentSchemas, | ||||||
| }, | ||||||
| errors: [ | ||||||
| { | ||||||
| code: 'xgen-IPA-104-get-method-returns-response-suffixed-object', | ||||||
| message: 'The request schema must reference a schema with a Response suffix. http://go/ipa/104', | ||||||
| path: [ | ||||||
| 'paths', | ||||||
| '/resource/{id}', | ||||||
| 'get', | ||||||
| 'responses', | ||||||
| '200', | ||||||
| 'content', | ||||||
| 'application/vnd.atlas.2023-01-01+json', | ||||||
| ], | ||||||
| severity: DiagnosticSeverity.Warning, | ||||||
| }, | ||||||
| { | ||||||
| code: 'xgen-IPA-104-get-method-returns-response-suffixed-object', | ||||||
| message: 'The request schema must reference a schema with a Response suffix. http://go/ipa/104', | ||||||
| path: [ | ||||||
| 'paths', | ||||||
| '/resource/{id}', | ||||||
| 'get', | ||||||
| 'responses', | ||||||
| '200', | ||||||
| 'content', | ||||||
| 'application/vnd.atlas.2024-01-01+json', | ||||||
| ], | ||||||
| severity: DiagnosticSeverity.Warning, | ||||||
| }, | ||||||
| { | ||||||
| code: 'xgen-IPA-104-get-method-returns-response-suffixed-object', | ||||||
| message: 'The request schema must reference a schema with a Response suffix. http://go/ipa/104', | ||||||
| path: [ | ||||||
| 'paths', | ||||||
| '/resource/{id}', | ||||||
| 'get', | ||||||
| 'responses', | ||||||
| '200', | ||||||
| 'content', | ||||||
| 'application/vnd.atlas.2025-01-01+json', | ||||||
| ], | ||||||
| severity: DiagnosticSeverity.Warning, | ||||||
| }, | ||||||
| { | ||||||
| code: 'xgen-IPA-104-get-method-returns-response-suffixed-object', | ||||||
| message: 'The request schema must reference a schema with a Response suffix. http://go/ipa/104', | ||||||
| path: [ | ||||||
| 'paths', | ||||||
| '/resource/{id}/singleton', | ||||||
| 'get', | ||||||
| 'responses', | ||||||
| '200', | ||||||
| 'content', | ||||||
| 'application/vnd.atlas.2024-08-05+json', | ||||||
| ], | ||||||
| severity: DiagnosticSeverity.Warning, | ||||||
| }, | ||||||
| ], | ||||||
| }, | ||||||
| { | ||||||
| name: 'invalid resources with exceptions', | ||||||
| document: { | ||||||
| paths: { | ||||||
| '/resource/{id}': { | ||||||
| get: { | ||||||
| responses: { | ||||||
| 200: { | ||||||
| content: { | ||||||
| 'application/vnd.atlas.2023-01-01+json': { | ||||||
| 'x-xgen-IPA-exception': { | ||||||
| 'xgen-IPA-104-get-method-returns-response-suffixed-object': 'reason', | ||||||
| }, | ||||||
| schema: { | ||||||
| $ref: '#/components/schemas/Schema', | ||||||
| }, | ||||||
| }, | ||||||
| 'application/vnd.atlas.2024-01-01+json': { | ||||||
| 'x-xgen-IPA-exception': { | ||||||
| 'xgen-IPA-104-get-method-returns-response-suffixed-object': 'reason', | ||||||
| }, | ||||||
| schema: { | ||||||
| $ref: '#/components/schemas/Schema', | ||||||
| }, | ||||||
| }, | ||||||
| 'application/vnd.atlas.2025-01-01+json': { | ||||||
| 'x-xgen-IPA-exception': { | ||||||
| 'xgen-IPA-104-get-method-returns-response-suffixed-object': 'reason', | ||||||
| }, | ||||||
| schema: { | ||||||
| type: 'array', | ||||||
| items: { | ||||||
| $ref: '#/components/schemas/Schema', | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| '/resource/{id}/singleton': { | ||||||
| get: { | ||||||
| responses: { | ||||||
| 200: { | ||||||
| content: { | ||||||
| 'application/vnd.atlas.2024-08-05+json': { | ||||||
| 'x-xgen-IPA-exception': { | ||||||
| 'xgen-IPA-104-get-method-returns-response-suffixed-object': 'reason', | ||||||
| }, | ||||||
| schema: { | ||||||
| $ref: '#/components/schemas/Schema', | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| }, | ||||||
| components: componentSchemas, | ||||||
| }, | ||||||
| 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,46 @@ | ||
| import { | ||
| isSingleResourceIdentifier, | ||
| isSingletonResource, | ||
| getResourcePathItems, | ||
| isResourceCollectionIdentifier, | ||
| } from './utils/resourceEvaluation.js'; | ||
| import { resolveObject } from './utils/componentUtils.js'; | ||
| import { hasException } from './utils/exceptions.js'; | ||
| import { collectAdoption, collectAndReturnViolation, collectException } from './utils/collectionUtils.js'; | ||
| import { getSchemaRef } from './utils/methodUtils.js'; | ||
|
|
||
| const RULE_NAME = 'xgen-IPA-104-get-method-returns-response-suffixed-object'; | ||
| const ERROR_MESSAGE_SCHEMA_NAME = 'The request schema must reference a schema with a Response suffix.'; | ||
| const ERROR_MESSAGE_SCHEMA_REF = 'The response body schema is defined inline and must reference a predefined schema.'; | ||
|
|
||
| export default (input, _, { path, documentInventory }) => { | ||
| const resourcePath = path[1]; | ||
| const responseCode = path[4]; | ||
| const oas = documentInventory.unresolved; | ||
| const resourcePaths = getResourcePathItems(resourcePath, oas.paths); | ||
|
|
||
| if ( | ||
| responseCode.startsWith('2') || | ||
| isResourceCollectionIdentifier(resourcePath) || | ||
| (isSingleResourceIdentifier(resourcePath) && isSingletonResource(resourcePaths)) | ||
| ) { | ||
| const contentPerMediaType = resolveObject(oas, path); | ||
|
|
||
| if (hasException(contentPerMediaType, RULE_NAME)) { | ||
| collectException(contentPerMediaType, RULE_NAME, path); | ||
| return; | ||
| } | ||
|
|
||
| if (contentPerMediaType.schema) { | ||
| const schema = contentPerMediaType.schema; | ||
| const schemaRef = getSchemaRef(schema); | ||
| if (!schemaRef) { | ||
| return collectAndReturnViolation(path, RULE_NAME, ERROR_MESSAGE_SCHEMA_REF); | ||
| } | ||
| if (!schemaRef.endsWith('Response')) { | ||
| return collectAndReturnViolation(path, RULE_NAME, ERROR_MESSAGE_SCHEMA_NAME); | ||
| } | ||
| collectAdoption(path, RULE_NAME); | ||
| } | ||
| } | ||
| }; |
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
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.
Technical note to add:
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.
Yup, I'm good with that, can document when merged