CLOUDP-304963: IPA-114: Errors (check for 404 codes for parameterized endpoints)

[yelizhenden-mdb]

Proposed changes

Jira ticket: CLOUDP-304963

  xgen-IPA-114-parameterized-paths-have-404-not-found:
    description: |
      Paths with parameters must define 404 responses.

      ##### Implementation details
      This rule checks that all endpoints with path parameters (identified by '{param}' 
      in the path) include a 404 response to handle the case when the requested resource
      is not found.

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]

[Outside PR] Delete has it's own rule covering 404. If if introduce generic rule (which I think makes sense) we should remove dedicated 404 rule for delete. Is that planned? WDYT?

[wtrocki]

[Question] Separately - what is the purpose of mentioning all of the methods here.
I guess you wanted to exclude exceptions? If yes the same filtering can be done in the code.

[yelizhenden-mdb]

Yes, I wanted to exclude exceptions and all the stuff other than HTTP verbs. I agree that it can be handled in the code, but it is widely used approach at the moment, so I followed it

We can remove the dedicated 404 rule for delete, as you said it will be covered by this one. I will share the PR for removing it in a separate PR, if that is okay

[wtrocki]

Thank you.

[wtrocki]

LGTM with follow up recommendation.

[Copilot]

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.