-
Notifications
You must be signed in to change notification settings - Fork 14
feat(ipa): new rules for operation summaries starting with specific words #903
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
93 changes: 93 additions & 0 deletions
93
tools/spectral/ipa/__tests__/IPA117OperationSummaryCreateStartsWith.test.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| import testRule from './__helpers__/testRule'; | ||
| import { DiagnosticSeverity } from '@stoplight/types'; | ||
|
|
||
| testRule('xgen-IPA-117-create-operation-summary-starts-with', [ | ||
| { | ||
| name: 'valid summary', | ||
| document: { | ||
| paths: { | ||
| '/resource': { | ||
| post: { | ||
| summary: 'Create One Resource', | ||
| }, | ||
| }, | ||
| '/projects/{id}/users': { | ||
| post: { | ||
| summary: 'Add One User to One Project', | ||
| }, | ||
| }, | ||
| '/projects/{id}/users:invite': { | ||
| // Ignores custom method | ||
| post: { | ||
| summary: 'Invite One User to One Project', | ||
| }, | ||
| }, | ||
| '/projects/{id}/users/invite': { | ||
| // Ignores legacy custom method | ||
| post: { | ||
| summary: 'Invite One User to One Project', | ||
| 'x-xgen-method-verb-override': { | ||
| customMethod: true, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [], | ||
| }, | ||
| { | ||
| name: 'invalid summaries', | ||
| document: { | ||
| paths: { | ||
| '/resource': { | ||
| post: { | ||
| summary: 'Creating One Resource', | ||
| }, | ||
| }, | ||
| '/projects/{id}/users': { | ||
| post: { | ||
| summary: 'Adds One User to One Project', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [ | ||
| { | ||
| code: 'xgen-IPA-117-create-operation-summary-starts-with', | ||
| message: 'Operation summary must start with one of the words [Create,Add].', | ||
| path: ['paths', '/resource', 'post'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| { | ||
| code: 'xgen-IPA-117-create-operation-summary-starts-with', | ||
| message: 'Operation summary must start with one of the words [Create,Add].', | ||
| path: ['paths', '/projects/{id}/users', 'post'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| name: 'invalid summary with exceptions', | ||
| document: { | ||
| paths: { | ||
| '/resource': { | ||
| post: { | ||
| summary: 'Creating One Resource', | ||
| 'x-xgen-IPA-exception': { | ||
| 'xgen-IPA-117-create-operation-summary-starts-with': 'reason', | ||
| }, | ||
| }, | ||
| }, | ||
| '/projects/{id}/users': { | ||
| post: { | ||
| summary: 'Adds One User to One Project', | ||
| 'x-xgen-IPA-exception': { | ||
| 'xgen-IPA-117-create-operation-summary-starts-with': 'reason', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [], | ||
| }, | ||
| ]); |
78 changes: 78 additions & 0 deletions
78
tools/spectral/ipa/__tests__/IPA117OperationSummaryDeleteStartsWith.test.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| import testRule from './__helpers__/testRule'; | ||
| import { DiagnosticSeverity } from '@stoplight/types'; | ||
|
|
||
| testRule('xgen-IPA-117-delete-operation-summary-starts-with', [ | ||
| { | ||
| name: 'valid summary', | ||
| document: { | ||
| paths: { | ||
| '/resource': { | ||
| delete: { | ||
| summary: 'Delete One Resource', | ||
| }, | ||
| }, | ||
| '/projects/{id}/users': { | ||
| delete: { | ||
| summary: 'Remove One User from One Project', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [], | ||
| }, | ||
| { | ||
| name: 'invalid summaries', | ||
| document: { | ||
| paths: { | ||
| '/resource': { | ||
| delete: { | ||
| summary: 'Destroy One Resource', | ||
| }, | ||
| }, | ||
| '/projects/{id}/users': { | ||
| delete: { | ||
| summary: 'Deletes One User from One Project', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [ | ||
| { | ||
| code: 'xgen-IPA-117-delete-operation-summary-starts-with', | ||
| message: 'Operation summary must start with one of the words [Delete,Remove].', | ||
| path: ['paths', '/resource', 'delete'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| { | ||
| code: 'xgen-IPA-117-delete-operation-summary-starts-with', | ||
| message: 'Operation summary must start with one of the words [Delete,Remove].', | ||
| path: ['paths', '/projects/{id}/users', 'delete'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| name: 'invalid summary with exceptions', | ||
| document: { | ||
| paths: { | ||
| '/resource': { | ||
| delete: { | ||
| summary: 'Destroy One Resource', | ||
| 'x-xgen-IPA-exception': { | ||
| 'xgen-IPA-117-delete-operation-summary-starts-with': 'reason', | ||
| }, | ||
| }, | ||
| }, | ||
| '/projects/{id}/users': { | ||
| delete: { | ||
| summary: 'Deletes One User from One Project', | ||
| 'x-xgen-IPA-exception': { | ||
| 'xgen-IPA-117-delete-operation-summary-starts-with': 'reason', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [], | ||
| }, | ||
| ]); |
78 changes: 78 additions & 0 deletions
78
tools/spectral/ipa/__tests__/IPA117OperationSummaryUpdateStartsWith.test.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| import testRule from './__helpers__/testRule'; | ||
| import { DiagnosticSeverity } from '@stoplight/types'; | ||
|
|
||
| testRule('xgen-IPA-117-update-operation-summary-starts-with', [ | ||
| { | ||
| name: 'valid summary', | ||
| document: { | ||
| paths: { | ||
| '/resource': { | ||
| patch: { | ||
| summary: 'Update One Resource', | ||
| }, | ||
| }, | ||
| '/projects/{id}/users': { | ||
| put: { | ||
| summary: 'Update One User in One Project', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [], | ||
| }, | ||
| { | ||
| name: 'invalid summaries', | ||
| document: { | ||
| paths: { | ||
| '/resource': { | ||
| patch: { | ||
| summary: 'Modify One Resource', | ||
| }, | ||
| }, | ||
| '/projects/{id}/users': { | ||
| put: { | ||
| summary: 'Change One User to One Project', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [ | ||
| { | ||
| code: 'xgen-IPA-117-update-operation-summary-starts-with', | ||
| message: 'Operation summary must start with the word "Update".', | ||
| path: ['paths', '/resource', 'patch'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| { | ||
| code: 'xgen-IPA-117-update-operation-summary-starts-with', | ||
| message: 'Operation summary must start with the word "Update".', | ||
| path: ['paths', '/projects/{id}/users', 'put'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| name: 'invalid summary with exceptions', | ||
| document: { | ||
| paths: { | ||
| '/resource': { | ||
| patch: { | ||
| summary: 'Modify One Resource', | ||
| 'x-xgen-IPA-exception': { | ||
| 'xgen-IPA-117-update-operation-summary-starts-with': 'reason', | ||
| }, | ||
| }, | ||
| }, | ||
| '/projects/{id}/users': { | ||
| put: { | ||
| summary: 'Change One User to One Project', | ||
| 'x-xgen-IPA-exception': { | ||
| 'xgen-IPA-117-update-operation-summary-starts-with': 'reason', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [], | ||
| }, | ||
| ]); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💯