{"_id":"02strich-spectral-aws-apigateway-ruleset","_rev":"1-2cb0feaafaf1db98f4783a17604b222c","name":"02strich-spectral-aws-apigateway-ruleset","dist-tags":{"latest":"1.7.4-1"},"versions":{"1.7.4":{"name":"02strich-spectral-aws-apigateway-ruleset","version":"1.7.4","description":"A spectral ruleset to enforce the AWS API Gateway Important Notes","main":"aws_important_notes.yml","scripts":{"clean":"rm -rf functions/","build":"webpack","test":"jest","test-build":"cp src/draft4.mjs functions/draft4.js && jest"},"repository":{"type":"git","url":"git+https://github.com/02strich/spectral-aws-apigateway-ruleset.git"},"keywords":["spectral","openapi","aws","apigateway"],"author":{"name":"Andy Loughran"},"license":"Apache-2.0","dependencies":{"ajv":"^8.5.0","ajv-draft-04":"^1.0.0","ajv-formats":"^2.1.0"},"devDependencies":{"@babel/preset-env":"^7.14.1","apigw-model-validator":"^1.1.0","babel-jest":"^26.6.3","jest":"^26.6.3","jest-json-schema":"^5.0.0","js-yaml":"^3.14.1","webpack":"^5.37.0","webpack-cli":"^4.7.0"},"jest":{"verbose":true,"collectCoverage":true,"moduleFileExtensions":["js","json","mjs","jsx","ts","tsx","node"],"transform":{"^.+\\.js$":"babel-jest","^.+\\.mjs$":"babel-jest"},"testRegex":"((\\.|/*.)(spec))\\.js?$"},"gitHead":"11899fedc4f5d16adcc47df87c122110d9d932e5","bugs":{"url":"https://github.com/02strich/spectral-aws-apigateway-ruleset/issues"},"homepage":"https://github.com/02strich/spectral-aws-apigateway-ruleset#readme","_id":"02strich-spectral-aws-apigateway-ruleset@1.7.4","_nodeVersion":"19.6.0","_npmVersion":"9.4.0","dist":{"integrity":"sha512-ID7MwvClT0/JmjNJdlgx9yXu80wEGdb/isHkBypolHqwHUh60kZS7+sb9cc9+1OkAIU+LFiOInNeybG2RM2G7Q==","shasum":"0836a691b8e958e4c480bc46691a6790b69461dc","tarball":"https://registry.npmjs.org/02strich-spectral-aws-apigateway-ruleset/-/02strich-spectral-aws-apigateway-ruleset-1.7.4.tgz","fileCount":12,"unpackedSize":28848,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIG+wT+hX61JCr5SPRfhuC+sVcH8VC5DGztaMGY26PVJGAiBP1SIODX6yJ27BM2uktvviVag6eR2Rpagx2Kqf7QkCDA=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkB4QxACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmosww//bffIznuparFBOJA5IE4+sn4GOtMGQAseD6nPf4KijcLso+SN\r\ntIYsfErpoh/nz3wJ/LxNbi6oN0ua3n1jlshuSgOluxyO7iL2RtH0q0nJABMs\r\n9rjBmgz33fo4Wy4C1ghig9SNael1TPveNdHvYXYsWQae5fsVTU2XSgTWoVJi\r\nRgyyRPIyuhVRRA6qnNp3hiL5v4bUZXhmdBOADbfygg/IWoX2eNRACBlZwY68\r\n0l2UPmEQV7D3TmBGUACl6ObQV8Xqdy9tAZEVlNT7QtQDT/U95HVhSlUJUQ60\r\nBJSNMNGpoR6gVNoKt59JJD7kjKIufhALF73f3esKmed3U5onZMSB52Ox7ir4\r\n9tzTX0IvvFvLo+5sUhd7m2Cx6+kletcrdfI25X+Y84lkbdaoMUwjXmQuaEJp\r\nCuopdOjkwGWVliAACEmcxUrSl4vkGFtIeInhVzTTuZVkZSX+qQim98kyMnFZ\r\nFTSjuVu94wPBZeMLt+FkmeaP/gmxjnoLY5PGAh54eRBguP4smQ6a1z51OFA3\r\nTviy0vVSjvqEVvWUsASHO5D3skYlOMDelU/pBA4E+Yi9JPdCALvKMHO6BtE/\r\nL25arMGEB6bn4wiAqW7QJT5zGg9z4hXCGGOdnlBU9VujcWA0lt/zLj2/Q45X\r\nSznjDW4/n5UgX4PXP/sNLitRvtcZG9OEzFA=\r\n=pv7r\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"02strich","email":"stefan@02strich.de"},"directories":{},"maintainers":[{"name":"02strich","email":"stefan@02strich.de"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/02strich-spectral-aws-apigateway-ruleset_1.7.4_1678214192816_0.8611755326910766"},"_hasShrinkwrap":false},"1.7.4-1":{"name":"02strich-spectral-aws-apigateway-ruleset","version":"1.7.4-1","description":"A spectral ruleset to enforce the AWS API Gateway Important Notes","main":"aws_important_notes.yml","scripts":{"clean":"rm -rf functions/","build":"webpack","test":"jest","test-build":"cp src/draft4.mjs functions/draft4.js && jest"},"repository":{"type":"git","url":"git+https://github.com/02strich/spectral-aws-apigateway-ruleset.git"},"keywords":["spectral","openapi","aws","apigateway"],"author":{"name":"Andy Loughran"},"license":"Apache-2.0","dependencies":{"ajv":"^8.5.0","ajv-draft-04":"^1.0.0","ajv-formats":"^2.1.0"},"devDependencies":{"@babel/preset-env":"^7.14.1","apigw-model-validator":"^1.1.0","babel-jest":"^26.6.3","jest":"^26.6.3","jest-json-schema":"^5.0.0","js-yaml":"^3.14.1","webpack":"^5.37.0","webpack-cli":"^4.7.0"},"jest":{"verbose":true,"collectCoverage":true,"moduleFileExtensions":["js","json","mjs","jsx","ts","tsx","node"],"transform":{"^.+\\.js$":"babel-jest","^.+\\.mjs$":"babel-jest"},"testRegex":"((\\.|/*.)(spec))\\.js?$"},"gitHead":"8da9f5df66062616e03484139f5edd5b0380b059","bugs":{"url":"https://github.com/02strich/spectral-aws-apigateway-ruleset/issues"},"homepage":"https://github.com/02strich/spectral-aws-apigateway-ruleset#readme","_id":"02strich-spectral-aws-apigateway-ruleset@1.7.4-1","_nodeVersion":"19.6.0","_npmVersion":"9.4.0","dist":{"integrity":"sha512-d2rdkJllu71q9xqtRxXCCZ4CeCey7A5S4mSTsJjL1CBNC8GPrUloH40zKDFPYk6B/QwiPkqz+ApQugs3WbshMg==","shasum":"89d92e024416f9570558b42da05420a1e5f5ae0b","tarball":"https://registry.npmjs.org/02strich-spectral-aws-apigateway-ruleset/-/02strich-spectral-aws-apigateway-ruleset-1.7.4-1.tgz","fileCount":14,"unpackedSize":148842,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDiaY8a3tMpmmCCAKIYeH1RaQ+LCiiKCtY7r6+gDPmkmgIhALrQdcaGzRA6U4HEvZclm0uDDWS6hkzPSKJ3MzzWpvhq"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkB4aZACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqFCA//bTjn08oZ1aXsdgard24xbwJ/fOSuAn7Ap6OGsPN21IIGTYpp\r\naKgh4Lptsx7xqqiZXxBRjxw60LAMHTZU0dz9PZxCQ5NGGU5IIHZKFdDBvsqj\r\n5XW/9P6S/f5tOOTE9RnHSRafXPEFh8HiC0Wk5+7qeoL8Gb2BU1sPzjw6QfkW\r\nZPDbuIHya09UpoWoYu3DE9W8Rh6yulrLbDickuzifGH9m8lX+fBwOggjjOKg\r\n9K6uHK8QqHehd/6ltd8pW8IOssp5RNs1gZyTVj/XXvTIG9z5KFx8rLQzQpWY\r\ntJiwai6PJOr4qPTeoNL4YzXZZzgsBu8JIu1A6cgaguR0pXHvsFBEDSer9DVE\r\n70KAC3ocPJGinEPNt/XVaHhdIFoQa9AGGMA9MPHCJ+uouRPI1vtsgs3T7FfS\r\nGzpzXmowrWY0+0wPeybiFepFJOBi47fC4IjSPrmm0JhGS80c1pFJkWUpCR7V\r\nnDp26CPVgZdGmkwfXCyPJ9cZR/QS8fMZNGGfdfwverDudsJ7MQwPr2VD4kVw\r\nBieV8PXEwEkbYzaYYQo7aFEdWdCUZ2GlI7Q13j13j8WGYXRVauWV+oOOBHU2\r\nmVYQ1w4+1UMQISP5rZS0u6WOv4QUE37Gr5Hmtb/0UxeaGlAPFtNAOQkXouCd\r\nMweEBQTZzxJ9HAm4Rgo2MnSCEaVt7nVPNcw=\r\n=pYb0\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"02strich","email":"stefan@02strich.de"},"directories":{},"maintainers":[{"name":"02strich","email":"stefan@02strich.de"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/02strich-spectral-aws-apigateway-ruleset_1.7.4-1_1678214809623_0.08508382621802246"},"_hasShrinkwrap":false}},"time":{"created":"2023-03-07T18:36:32.816Z","1.7.4":"2023-03-07T18:36:33.067Z","modified":"2023-03-07T18:46:49.863Z","1.7.4-1":"2023-03-07T18:46:49.769Z"},"maintainers":[{"name":"02strich","email":"stefan@02strich.de"}],"description":"A spectral ruleset to enforce the AWS API Gateway Important Notes","homepage":"https://github.com/02strich/spectral-aws-apigateway-ruleset#readme","keywords":["spectral","openapi","aws","apigateway"],"repository":{"type":"git","url":"git+https://github.com/02strich/spectral-aws-apigateway-ruleset.git"},"author":{"name":"Andy Loughran"},"bugs":{"url":"https://github.com/02strich/spectral-aws-apigateway-ruleset/issues"},"license":"Apache-2.0","readme":"# Spectral AWS API Gateway Ruleset\n\nWhen working with AWS API Gateway, it uses a number of features that are a step away from the OpenAPI standard.\n\nUsefully, the features are documented here [AWS API Gateway Important Notes](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-known-issues.html), but\nit's very easy for API developers to forget, or miss them.\n\n## Spectral\n\n[Spectral](https://stoplight.io/open-source/spectral/) is an Open Source API Linter.\n\nSpectral is an open source JSON/YAML linter, which allows you to create style guides for your structured data; things like OpenAPI/AsyncAPI/RAML descriptions, Kubernetes config, GitHub Actions, you name it, Spectral can help you lint it. Go beyond making sure they are “Technically Correct”, make sure they are useful.\n\nTry it out:\n\nIf you've got npx installed, then you can run this ruleset with a single command, replacing $your_api.yml - with your API definition:\n\n`npx spectral lint -r https://raw.githubusercontent.com/andylockran/spectral-aws-apigateway-ruleset/main/aws_important_notes.yml $your_api.yaml`\n\n## Instructions\n\nTo use this ruleset, simply extend your .spectral.yml ruleset by adding a reference to this ruleset, eg:\n\n```\nextends: \n  - spectral:oas\n  - spectral-aws-apigateway-ruleset\n```\n\nThis pulls the definition directly from npm, do you don't have to even install it!\n\n## NPM package\n\n[spectral-aws-apigateway-ruleset](https://www.npmjs.com/package/spectral-aws-apigateway-ruleset)\n\nSee: [Spectral Instructions for npm](https://meta.stoplight.io/docs/spectral/docs/guides/7-sharing-rulesets.md#npm) for more details.\n\n## Contributing\n\nThe 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.\n\nFor 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.\n\n## Treeware         \n\nThis 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.","readmeFilename":"README.md"}