{"id":20364438,"url":"https://github.com/hey-api/upload-openapi-spec","last_synced_at":"2025-07-23T04:04:38.624Z","repository":{"id":233165404,"uuid":"786201915","full_name":"hey-api/upload-openapi-spec","owner":"hey-api","description":"🚀 A GitHub Action for uploading OpenAPI specifications to Hey API. Support: @mrlubos","archived":false,"fork":false,"pushed_at":"2025-03-03T15:06:28.000Z","size":2248,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-19T06:49:28.142Z","etag":null,"topics":["actions","angular","asp-net","axios","codegen","fetch","github","go","javascript","kotlin","nodejs","openapi","python","ruby","swagger","swift","typescript","xhr"],"latest_commit_sha":null,"homepage":"https://heyapi.dev/openapi-ts/integrations","language":"TypeScript","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/hey-api.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":"2024-04-13T18:15:45.000Z","updated_at":"2025-03-03T15:06:30.000Z","dependencies_parsed_at":"2024-04-14T08:52:55.474Z","dependency_job_id":"547816ac-db4e-4790-bb0c-2391c8ca2a7f","html_url":"https://github.com/hey-api/upload-openapi-spec","commit_stats":null,"previous_names":["hey-api/upload-openapi-spec"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/hey-api/upload-openapi-spec","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hey-api%2Fupload-openapi-spec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hey-api%2Fupload-openapi-spec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hey-api%2Fupload-openapi-spec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hey-api%2Fupload-openapi-spec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hey-api","download_url":"https://codeload.github.com/hey-api/upload-openapi-spec/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hey-api%2Fupload-openapi-spec/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266614325,"owners_count":23956348,"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","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"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":["actions","angular","asp-net","axios","codegen","fetch","github","go","javascript","kotlin","nodejs","openapi","python","ruby","swagger","swift","typescript","xhr"],"created_at":"2024-11-15T00:11:54.361Z","updated_at":"2025-07-23T04:04:38.590Z","avatar_url":"https://github.com/hey-api.png","language":"TypeScript","readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg alt=\"Hey API logo\" height=\"150\" src=\"https://heyapi.dev/images/logo-300w.png\" width=\"150\"\u003e\n  \u003ch1 align=\"center\"\u003e\u003cb\u003eUpload OpenAPI Specification\u003c/b\u003e\u003c/h1\u003e\n  \u003cp align=\"center\"\u003e🚀 A GitHub Action for uploading specifications to Hey API\u003c/p\u003e\n\u003c/div\u003e\n\n\u003e Before using this GitHub Action, you must create a free account with\n\u003e [Hey API](https://app.heyapi.dev/) and generate a project API key.\n\n## Usage\n\nCreate a new GitHub workflow or add an upload step to an existing workflow\ninside your API codebase.\n\n```yaml\nname: Upload OpenAPI Specification\n\non:\n  push:\n    branches:\n      - main\n  pull_request:\n\njobs:\n  upload-openapi-spec:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v4\n\n      - name: Upload OpenAPI spec\n        uses: hey-api/upload-openapi-spec@v1.3.0\n        with:\n          path-to-file: path/to/openapi.json\n          tags: optional,custom,tags\n        env:\n          API_KEY: ${{ secrets.HEY_API_TOKEN }}\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\nThe example above will upload your OpenAPI specification to Hey API on every\npull request and push to the `main` branch.\n\n## Inputs\n\nTo successfully upload an OpenAPI specification, you need to provide the\nfollowing inputs (see `with` in the example above)\n\n### `path-to-file`\n\nA relative path to your OpenAPI file within the repository. Note that you might\nneed an additional step in your GitHub workflow to generate this file (see\n[FastAPI example](https://fastapi.tiangolo.com/how-to/extending-openapi/#generate-the-openapi-schema)).\n\n### `tags` (optional)\n\nA comma-separated string value representing any custom tags you wish to add to\nyour OpenAPI specification.\n\n## Environment Variables\n\nIn addition to the required `path-to-file` input, you must provide the following\nenvironment variables.\n\n### `API_KEY`\n\nThis is the project API key you obtained from\n[Hey API](https://app.heyapi.dev/).\n\n\u003e Note: Personal API keys can't be used to upload specifications.\n\n### `GITHUB_TOKEN`\n\nThis variable will be available inside your workflow by default. It's used to\nfetch information about your repository, i.e. default branch.\n\n## Next Steps\n\nPlease follow the\n[integrations guide](https://heyapi.dev/openapi-ts/integrations) on our website\nfor the next steps.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhey-api%2Fupload-openapi-spec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhey-api%2Fupload-openapi-spec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhey-api%2Fupload-openapi-spec/lists"}