{"id":5803410,"name":"swimmwatch/openapi-diff-action","ecosystem":"actions","description":"A GitHub Action to identify differences between OpenAPI specifications. It uses OpenAPITools/openapi-diff.","homepage":"","licenses":"mit","normalized_licenses":["MIT"],"repository_url":"https://github.com/swimmwatch/openapi-diff-action","keywords_array":["github-actions","openapi","openapi-spec"],"namespace":"swimmwatch","versions_count":2,"first_release_published_at":"2022-05-06T10:01:33.000Z","latest_release_published_at":"2022-07-22T09:12:09.000Z","latest_release_number":"v1.0.1","last_synced_at":"2026-03-17T11:21:06.341Z","created_at":"2023-01-04T14:29:04.633Z","updated_at":"2026-03-17T11:21:06.341Z","registry_url":"https://github.com/swimmwatch/openapi-diff-action","install_command":null,"documentation_url":null,"metadata":{"name":"OpenAPI Diff Action","author":"Dmitry Vasiliev","description":"A GitHub Action to identify differences between OpenAPI specifications. It uses OpenAPITools/openapi-diff.","branding":{"icon":"check-square","color":"blue"},"inputs":{"old-spec":{"description":"Old specification filename","required":true},"new-spec":{"description":"New specification filename","required":true},"header":{"description":"Use given header for authorization","required":false,"default":""},"query":{"description":"Use query param for authorization","required":false,"default":""},"log":{"description":"Use given level for log (TRACE, DEBUG, INFO, WARN, ERROR, OFF)","required":false,"default":"ERROR"},"markdown":{"description":"Export diff as markdown in given file","required":false,"default":".tmp/markdown"},"json":{"description":"Export diff as JSON in given file","required":false,"default":".tmp/json"},"text":{"description":"Export diff as text in given file","required":false,"default":".tmp/text"},"html":{"description":"Export diff as HTML in given file","required":false,"default":".tmp/html"},"fail-on":{"description":"Fail if API changed but is backward compatible ('changed' value) or changes broke backward compatibility ('incompatible' value)","required":false,"default":""}},"outputs":{"state":{"description":"Output diff state: no_changes, incompatible, compatible","value":"${{steps.state.outputs.compare_state}}"}},"runs":{"using":"composite","steps":[{"name":"Run openapi-diff tool","run":"docker run -v \"$(pwd):/specs\" --rm openapitools/openapi-diff:2.0.1 \\\n  /specs/${{inputs.old-spec}} \\\n  /specs/${{inputs.new-spec}} \\\n  `if [[ ${{inputs.header}} != '' ]]; then --header ${{inputs.header}}; fi` \\\n  `if [[ ${{inputs.query}} != '' ]]; then --query ${{inputs.query}}; fi` \\\n  `if [[ ${{inputs.fail-on}} != '' ]]; then --fail-on-${{inputs.fail-on}}; fi` \\\n  --log ${{inputs.log}} \\\n  --markdown /specs/${{inputs.markdown}} \\\n  --json /specs/${{inputs.json}} \\\n  --text /specs/${{inputs.text}} \\\n  --html /specs/${{inputs.html}}\n","shell":"bash"},{"name":"Read output JSON file","id":"output_json_file","uses":"juliangruber/read-file-action@v1","with":{"path":"${{inputs.json}}"}},{"name":"Detect compare state","id":"state","run":"compatible_val=\"${{fromJson(steps.output_json_file.outputs.content).compatible}}\"\nincompatible_val=\"${{fromJson(steps.output_json_file.outputs.content).incompatible}}\"\nunchanged_val=\"${{fromJson(steps.output_json_file.outputs.content).unchanged}}\"\n\nif [[ $unchanged_val == 'true' ]]; then\n  echo \"::set-output name=compare_state::no_changes\"\nelif [[ $incompatible_val == 'true' ]]; then\n  echo \"::set-output name=compare_state::incompatible\"\nelif [[ $compatible_val == 'true' ]]; then\n  echo \"::set-output name=compare_state::compatible\"\nfi\n","shell":"bash"},{"name":"Check file existence","id":"check_files","uses":"andstor/file-existence-action@v1","with":{"files":".tmp"}},{"name":"Post: Change folder own group","if":"steps.check_files.outputs.files_exists == 'true'","run":"sudo chown -R $USER:$USER .tmp","shell":"bash"},{"name":"Post: Remove .tmp directory","if":"steps.check_files.outputs.files_exists == 'true'","run":"rm -fr .tmp","shell":"bash"}]},"default_branch":"master","path":null},"repo_metadata":{"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":"2022-10-25T13:52:49.000Z","size":21,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2023-07-13T08:27:02.945Z","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}},"created_at":"2022-05-06T08:37:53.000Z","updated_at":"2023-04-21T12:34:55.000Z","dependencies_parsed_at":"2023-01-11T17:23:04.278Z","dependency_job_id":null,"html_url":"https://github.com/swimmwatch/openapi-diff-action","commit_stats":null,"previous_names":[],"tags_count":2,"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","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","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":145451195,"owners_count":6247550,"icon_url":"https://github.com/github.png","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"},"owner_record":{"login":"swimmwatch","name":"Dmitry Vasiliev","uuid":"18121771","kind":"user","description":"Python Software Engineer.","email":"","website":"https://t.me/contact_vasiliev_dmitry","location":"Moscow","twitter":"swimmwatch","company":null,"icon_url":"https://avatars.githubusercontent.com/u/18121771?u=817b14f6751c4c11c51e53484b3beb65932f63d6\u0026v=4","repositories_count":10,"last_synced_at":"2023-03-03T23:24:41.692Z","metadata":{"has_sponsors_listing":false},"html_url":"https://github.com/swimmwatch","created_at":"2022-11-14T06:34:36.502Z","updated_at":"2023-03-03T23:24:41.702Z","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/swimmwatch","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/swimmwatch/repositories"},"tags":[{"name":"v1.0.1","sha":"cbab3cbcbd5c46f97419f5063dfc0d4900212784","kind":"commit","published_at":"2022-07-22T09:12:09.000Z","download_url":"https://codeload.github.com/swimmwatch/openapi-diff-action/tar.gz/v1.0.1","html_url":"https://github.com/swimmwatch/openapi-diff-action/releases/tag/v1.0.1","dependencies_parsed_at":"2023-05-31T14:20:50.066Z","dependency_job_id":null,"tag_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swimmwatch%2Fopenapi-diff-action/tags/v1.0.1","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swimmwatch%2Fopenapi-diff-action/tags/v1.0.1/manifests"},{"name":"v1.0.0","sha":"5a24f17c2ad5ca015127f48807df9890d3f02bcf","kind":"commit","published_at":"2022-05-06T10:01:33.000Z","download_url":"https://codeload.github.com/swimmwatch/openapi-diff-action/tar.gz/v1.0.0","html_url":"https://github.com/swimmwatch/openapi-diff-action/releases/tag/v1.0.0","dependencies_parsed_at":"2023-05-31T14:20:50.491Z","dependency_job_id":null,"tag_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swimmwatch%2Fopenapi-diff-action/tags/v1.0.0","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swimmwatch%2Fopenapi-diff-action/tags/v1.0.0/manifests"}]},"repo_metadata_updated_at":"2023-07-13T08:27:08.344Z","dependent_packages_count":0,"downloads":null,"downloads_period":null,"dependent_repos_count":3,"rankings":{"downloads":null,"dependent_repos_count":18.04468388527967,"dependent_packages_count":0.0,"stargazers_count":22.94406591665346,"forks_count":16.178101727143083,"docker_downloads_count":null,"average":14.291712882269053},"purl":"pkg:githubactions/swimmwatch/openapi-diff-action","advisories":[],"docker_usage_url":"https://docker.ecosyste.ms/usage/actions/swimmwatch/openapi-diff-action","docker_dependents_count":null,"docker_downloads_count":null,"usage_url":"https://repos.ecosyste.ms/usage/actions/swimmwatch/openapi-diff-action","dependent_repositories_url":"https://repos.ecosyste.ms/api/v1/usage/actions/swimmwatch/openapi-diff-action/dependencies","status":null,"funding_links":[],"critical":null,"issue_metadata":{"last_synced_at":"2023-08-09T09:17:28.432Z","issues_count":1,"pull_requests_count":6,"avg_time_to_close_issue":29291.0,"avg_time_to_close_pull_request":1303.6666666666667,"issues_closed_count":1,"pull_requests_closed_count":6,"pull_request_authors_count":2,"issue_authors_count":1,"avg_comments_per_issue":2.0,"avg_comments_per_pull_request":0.0,"merged_pull_requests_count":6,"bot_issues_count":0,"bot_pull_requests_count":1,"past_year_issues_count":0,"past_year_pull_requests_count":2,"past_year_avg_time_to_close_issue":null,"past_year_avg_time_to_close_pull_request":3741.5,"past_year_issues_closed_count":0,"past_year_pull_requests_closed_count":2,"past_year_pull_request_authors_count":2,"past_year_issue_authors_count":0,"past_year_avg_comments_per_issue":null,"past_year_avg_comments_per_pull_request":0.0,"past_year_bot_issues_count":0,"past_year_bot_pull_requests_count":1,"past_year_merged_pull_requests_count":2},"versions_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/swimmwatch%2Fopenapi-diff-action/versions","version_numbers_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/swimmwatch%2Fopenapi-diff-action/version_numbers","dependent_packages_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/swimmwatch%2Fopenapi-diff-action/dependent_packages","related_packages_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/swimmwatch%2Fopenapi-diff-action/related_packages","codemeta_url":"https://packages.ecosyste.ms/api/v1/registries/github%20actions/packages/swimmwatch%2Fopenapi-diff-action/codemeta","maintainers":[]}