CLOUDP-305821: IPA Validation Repo Documentation #671
Merged
Conversation
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
wtrocki
reviewed
Apr 8, 2025
wtrocki
reviewed
Apr 8, 2025
wtrocki
reviewed
Apr 8, 2025
tools/spectral/ipa/CONTRIBUTING.md
Outdated
| "x-xgen-IPA-exception": { | ||
| "xgen-IPA-104-resource-has-GET": "Legacy API, not used by infrastructure-as-code tooling", | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Copy part from the spec when you mention exception placements or reference to openapi file as example of exceptions
There was a problem hiding this comment.
Exception placements are also referring to the MMS Java code, should we include it?
There was a problem hiding this comment.
I meant that you can list examples where exception can be placed or not placed.
Example:
For example on how to place exceptions please refer to the atlas openapi file [ref]
Or
Exceptions can be typically correlated with spectral `given` value and placed on:
- in path object
- in each http method, requests and responses
- components. schemas objects
wtrocki
reviewed
Apr 8, 2025
tools/spectral/ipa/CONTRIBUTING.md
Outdated
Comment on lines
69
to
88
| ### Resource & Singleton Evaluation | ||
|
|
||
| In the IPA Spectral validation, a resource can be identified using a resource collection path. | ||
|
|
||
| For example, resource collection path: `/resource` | ||
|
|
||
| - To get all paths and the path objects for this resource, use [getResourcePathItems](https://github.com/mongodb/openapi/blob/99823b3dfd315f892c5f64f1db50f2124261929c/tools/spectral/ipa/rulesets/functions/utils/resourceEvaluation.js#L143) | ||
|
|
||
| - Will return path objects for paths (if present): | ||
| - Resource collection path `/resource` | ||
| - Single resource path `/resource + /{someId}` | ||
| - Custom method path(s) | ||
| - `/resource + /{someId} + :customMethod` | ||
| - `/resource + :customMethod` | ||
|
|
||
| - To check if a resource is a singleton, take the returned object from [getResourcePathItems](https://github.com/mongodb/openapi/blob/99823b3dfd315f892c5f64f1db50f2124261929c/tools/spectral/ipa/rulesets/functions/utils/resourceEvaluation.js#L143) and evaluate the resource using [isSingletonResource](https://github.com/mongodb/openapi/blob/99823b3dfd315f892c5f64f1db50f2124261929c/tools/spectral/ipa/rulesets/functions/utils/resourceEvaluation.js#L71) | ||
| - To check if a path belongs to a resource collection, use [isResourceCollectionIdentifier](https://github.com/mongodb/openapi/blob/99823b3dfd315f892c5f64f1db50f2124261929c/tools/spectral/ipa/rulesets/functions/utils/resourceEvaluation.js#L13) | ||
| - To check if a path belongs to a single resource, use [isSingleResourceIdentifier](https://github.com/mongodb/openapi/blob/99823b3dfd315f892c5f64f1db50f2124261929c/tools/spectral/ipa/rulesets/functions/utils/resourceEvaluation.js#L31) | ||
|
|
||
|  Note: Paths like `/resource/resource` or `/resource/{id}/{id}` are not evaluated as valid resource or single resource paths using isResourceCollectionIdentifier or isSingleResourceIdentifier. |
There was a problem hiding this comment.
Wondering if that can be incorporated into rules documentation?
This would not be typical content in Contributing
There was a problem hiding this comment.
I think this is an implementation detail, so I thought that it might stay here in contributing. I will rephrase it a bit
wtrocki
reviewed
Apr 8, 2025
wtrocki
reviewed
Apr 8, 2025
wtrocki
reviewed
Apr 8, 2025
wtrocki
reviewed
Apr 8, 2025
wtrocki
approved these changes
Apr 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Proposed changes
Jira ticket: CLOUDP-305821
Checklist
Changes to Spectral
Further comments