Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ We're here to help! This is simply a reminder of what we are going to look for b
- [ ] I have signed the [MongoDB CLA](https://www.mongodb.com/legal/contributor-agreement)
- [ ] I have added tests that prove my fix is effective or that my feature works

### Changes to Spectral
- [ ] I have read the [README](../tools/spectral/README.md) file for Spectral Updates

## Further comments

<!--
Expand Down
2 changes: 1 addition & 1 deletion tools/spectral/.spectral.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ rules:
functionOptions:
match: "^(mms)$"
message: "'additionalServices' must be 'mms' as no other services are supported."

no-slash-before-custom-method:
description: "Custom methods (e.g., ':applyItem') should not be preceded by a '/'."
message: "The path '{{path}}' contains a '/' before a custom method. Custom methods should not start with a '/'."
Expand Down
14 changes: 7 additions & 7 deletions tools/spectral/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Spectral updates

If adding new rules or updating .spectral.yaml overall, the validations will instantly get updated across mongodb/openapi repository.

To propagate the changes in MMS, engineers must open a PR and update the pinned commit sha in mms.
If adding new rules or updating `.spectral.yaml` overall, the validations will instantly get updated across the `mongodb/openapi` repository.

Please perform the following steps:
1. [ ] Open a PR with the spectral changes and validate that the Spectral lint checks work.
2. [ ] Review and merge the PR.
3. [ ] Open a PR in mms, updating the commit sha of the spectral file imported.
4. [ ] Validate all tests pass.

1. Open a `mongodb/openapi` PR with the changes to `tools/spectral/.spectral.yaml`
2. Validate that the new Spectral lint checks pass
3. Review and merge the PR

**Note:** For MongoDB engineers, please review http://go/openapi-spectral-updates.
Loading