{"id":23769944,"url":"https://github.com/limeflight/openapi-diff-action","last_synced_at":"2025-07-22T01:05:21.087Z","repository":{"id":41539204,"uuid":"256534717","full_name":"LimeFlight/openapi-diff-action","owner":"LimeFlight","description":"Automatically compare OpenAPI v3 specification files and post result to PR","archived":false,"fork":false,"pushed_at":"2024-06-21T13:06:21.000Z","size":62,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-07-21T14:28:51.166Z","etag":null,"topics":["actions","diff","openapi","pull-request"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","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/LimeFlight.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}},"created_at":"2020-04-17T15:04:05.000Z","updated_at":"2025-04-22T08:00:44.000Z","dependencies_parsed_at":"2024-11-12T23:00:19.952Z","dependency_job_id":null,"html_url":"https://github.com/LimeFlight/openapi-diff-action","commit_stats":{"total_commits":82,"total_committers":4,"mean_commits":20.5,"dds":"0.47560975609756095","last_synced_commit":"7857dbc6fbb9ec018f434f5b3fdc418d67fb2883"},"previous_names":["yaos/openapi-diff-action"],"tags_count":38,"template":false,"template_full_name":null,"purl":"pkg:github/LimeFlight/openapi-diff-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LimeFlight%2Fopenapi-diff-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LimeFlight%2Fopenapi-diff-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LimeFlight%2Fopenapi-diff-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LimeFlight%2Fopenapi-diff-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LimeFlight","download_url":"https://codeload.github.com/LimeFlight/openapi-diff-action/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LimeFlight%2Fopenapi-diff-action/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266405405,"owners_count":23923536,"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-21T11:47:31.412Z","response_time":64,"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","diff","openapi","pull-request"],"created_at":"2025-01-01T02:34:25.674Z","updated_at":"2025-07-22T01:05:21.014Z","avatar_url":"https://github.com/LimeFlight.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenAPI Diff Action\n\nBased on [LimeFlight/openapi-diff](https://github.com/LimeFlight/openapi-diff).\n\nThis GitHub Action compares two OpenAPI (3.x) specs to determine if the newer (HEAD) spec introduces breaking or non-breaking changes.\n\nWhen running on `pull_request` events, a comment will be added (or updated if exists) to the PR with a backward compatibility report and human-readable diff, giving PR authors and reviewers greater insight into the implications if merged.\n\nWhen running on `pull_request` events, a label will also be added to the PR with the _classification_ (`major`, `minor`, or `patch`) of the diff.\n\n## Usage\n\nThis action needs two OpenAPI spec files to compare in order to run. Your workflow may need to check out multiple branches of a repo or run additional steps to ensure that these files exist.\n\n### Inputs:\n\n- `head-spec` _(required)_: Local path to the new (HEAD) OpenAPI spec file. An error will be thrown if the file can't be found.\n- `base-spec` _(required)_: Local path to the old (BASE) OpenAPI spec file. An error will be thrown if the file can't be found.\n- `output-path` _(required)_: Local path to store the output file.\n- `github-token` _(required)_: Must be in form `${{ github.token }}` or `${{ secrets.GITHUB_TOKEN }}`; This token is used to add labels and comments to pull requests. It is built into Github Actions and does not need to be manually specified in your secrets store. [More Info](https://help.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#github-context)\n\n### Example:\n\nThis following example assumes that your repository contains a valid OpenAPI spec file called `openapi.json` in the repository root.\n\n```yaml\non: [pull_request]\n\nname: openapi-diff\n\njobs:\n  openapi-compatiable:\n    strategy:\n      max-parallel: 1\n      fail-fast: false\n    runs-on: ubuntu-latest\n    steps:\n      - name: Check out HEAD revision\n        uses: actions/checkout@v2\n        with:\n          ref: ${{ github.head_ref }}\n          path: head\n      - name: Check out BASE revision\n        uses: actions/checkout@v2\n        with:\n          ref: ${{ github.base_ref }}\n          path: base\n      - name: Run OpenAPI Diff (from HEAD revision)\n        uses: LimeFlight/openapi-diff-action@master\n        with:\n          head_spec: head/openapi.json\n          base_spec: base/openapi.json\n          output_path: ./output\n          github_token: ${{ github.token }}\n      - uses: actions/upload-artifact@v2\n        with:\n          name: diff-reports\n          path: ./output\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flimeflight%2Fopenapi-diff-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flimeflight%2Fopenapi-diff-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flimeflight%2Fopenapi-diff-action/lists"}