{"id":21262882,"url":"https://github.com/stackql/aws-cfn-schema-to-openapi","last_synced_at":"2025-07-31T17:40:20.039Z","repository":{"id":204212255,"uuid":"618798524","full_name":"stackql/aws-cfn-schema-to-openapi","owner":"stackql","description":null,"archived":false,"fork":false,"pushed_at":"2024-05-28T09:03:19.000Z","size":13296,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-29T00:14:22.012Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stackql.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-25T11:40:30.000Z","updated_at":"2024-05-30T10:54:27.397Z","dependencies_parsed_at":null,"dependency_job_id":"b404b89c-07fa-4ea8-a8a4-1f9eea84d9e5","html_url":"https://github.com/stackql/aws-cfn-schema-to-openapi","commit_stats":null,"previous_names":["stackql/aws-cfn-schema-to-openapi"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Faws-cfn-schema-to-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Faws-cfn-schema-to-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Faws-cfn-schema-to-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Faws-cfn-schema-to-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stackql","download_url":"https://codeload.github.com/stackql/aws-cfn-schema-to-openapi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243701316,"owners_count":20333616,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-21T04:59:38.348Z","updated_at":"2025-03-15T07:44:38.189Z","avatar_url":"https://github.com/stackql.png","language":"JavaScript","readme":"# aws-cfn-schema-to-openapi\nConvert AWS CloudFormation Resource Specification to OpenAPI 3.0.0\n\n## Generating OpenAPI3 Specs\n1. run `sh download-and-preprocess-defs.sh`\n2. run `python3 get_cc_supported_resources.py \u003e cc_supported_resources.js` (requires `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` env vars to be set)\n3. run `npm install`\n4. run `node index.js`\n\noutput openapi3 specs (`components/schemas`) are written to `src/aws/v00.00.00000/services`\n\n## Testing locally with `stackql`\n1. ensure the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables are set\n2. download the latest `stackql` binary, for example `curl -L https://bit.ly/stackql-zip -O \u0026\u0026 unzip stackql-zip` for Linux systems\n3. run the following:\n```\nPROVIDER_REGISTRY_ROOT_DIR=\"$(pwd)\"\nREG_STR='{\"url\": \"file://'${PROVIDER_REGISTRY_ROOT_DIR}'\", \"localDocRoot\": \"'${PROVIDER_REGISTRY_ROOT_DIR}'\", \"verifyConfig\": {\"nopVerify\": true}}'\n./stackql shell --registry=\"${REG_STR}\"\n```\n4. run `stackql` commands, for example \n```sql\nselect * from aws.s3.buckets WHERE region = 'us-east-1';\nselect bucket_name, region, bucket_encryption_server_side_encryption_configuration from aws.s3.bucket WHERE region = 'us-east-1' and data__Identifier = 'stackql-trial-bucket-01';\n```\n\n### Run Test Suite\n\nfrom the `stackql-provider-tests` directory:\n\n```bash\ncd /mnt/c/LocalGitRepos/stackql/core/stackql-provider-tests\n\n# aws\nbash test-provider.sh \\\naws \\\nfalse \\\n/mnt/c/LocalGitRepos/stackql/openapi-conversion/aws-cfn-schema-to-openapi \\\ntrue\n\ncd /mnt/c/LocalGitRepos/stackql/openapi-conversion/aws-cfn-schema-to-openapi\n```\n\n## Generate User Markdown Docs\nUse the following script to generate user docs with Docusaurus front matter for AWS view resources:\n\n```bash\nnode lib/utils/generate-docs.js\n```\n\noutput markdown docs are written to `aws-docs`\n\n### Troubleshooting AWS Cloud Control\n\nTo troubleshoot AWS Cloud Control API requests (mutation requests), use the following queries:\n\n```sql\nselect * from aws.cloud_control.resource_requests\nwhere data__ResourceRequestStatusFilter = '{\"OperationStatuses\": [\"FAILED\"], \"Operations\": [\"CREATE\"]}'\nand region = 'ap-southeast-2';\n--or\nselect * from aws.cloud_control.resource_requests\nwhere data__ResourceRequestStatusFilter = '{\"OperationStatuses\": [\"FAILED\"], \"Operations\": [\"DELETE\"]}'\nand region = 'us-east-1';\n--or\nselect * from aws.cloud_control.resource_requests\nwhere data__ResourceRequestStatusFilter = '{\"OperationStatuses\": [\"SUCCESS\"], \"Operations\": [\"UPDATE\"]}'\nand region = 'ap-southeast-2';\n```\n\n(replace `region` accordingly)\n\n```sql\nselect * from aws.cloud_control.resource_request\nwhere data__RequestToken = '54061545-e0a0-4ef0-b213-41fda81d8c24'\nand region = 'ap-southeast-2';\n```\n\n(replace `region` and `data__RequestToken` accordingly)\n\n## check for AWS CC updates\n\nSee [here](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/doc-history.html) for newly added or updated Cloud Control resources.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackql%2Faws-cfn-schema-to-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstackql%2Faws-cfn-schema-to-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackql%2Faws-cfn-schema-to-openapi/lists"}