{"id":29843328,"url":"https://github.com/stackql/stackql-provider-heroku","last_synced_at":"2026-02-10T19:04:20.948Z","repository":{"id":302144721,"uuid":"1011418926","full_name":"stackql/stackql-provider-heroku","owner":"stackql","description":"StackQL provider for Heroku","archived":false,"fork":false,"pushed_at":"2025-07-10T02:44:21.000Z","size":124,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-29T16:38:23.184Z","etag":null,"topics":["heroku","stackql","stackql-provider"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","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":"LICENSE","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,"zenodo":null}},"created_at":"2025-06-30T19:36:59.000Z","updated_at":"2025-07-10T02:44:26.000Z","dependencies_parsed_at":"2025-06-30T20:38:13.926Z","dependency_job_id":"efe20b0c-73a1-49de-915d-462eac64e33d","html_url":"https://github.com/stackql/stackql-provider-heroku","commit_stats":null,"previous_names":["stackql/stackql-provider-heroku"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/stackql/stackql-provider-heroku","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fstackql-provider-heroku","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fstackql-provider-heroku/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fstackql-provider-heroku/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fstackql-provider-heroku/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stackql","download_url":"https://codeload.github.com/stackql/stackql-provider-heroku/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackql%2Fstackql-provider-heroku/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29313093,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-10T17:48:59.043Z","status":"ssl_error","status_checked_at":"2026-02-10T17:45:37.240Z","response_time":65,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["heroku","stackql","stackql-provider"],"created_at":"2025-07-29T15:43:00.178Z","updated_at":"2026-02-10T19:04:20.931Z","avatar_url":"https://github.com/stackql.png","language":"Python","readme":"# stackql-provider-heroku\r\n\r\nThis repository contains the tooling, code, and CI to build and test a [StackQL](https://github.com/stackql/stackql) provider for the [Heroku Platform API](https://devcenter.heroku.com/articles/platform-api-reference). It leverages the official [Heroku API JSON Schema](https://devcenter.heroku.com/articles/json-schema-for-platform-api) to generate OpenAPI-compatible service specifications with custom `x-stackQL-*` extensions.\r\n\r\n---\r\n\r\n## 📦 What this Repo Does\r\n\r\n- Fetches the [Heroku Platform API schema](https://github.com/heroku/platform-api-schema)\r\n- Converts the schema into modular OpenAPI 3.0 service specs\r\n- Annotates each OpenAPI operation and schema with `x-stackQL-*` extensions\r\n- Outputs a full StackQL provider manifest and service spec tree\r\n- Includes CI tests to validate generated specs and example queries\r\n\r\n---\r\n\r\n## 📥 Getting the Heroku Platform API Schema\r\n\r\nThe Heroku Platform API is described using a machine-readable JSON schema hosted in GitHub.\r\n\r\n### Step 1: Clone the Schema Repo\r\n\r\n```bash\r\ngit clone https://github.com/heroku/platform-api-schema.git\r\ncd platform-api-schema\r\n````\r\n\r\nThis will provide access to the raw schema in:\r\n\r\n```\r\nschema-v3.json\r\n```\r\n\r\n### Step 2: Inspect the Schema\r\n\r\nYou can view `schema-v3.json` to see the top-level definitions. It's structured similarly to JSON Hyper-Schema with `links`, `href`, and `rel` describing endpoints and methods.\r\n\r\n---\r\n\r\n## 🔄 Convert Schema to StackQL-Compatible OpenAPI Specs\r\n\r\nTo convert this schema into StackQL-compatible service specs:\r\n\r\n1. Use or build a Python/Node.js script to:\r\n\r\n   * Parse each top-level Heroku resource (e.g., `app`, `addon`, `release`)\r\n   * Convert each `href` and `method` into an OpenAPI `path` + `operation`\r\n   * Extract request and response bodies into components\r\n   * Add `x-stackQL-resource`, `x-stackQL-method`, and `x-stackQL-verb` to each operation\r\n\r\n2. Group operations by **service** (e.g., `apps`, `addons`, `builds`) and output them to:\r\n\r\n   ```\r\n   provider/\r\n   └── heroku/\r\n       └── v0/\r\n           └── services/\r\n               ├── apps.yaml\r\n               ├── addons.yaml\r\n               └── builds.yaml\r\n   ```\r\n\r\n3. Generate a top-level provider manifest:\r\n\r\n   ```yaml\r\n   name: heroku\r\n   version: v0\r\n   services:\r\n     - name: apps\r\n       file: services/apps.yaml\r\n     - name: addons\r\n       file: services/addons.yaml\r\n     # ...\r\n   ```\r\n\r\n---\r\n\r\n## 🚧 Work in Progress\r\n\r\nThis repo is under active development. Planned work includes:\r\n\r\n* JSON Schema → OpenAPI transformer\r\n* StackQL extensions injector\r\n* GitHub Actions CI for schema validation\r\n* Unit tests for provider coverage\r\n* Documentation and query examples\r\n\r\n---\r\n\r\n## 📚 References\r\n\r\n* [Heroku Platform API Reference](https://devcenter.heroku.com/articles/platform-api-reference)\r\n* [Heroku JSON Schema](https://github.com/heroku/platform-api-schema)\r\n* [StackQL Provider Spec Guide](https://stackql.io/docs/provider_spec)\r\n* [StackQL GitHub Repo](https://github.com/stackql/stackql)\r\n\r\n---\r\n\r\n## 👷‍♂️ Contributing\r\n\r\nContributions are welcome! Feel free to open issues, PRs, or feature suggestions.\r\n\r\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackql%2Fstackql-provider-heroku","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstackql%2Fstackql-provider-heroku","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackql%2Fstackql-provider-heroku/lists"}