CLOUDP-304053: IPA-106:Create - The resource must be the request body (Refinement) #548
Conversation
Super important assumption! We need to have it across all rules! |
| ##### Implementation details | ||
| Validation checks the POST method for resource collection paths. | ||
| - Validation ignores resources without a Get method. |
There was a problem hiding this comment.
| - Validation ignores resources without a Get method. | |
| - Validation ignores resources without a GET method. |
There was a problem hiding this comment.
Seems like wider issue. Can be done across all the docs.
| if (postRequestSchemaRef && getResponseSchemaRef) { | ||
| const postRequestSchemaName = getSchemaNameFromRef(postRequestSchemaRef); | ||
| const getResponseSchemaName = getSchemaNameFromRef(getResponseSchemaRef); | ||
| if (postRequestSchemaName === getResponseSchemaName) { | ||
| return []; | ||
| } | ||
| } |
There was a problem hiding this comment.
Why not compare all the refs instead.
| if (postRequestSchemaRef && getResponseSchemaRef) { | |
| const postRequestSchemaName = getSchemaNameFromRef(postRequestSchemaRef); | |
| const getResponseSchemaName = getSchemaNameFromRef(getResponseSchemaRef); | |
| if (postRequestSchemaName === getResponseSchemaName) { | |
| return []; | |
| } | |
| } | |
| if (postRequestSchemaRef && getResponseSchemaRef) { | |
| if (postRequestSchemaRef === getResponseSchemaRef) { | |
| return []; | |
| } | |
| } |
There was a problem hiding this comment.
Applied on your behalf as this is minor correction. We can restore it if that is an issue.
There was a problem hiding this comment.
There are multiple ways to define components in openapi thus relying on last part of the reference is not reliable:
| return removePropertyByFlag(schema, 'writeOnly'); | ||
| export function removeRequestProperties(schema) { | ||
| let result = removePropertiesByFlag(schema, 'writeOnly'); | ||
| return removePropertyKeys(result, 'title', 'description', 'required'); |
There was a problem hiding this comment.
Not blocking/General comment:
hardcoding filtered properties in helper method can be seen as technical debt. Helper should get those values injected as array from config or caller. Otherwise we might be seeing ourselves creating urgent PR's to add more properties etc. over the time.
2 participants
Proposed changes
Jira ticket: CLOUDP-304053
Refinements:
-- Properties will be compared based on their names and types
-- Resolved oneOf, allOf, anyOf, and discriminator field values are expected to be completely same
Checklist
Changes to Spectral
Further comments