CLOUDP-313321: Add a new Spectral lint rule that validates that at any time, an endpoint can only have one API version marked as “upcoming”

[jeroenvervaeke]

Proposed changes

Add a new Spectral lint rule that validates that at any time, an endpoint can only have one API version marked as “upcoming”

Jira ticket: CLOUDP-313321

[blva]

can we have unit tests like we have for ipa rule sets?

https://github.com/mongodb/openapi/tree/main/tools/spectral/ipa/__tests__

[jeroenvervaeke]

I missed those, didn't know it was possible! Thanks

[andreaangiolillo]

LGTM

[jeroenvervaeke]

Sorry for all the commits, this change broke our linter. Telling the linter in 2 places which files to scan caused issues, I opted to keep the line in the config file so all config is in one place.

I verified that removing **/*.js by running npx eslint --debug . and verifying the scanned files.

[wtrocki]

@jeroenvervaeke Before we merge, let's make sure to test this with MMS.
Happy to support you with that!
It looks like you've added the function specifically for legacy rules, so we should confirm that it works as expected.

[andreaangiolillo]

@wtrocki Do we have a wiki with the process?

[andreaangiolillo]

@jeroenvervaeke you can use this wiki to test your changes locally.

• (in MMS) update ./scripts/evergreen/openapi/.spectral.yaml to include the spectral in your PR:

extends:
  - spectral:oas
  - https://github.com/mongodb/openapi/blob/CLOUDP-313321/tools/spectral/.spectral.yaml

• run

spectral lint --ruleset ./scripts/evergreen/openapi/.spectral.yaml  /server/openapi/services/openapi-mms.json --verbose

[jeroenvervaeke]

Everything is green: https://spruce.mongodb.com/task/mms_local_openapi_required_OPENAPI_GENERATE_SPECS_patch_d3c941155214f15d13031884390b9e7068fcef09_682b4f962a3ef70007571064_25_05_19_15_36_22/logs?execution=0