{"_id":"@carlsberg/openapi-aws-extensions","_rev":"10-f8da23b2bbcc203f18464b68ff086ddf","name":"@carlsberg/openapi-aws-extensions","dist-tags":{"latest":"0.0.2"},"versions":{"0.0.1":{"name":"@carlsberg/openapi-aws-extensions","version":"0.0.1","description":"A library that adds API Gateway extensions to OpenAPI specification files","main":"dist/index.js","scripts":{"build":"tsc","test":"echo \"No test specified\""},"keywords":["openapi","aws","aws-apigateway"],"author":{"name":"João Cerqueira","email":"joao@cerqueira.io","url":"https://cerqueira.io"},"license":"MIT","repository":{"type":"git","url":"git+ssh://git@github.com/CarlsbergGBS/openapi-aws-extensions.git"},"dependencies":{"@aws-cdk/aws-apigateway":"^1.93.0","openapi3-ts":"^2.0.1","yaml":"^1.10.2"},"devDependencies":{"@types/node":"^14.14.35","typescript":"^4.2.3"},"bugs":{"url":"https://github.com/CarlsbergGBS/openapi-aws-extensions/issues"},"homepage":"https://github.com/CarlsbergGBS/openapi-aws-extensions#readme","_id":"@carlsberg/openapi-aws-extensions@0.0.1","_nodeVersion":"12.21.0","_npmVersion":"6.14.11","dist":{"integrity":"sha512-HPS6hiHSpnJii8AHbrSzNe+PQ24g4ep+XCKYZmiNYIs6NuZRBASgKEnAYsRR2/hJ4eIvkgm+5Zc7AyCtzQ2rpA==","shasum":"9b1e2971796da2868480caaadc42d38bf5cb7354","tarball":"https://registry.npmjs.org/@carlsberg/openapi-aws-extensions/-/openapi-aws-extensions-0.0.1.tgz","fileCount":5,"unpackedSize":10828,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgVFuCCRA9TVsSAnZWagAApQ0P/RH9NAW1JeozN2tr/556\nPxq3JJNq0OT1S5gza/aGEIgi+gMZgp08Vgor/+pOf/UGKEWKiRaAlahNsGdc\nQKpLep/rpl9KVyKXGWlNqLbIHTXzmmhLR7uZdqLILrXWip0lEOBlU7h8r1qz\n8xm6uEt4dhFgUbV9tJX/vuHqrUh95mQf8n1RSZasn46kYhzu6ko4oDpX9bQ2\nC5UbSjJ35UGapGCbM4hVGtfCmiRsp8t4bC4fneVSE9MCOUmAzDPywldIE/KE\nRErrla65+HGwGr5Numeh8ThRY0nt5w+D97OVc35bNcySxpGZDSOvsA8ofOfs\nchcUset1n2uKgu20Kr1oNOXhFQNmOaV+Y4LoECE+lYt9dzA9Ale4cc9VnEV4\n47gH+IkusydDAZDhdOmPOB+cLhvgMAfP0clLIEHBlknTCBPFx5g7G0Li5gwp\nkbbS5t2Rv2hm8p+sR4gNyt2SlgQQnrDx2zWJ6zgE+bIcFpRy0MUQsaccS4DF\nDKv7KHTGCWLoNMRpRav5Ilk5JcqwoDhq5Z8nRJq6gLMCztYMpkIYsq4vNCIU\n8PSMESHHSmVVUhcX0YwFWdG4cRLMQgsdlSTza4jmFonXisjmtmT0FeDCgeaa\nFpZXVtcuO+7gOhrYBJ8hZQNN5PuBDi2hj7g4tys2oPUZX4hsfFy8h8FrDqtD\nxGzK\r\n=YwEN\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCl9HYYPmJwz0pWZybnTW+LuIXHrfXyccMougrds7K3MwIgQncEQihb0mxG6cY+7cnbTPdXscqQVZlsDDrAIDIflvA="}]},"_npmUser":{"name":"cerqueira","email":"joao@cerqueira.io"},"directories":{},"maintainers":[{"name":"cerqueira","email":"joao@cerqueira.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/openapi-aws-extensions_0.0.1_1616141185418_0.2273886371721221"},"_hasShrinkwrap":false},"0.0.2":{"name":"@carlsberg/openapi-aws-extensions","version":"0.0.2","description":"A library that adds API Gateway extensions to OpenAPI specification files","main":"dist/index.js","scripts":{"build":"tsc","test":"echo \"No test specified\""},"keywords":["openapi","aws","aws-apigateway"],"author":{"name":"João Cerqueira","email":"joao@cerqueira.io","url":"https://cerqueira.io"},"license":"MIT","repository":{"type":"git","url":"git+ssh://git@github.com/CarlsbergGBS/openapi-aws-extensions.git"},"dependencies":{"@aws-cdk/aws-apigateway":"^1.93.0","openapi3-ts":"^2.0.1","yaml":"^1.10.2"},"devDependencies":{"@types/node":"^14.14.35","typescript":"^4.2.3"},"bugs":{"url":"https://github.com/CarlsbergGBS/openapi-aws-extensions/issues"},"homepage":"https://github.com/CarlsbergGBS/openapi-aws-extensions#readme","_id":"@carlsberg/openapi-aws-extensions@0.0.2","_nodeVersion":"12.21.0","_npmVersion":"6.14.11","dist":{"integrity":"sha512-oxQehmDqYXne1ZvPsVFlmCRJ72nTpO2WUEHP8Gn6kUOSjpoWFFoVBBZC2NzDbom/L213Aq7k3AP1/6DAJpqQDA==","shasum":"0b594d902a91beea0ced8cd069f62b10857e47b6","tarball":"https://registry.npmjs.org/@carlsberg/openapi-aws-extensions/-/openapi-aws-extensions-0.0.2.tgz","fileCount":6,"unpackedSize":13931,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgVF+VCRA9TVsSAnZWagAAYwAP/0eVXJPoDcuTd7nhywQX\nrglx7XjFBwXXbli2J5ec+DzoCphQRcD+CxGG5d6yBAz5RizruFF/bdCScqnY\nFAmSR8E4y8BtWjBKtU9BURMkrEDVyqRXqK26CaIkyr55+ipc61BemMJmFg95\ny7/UmxUhAbMQz+/nXuaeLYyoBuTq2fqG/sFO9Vnvd6bGLKSjyP2RZJCCOG+L\ncoPhJUkOTgLMd9lR5IhGyG7L5vSQJDrQ2o5w9S2t5RqmfScCxp5q4bjw14f2\ntUOjzTINfNITgL4hc+xTkPgpbM5sgWbxwgd+NIC7IDj5Fch5sfQk2a8rwX8d\nW1XxfEo5VuBa4xwfNQiwFXRlCjt35y9cdykE68FVbBgS/9ttNS4Hsr2Hv7Gz\nP2gtg233MAgy/nDqpZW3abxAmkyGq7VipM9p/i4XXkl4uske11QqgLaId+Lu\nX4tRSKqrNndb4ttliAxiU0GK0YG2EYZgUyEfuGT1P3dyGBaN1HvPtE/A65Kc\nDzuHTFwvlUMv6PvkKXpl85lOf+YFEJMTjx/2hhdfL+WP71jsQGdvwrSt4CqM\nR0AcAWj5hqkwuySsmKV9xyQvh/vFfBW9uCasYWzdfXqbsKVFNjw0sKt4/R6T\ntEOfT4ugjvq7Ltdbgi7mhndmIwqqahD6mUY5GRrgP7R7+KIjg8W6Ts9D9mMS\n1N7M\r\n=EQKF\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFoxKHACh0/i0JZPVRSZQuYwZNujPodQ0q0MGur0QnOdAiB08io6O534w8AMjLnyqmamEqAS9h8VzvBqRmrtL5jptA=="}]},"_npmUser":{"name":"cerqueira","email":"joao@cerqueira.io"},"directories":{},"maintainers":[{"name":"cerqueira","email":"joao@cerqueira.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/openapi-aws-extensions_0.0.2_1616142229469_0.3998510216542235"},"_hasShrinkwrap":false}},"time":{"created":"2021-03-19T08:06:25.174Z","0.0.1":"2021-03-19T08:06:25.693Z","modified":"2022-07-04T15:04:29.234Z","0.0.2":"2021-03-19T08:23:49.610Z"},"maintainers":[{"email":"vicente@opa.so","name":"vicenteopaso"},{"email":"samuelsilvawb@gmail.com","name":"samuelsilvadev"},{"email":"joao@cerqueira.io","name":"cerqueira"},{"email":"jsmederos@gmail.com","name":"jsmvaldivia"},{"email":"ines.moital2@carlsberggroup.com","name":"imoital"}],"description":"A library that adds API Gateway extensions to OpenAPI specification files","homepage":"https://github.com/CarlsbergGBS/openapi-aws-extensions#readme","keywords":["openapi","aws","aws-apigateway"],"repository":{"type":"git","url":"git+ssh://git@github.com/CarlsbergGBS/openapi-aws-extensions.git"},"author":{"name":"João Cerqueira","email":"joao@cerqueira.io","url":"https://cerqueira.io"},"bugs":{"url":"https://github.com/CarlsbergGBS/openapi-aws-extensions/issues"},"license":"MIT","readme":"# OpenAPI AWS API Gateway Extensions\n\n> A library and CLI that add API Gateway extensions to OpenAPI specification files\n\n### Disclaimer\n\nThis project is _work in progress_ and isn't production ready, it doesn't support all [API Gateway extensions for OpenAPI](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html) and lacks customization features. Use at your discretion.\n\n## Installation\n\nTo install the CLI tool:\n\n```shell\n$ npm install --global @carlsberg/openapi-aws-extensions-cli\n$ openapi-aws-extensions-cli --version\n0.0.1\n```\n\nTo install the library to use on your project:\n\n```\n$ npm install --save @carlsberggbs/openapi-aws-extensions\n```\n\n## Usage\n\n```\n$ openapi-aws-extensions-cli --help\n\nUsage: openapi-aws-extensions-cli -w [num] -h [num]\n\nOptions:\n  --help                Show help                                      [boolean]\n  --version             Show version number                            [boolean]\n  --inputFile           The OpenAPI specification file to add extensions to\n                                                             [string] [required]\n  --outputFile          The file to output the resulting OpenAPI specification\n                                                                        [string]\n  --outputFormat        The output format (either JSON or YAML), if different\n                        from input                    [string] [default: \"yaml\"]\n  --lambdaFunctionName  The AWS Lambda Function name to use on the extension's\n                        URI                                  [string] [required]\n  --cors                Enable CORS                   [boolean] [default: false]\n```\n\n## Options\n\n| Name                 | Description                                                                                                             | Default                      |\n| -------------------- | ----------------------------------------------------------------------------------------------------------------------- | ---------------------------- |\n| `inputFile`          | The path to the OpenAPI specification file to which to add AWS extensions                                               | `null`                       |\n| `outputFile`         | The path to where to output the extended OpenAPI specification. If none is specified, the result is outputted to stdout | `null`                       |\n| `outputFormat`       | The format of the outputted OpenAPI specification                                                                       | `yaml` or `inputFile` format |\n| `lambdaFunctionName` | An AWS Lambda Function name to use in the `x-amazon-apigateway-integration` extension                                   | `null`                       |\n| `cors`               | Adds default CORS headers to any `OPTIONS` methods to enable CORS                                                       | `false`                      |\n\n## Reference\n\n- [API Gateway extensions for OpenAPI](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.html)\n","readmeFilename":"README.md"}