feat(ipa): New rule xgen-IPA-125-oneOf-schema-property-same-type #873
Conversation
| }, | ||
| }, | ||
| ], | ||
| 'x-xgen-IPA-exception': { |
There was a problem hiding this comment.
Q: If the exception is defined at the schema level (via Swagger annotations), should the tracked path for exceptions also point to the schemas?
There was a problem hiding this comment.
Not sure I understand the question, could you clarify? Do you mean the path passed to the metrics?
There was a problem hiding this comment.
Yes, I’m trying to confirm whether the path passed to metrics should be the schema path where the exception is defined, or if we’re instead passing the oneOf path
There was a problem hiding this comment.
Yes the exception path is to oneOf. Since the adoption and violation are on the oneof path, it makes sense for the exception to be on the same path as well. Also, exceptions cannot be on the oneOf object, so therefore it's on the schema level
There was a problem hiding this comment.
So my suggestion is that we can collect adoption status on schema level instead of oneOf level, because the exception is also defined on the schema level. What do you think?
Proposed changes
Adds new warning-level rule checking that properties with the same name in oneOf schemas are of the same type.
If the property is a base type, it should have the same
typeis all oneOf schemas. If the property is of object type, it should have the same schema in all oneOf schemas.Current violations:
Jira ticket: CLOUDP-309117