CLOUDP 328959: OperationID Validation functions for Create, Delete, and Update methods #805
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| import testRule from './__helpers__/testRule'; | ||
|
|
||
| // TODO: add tests for xgen-custom-method extension - CLOUDP-306294 | ||
| // TOOD: enable tests for invalid methods (after rules are upgraded to warning) - CLOUDP-329722 | ||
|
|
||
| const componentSchemas = { | ||
sphterry marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| schemas: { | ||
| Schema: { | ||
| type: 'object', | ||
| }, | ||
| }, | ||
| operationId: 'string', | ||
| }; | ||
|
|
||
| testRule('xgen-IPA-106-valid-operation-id', [ | ||
| { | ||
| name: 'valid methods', | ||
| document: { | ||
| components: componentSchemas, | ||
| paths: { | ||
| '/groups/{groupId}/clusters': { | ||
| post: { | ||
| operationId: 'createGroupCluster', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [], | ||
| }, | ||
| // This test will be enable when the xgen-IPA-106-valid-operation-id is set to warning severity - CLOUDP-329722 | ||
| /* { | ||
| name: 'invalid methods', | ||
| document: { | ||
| components: componentSchemas, | ||
| paths: { | ||
| '/api/atlas/v2/groups/{groupId}/access': { | ||
| post: { | ||
| operationId: 'addUserToProject', | ||
| }, | ||
| }, | ||
| '/api/atlas/v2/groups/{groupId}/invites': { | ||
| post: { | ||
| operationId: 'createProjectInvitation', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [ | ||
| { | ||
| code: 'xgen-IPA-106-valid-operation-id', | ||
| message: | ||
| 'Invalid OperationID. The Operation ID must start with the verb “create” and should be followed by a noun or compound noun. The noun(s) in the Operation ID should be the collection identifiers from the resource identifier in singular form. ', | ||
| path: ['paths', '/api/atlas/v2/groups/{groupId}/access', 'post'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| { | ||
| code: 'xgen-IPA-106-valid-operation-id', | ||
| message: | ||
| 'Invalid OperationID. The Operation ID must start with the verb “create” and should be followed by a noun or compound noun. The noun(s) in the Operation ID should be the collection identifiers from the resource identifier in singular form. ', | ||
| path: ['paths', '/api/atlas/v2/groups/{groupId}/invites', 'post'], | ||
| severity: DiagnosticSeverity.Warning, | ||
|
There was a problem hiding this comment. Just asking to learn: There was a problem hiding this comment. Severity off still runs the rule but hides the errors, which is what i want here until the package and extension are supported (ie: closer to the time of correction). The rule isn't being tested because it's not active yet, but I have run the tests on error and warning severity and they pass. There was a problem hiding this comment. Perfect! Thanks ❤️ |
||
| }, | ||
| ], | ||
| }, */ | ||
| { | ||
| name: 'invalid methods with exceptions', | ||
| document: { | ||
| components: componentSchemas, | ||
| paths: { | ||
| '/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index ': { | ||
| post: { | ||
| operationId: 'createRollingIndex', | ||
| 'x-xgen-IPA-exception': { | ||
| 'xgen-IPA-106-valid-operation-id': '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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| import testRule from './__helpers__/testRule'; | ||
| import { DiagnosticSeverity } from '@stoplight/types'; | ||
|
|
||
| // TODO: add tests for xgen-custom-method extension - CLOUDP-306294 | ||
| // TOOD: enable tests for invalid methods (after rules are upgraded to warning) - CLOUDP-329722 | ||
|
|
||
| const componentSchemas = { | ||
| schemas: { | ||
| Schema: { | ||
| type: 'object', | ||
| }, | ||
| }, | ||
| operationId: 'string', | ||
| }; | ||
|
|
||
| testRule('xgen-IPA-107-valid-operation-id', [ | ||
| { | ||
| name: 'valid methods', | ||
| document: { | ||
| components: componentSchemas, | ||
| paths: { | ||
| 'groups/{groupId}/clusters/{clusterName}': { | ||
| put: { | ||
| operationId: 'updateGroupCluster', | ||
| }, | ||
| }, | ||
| '/groups/{groupId}/settings': { | ||
| put: { | ||
| operationId: 'updateGroupSettings', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [], | ||
| }, | ||
| // This test will be enable when the xgen-IPA-107-valid-operation-id is set to warning severity - CLOUDP-329722 | ||
| /* { | ||
| name: 'invalid methods', | ||
| document: { | ||
| components: componentSchemas, | ||
| paths: { | ||
| '/api/atlas/v2/groups/{groupId}/limits/{limitName}': { | ||
| patch: { | ||
| operationId: 'setProjectLimit', | ||
| }, | ||
| }, | ||
| '/api/atlas/v2/groups/{groupId}/settings': { | ||
| put: { | ||
| operationId: 'updateProjectSettings', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [ | ||
| { | ||
| code: 'xgen-IPA-107-valid-operation-id', | ||
| message: | ||
| 'Invalid OperationID. The Operation ID must start with the verb “update” and should be followed by a noun or compound noun. The noun(s) in the Operation ID should be the collection identifiers from the resource identifier in singular form. For singleton resources - the last noun may be in plural form.', | ||
| path: ['paths', '/api/atlas/v2/groups/{groupId}/limits/{limitName}', 'patch'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| { | ||
| code: 'xgen-IPA-107-valid-operation-id', | ||
| message: | ||
| 'Invalid OperationID. The Operation ID must start with the verb “update” and should be followed by a noun or compound noun. The noun(s) in the Operation ID should be the collection identifiers from the resource identifier in singular form. For singleton resources - the last noun may be in plural form.', | ||
| path: ['paths', '/api/atlas/v2/groups/{groupId}/settings', 'put'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| ], | ||
| }, */ | ||
| { | ||
| name: 'invalid methods with exceptions', | ||
| document: { | ||
| components: componentSchemas, | ||
| paths: { | ||
| '/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index ': { | ||
| post: { | ||
| operationId: 'updateRollingIndex', | ||
| 'x-xgen-IPA-exception': { | ||
| 'xgen-IPA-107-valid-operation-id': '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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| import testRule from './__helpers__/testRule'; | ||
|
|
||
| // TODO: add tests for xgen-custom-method extension - CLOUDP-306294 | ||
| // TOOD: enable tests for invalid methods (after rules are upgraded to warning) - CLOUDP-329722 | ||
|
|
||
| const componentSchemas = { | ||
| schemas: { | ||
| Schema: { | ||
| type: 'object', | ||
| }, | ||
| }, | ||
| operationId: 'string', | ||
| }; | ||
|
|
||
| testRule('xgen-IPA-108-valid-operation-id', [ | ||
| { | ||
| name: 'valid methods', | ||
| document: { | ||
| components: componentSchemas, | ||
| paths: { | ||
| '/groups/{groupId}/clusters/{clusterName}': { | ||
| delete: { | ||
| operationId: 'deleteGroupCluster', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [], | ||
| }, | ||
| // This test will be enable when the xgen-IPA-108-valid-operation-id is set to warning severity - CLOUDP-329722 | ||
| /* { | ||
| name: 'invalid methods', | ||
| document: { | ||
| components: componentSchemas, | ||
| paths: { | ||
| '/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}': { | ||
| delete: { | ||
| operationId: 'removeProjectApiKey', | ||
| }, | ||
| }, | ||
| '/api/atlas/v2/groups/{groupId}': { | ||
| delete: { | ||
| operationId: 'deleteProject', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| errors: [ | ||
| { | ||
| code: 'xgen-IPA-108-valid-operation-id', | ||
| message: | ||
| 'Invalid OperationID. The Operation ID must start with the verb “delete” and should be followed by a noun or compound noun. The noun(s) in the Operation ID should be the collection identifiers from the resource identifier in singular form. ', | ||
| path: ['paths', '/api/atlas/v2/groups/{groupId}/apiKeys/{apiUserId}', 'delete'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| { | ||
| code: 'xgen-IPA-108-valid-operation-id', | ||
| message: | ||
| 'Invalid OperationID. The Operation ID must start with the verb “delete” and should be followed by a noun or compound noun. The noun(s) in the Operation ID should be the collection identifiers from the resource identifier in singular form. ', | ||
| path: ['paths', '/api/atlas/v2/groups/{groupId}', 'delete'], | ||
| severity: DiagnosticSeverity.Warning, | ||
| }, | ||
| ], | ||
| }, */ | ||
| { | ||
| name: 'invalid methods with exceptions', | ||
| document: { | ||
| components: componentSchemas, | ||
| paths: { | ||
| '/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/index ': { | ||
| post: { | ||
| operationId: 'deleteRollingIndex', | ||
| 'x-xgen-IPA-exception': { | ||
| 'xgen-IPA-108-valid-operation-id': '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.
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.
Uh oh!
There was an error while loading. Please reload this page.