Merge pull request #19 from andylockran/task/remove-oneOf

AWS now confirm support of oneOf in OAS3
andylockran · Mar 7, 2023 · 8b6f19e · 8b6f19e
2 parents 7bac862 + 75b85f4
commit 8b6f19e
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -5,6 +5,8 @@ When working with AWS API Gateway, it uses a number of features that are a step
 Usefully, the features are documented here [AWS API Gateway Important Notes](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-known-issues.html), but
 it's very easy for API developers to forget, or miss them.
 
+This linter is designed to support only the OpenAPI v3 specificiation on AWS API Gateway. AWS' documentation is not particularly clear on the differences between the two implementations, but as historical documentation gets updated this library will hopefully become more accurate and relevant to v3. If you're using V2, please note that this linter is likely to provide you false-positive, and false-negative results.
+
 ## Spectral
 
 [Spectral](https://stoplight.io/open-source/spectral/) is an Open Source API Linter.
@@ -22,7 +24,7 @@ If you've got npx installed, then you can run this ruleset with a single command
 To use this ruleset, simply extend your .spectral.yml ruleset by adding a reference to this ruleset, eg:
 
 ```
-extends: 
+extends:
   - spectral:oas
   - spectral-aws-apigateway-ruleset
 ```
@@ -37,10 +39,10 @@ See: [Spectral Instructions for npm](https://meta.stoplight.io/docs/spectral/doc
 
 ## Contributing
 
-The severity of each of these rules has been tweaked to follow my own usage.  If you think the severity needs changing, or would prefer a more descriptive error message, please submit a PR.
+The severity of each of these rules has been tweaked to follow my own usage. If you think the severity needs changing, or would prefer a more descriptive error message, please submit a PR.
 
 For instructions on how to do so, refer to [Custom Rulesets](https://meta.stoplight.io/docs/spectral/docs/guides/4-custom-rulesets.md) on the Spectral site.
 
-## Treeware         
+## Treeware
 
-This package is [Treeware](https://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/andylockran/spectral-aws-apigateway-ruleset) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
+This package is [Treeware](https://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/andylockran/spectral-aws-apigateway-ruleset) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.
diff --git a/aws_important_notes.yml b/aws_important_notes.yml
@@ -119,13 +119,6 @@ rules:
         - ipv6
         - uri
 
-  aws-oneOf:
-    description: 'OneOf is not supported by API Gateway'
-    severity: error
-    given: $..oneOf
-    then:
-      function: undefined
-
   aws-readOnly:
     description: 'readOnly is not supported by API Gateway'
     severity: warn

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "spectral-aws-apigateway-ruleset",
-  "version": "1.7.9",
+  "version": "1.7.10",
   "description": "A spectral ruleset to enforce the AWS API Gateway Important Notes",
   "main": "aws_important_notes.yml",
   "scripts": {