CLOUDP-271998: IPA-110: Pagination (Validate Paginated prefix and results array field)

[yelizhenden-mdb]

Proposed changes

Jira ticket: CLOUDP-271998 and CLOUDP-304955

This PR validates

• if 200 OK responses of List methods refer to a schema with "Paginated" prefix. (Related guideline amendment PR: https://github.com/10gen/ipa/pull/64)
• if 200 OK responses of List methods have a schema with results (array) fields

Clarification: The associated guideline the xgen-IPA-110-collections-response-define-results-array rule validating is The response for collections must define an array of results containing the paginated resource

This guideline is shared with xgen-IPA-105-list-method-response-is-get-method-response rule. The rule is already checking if the results array containing the paginated resource when the results array exists. Different than that, xgen-IPA-110-collections-response-define-results-array rule only checks if the List method response have a schema with results (array) fields.

Follow-up

• Having links field following ApiListView implementation will be validated in scope of another guideline The response for collections should define an array of links field, providing the user with links to the next and previous pages
• Having totalCount field is not required as it is mentioned in the The response for collections may provide an integer totalCount field, providing the user with the total number of resources available in the backing collection. This total may be an estimate but the API should explicitly document that
• For all the other Pagination guidelines, refer to IPA-110: Pagination to be implemented

Checklist

• I have signed the MongoDB CLA
• I have added tests that prove my fix is effective or that my feature works

Changes to Spectral

• I have read the README file for Spectral Updates

Further comments

[wtrocki]

Paginated prefix is weak requirement IMHO as we do not validate that in any way.
It is derrived from the class name. Do we see classes with Paginated that do not conform to th definition of page.
If not let's remove Paginated prefix.

[wtrocki]

Assumption: If schema name starts with Paginated, it will be assumed that it extends ApiListView, and the referenced schema will not be validated

That information should be present in the openapi already. Using name as assumption might lead to false negatives.

[wtrocki]

Suggesting to use reliance on the base class or check for format of the fields instead of the name.

[wtrocki]

Disscussed offline. Yeliz to make changes based on new IPA proposed rule.
Unblocking