{"id":14986675,"url":"https://github.com/swimmwatch/openapi-diff-action","last_synced_at":"2025-04-11T23:01:41.727Z","repository":{"id":48177980,"uuid":"489279079","full_name":"swimmwatch/openapi-diff-action","owner":"swimmwatch","description":"A GitHub Action to identify differences between OpenAPI specifications. It uses OpenAPITools/openapi-diff.","archived":false,"fork":false,"pushed_at":"2024-01-29T02:27:18.000Z","size":24,"stargazers_count":3,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-03-14T20:22:06.184Z","etag":null,"topics":["github-actions","openapi","openapi-spec"],"latest_commit_sha":null,"homepage":"","language":null,"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/swimmwatch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2022-05-06T08:37:53.000Z","updated_at":"2023-04-21T12:34:55.000Z","dependencies_parsed_at":"2024-09-11T19:55:20.611Z","dependency_job_id":"14e5e2c9-edb2-49d1-b07d-fe38c10d7391","html_url":"https://github.com/swimmwatch/openapi-diff-action","commit_stats":{"total_commits":14,"total_committers":3,"mean_commits":4.666666666666667,"dds":0.1428571428571429,"last_synced_commit":"a9a966a5a59dead3cf82d3b88b7ef3543ac41f6a"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swimmwatch%2Fopenapi-diff-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swimmwatch%2Fopenapi-diff-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swimmwatch%2Fopenapi-diff-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swimmwatch%2Fopenapi-diff-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/swimmwatch","download_url":"https://codeload.github.com/swimmwatch/openapi-diff-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248492875,"owners_count":21113162,"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":["github-actions","openapi","openapi-spec"],"created_at":"2024-09-24T14:13:19.358Z","updated_at":"2025-04-11T23:01:41.694Z","avatar_url":"https://github.com/swimmwatch.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# openapi-diff-action\nA GitHub Action to identify differences between OpenAPI specifications. It uses [OpenAPITools/openapi-diff](https://github.com/OpenAPITools/openapi-diff).\n\n## Usage\n\nThe following example [workflow step](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow) will generate JSON and Markdown difference contents.\n\n```yml\n- name: \"Find difference between OpenAPI specifications\"\n  id: diff_state\n  uses: swimmwatch/openapi-diff-action@v1.0.1\n  with:\n    old-spec: \"old_spec.json\"\n    new-spec: \"new_spec.json\"\n    json: \"out.json\"\n    markdown: \"out.md\"\n- name: \"Print difference state\"\n  run: echo \"Current state: ${{steps.diff_state.outputs.state}}.\"\n```\n\n## Options\nThe following input variables options can/must be configured:\n\n|Input variable|Necessity|Description|Default|\n|----|----|----|----|\n|`old-spec`|Required|Path to old version OpenAPI specification.||\n|`new-spec`|Required|Path to new version OpenAPI specification.||\n|`header`|Optional|Use given header for authorization. Format: `\u003cproperty=value\u003e` |`''`|\n|`query`|Optional|Use given query for authorization. Format: `\u003cproperty=value\u003e` |`''`|\n|`log`|Optional|Use given level for log. Expected values: (`TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `OFF`) |`ERROR`|\n|`markdown`|Optional|Export diff as markdown in given file. |`'.tmp/markdown'`|\n|`json`|Optional|Export diff as JSON in given file. |`'.tmp/json'`|\n|`text`|Optional|Export diff as text in given file. |`'.tmp/text'`|\n|`html`|Optional|Export diff as HTML in given file. |`'.tmp/html'`|\n|`fail-on`|Optional|Fail if API changed but is backward compatible (`changed` value) or changes broke backward compatibility (`incompatible` value). |`''`|\n\n## Outputs\n- `state`: Output diff state: `no_changes`, `incompatible`, `compatible`.\n\n## License\nopenapi-diff-action is licensed under the [MIT License](LICENSE).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswimmwatch%2Fopenapi-diff-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswimmwatch%2Fopenapi-diff-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswimmwatch%2Fopenapi-diff-action/lists"}