CLOUDP-272001: IPA-112: Disallow usages of project in the api

[yelizhenden-mdb]

Proposed changes

Jira ticket: CLOUDP-272001

Schema field names should avoid using "project", "projects", or "projectId".

      ##### Implementation details
      Rule checks for the following conditions:
        - Searches through all schemas in the API definition
        - Identifies property names that match "project" (case-insensitive)
        - Reports any instances where these field names are used
        - Suggests using "group", "groups", or "groupId" as alternatives

15 violations 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]

[Nit] can we have this as array? I can see more prohibited names in future

[lovisaberggren]

Q: Is it possible to have exceptions on properties? IIRC when we did the enum rule we had to have the exception on the schema

[yelizhenden-mdb]

For enum one, we have the exceptions on the property level. Ex:

"roleName": {
            "description": "Human-readable label that identifies a group of privileges assigned to a database user. This value can either be a built-in role or a custom role.",
            "enum": [
              "atlasAdmin",
               ...
            ],
            "type": "string",
            "x-xgen-IPA-exception": {
              "xgen-IPA-123-enum-values-must-be-upper-snake-case": "Schema predates IPA validation"
            }
          }

which is equivalent of Schema annotation for the property itself on Java. I kept the same level for exception. Are you asking keeping the exception level for Schema annotation level but for the schema level?

[lovisaberggren]

Ah thanks for clarifying, I misremembered and thought it was on the schema level higher up. LGTM 👍

[lovisaberggren]

(Prettier failure, otherwise LGTM)

[wtrocki]

@yelizhenden-mdb Feel free to setup commit hook. It will sort out prettier during commit