{"id":21692763,"url":"https://github.com/swaggerexpert/swagger-editor-validate","last_synced_at":"2025-08-20T10:32:09.785Z","repository":{"id":36976806,"uuid":"344901461","full_name":"swaggerexpert/swagger-editor-validate","owner":"swaggerexpert","description":"This GitHub Actions validates OpenAPI (OAS) definition file using Swagger Editor.","archived":false,"fork":false,"pushed_at":"2024-12-13T04:18:27.000Z","size":1930,"stargazers_count":48,"open_issues_count":8,"forks_count":12,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-12-13T05:19:08.475Z","etag":null,"topics":["editor","openapi","openapi2","openapi3","openapi31","swagger","validate","validations"],"latest_commit_sha":null,"homepage":"https://github.com/swaggerexpert/swagger-editor-validate","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/swaggerexpert.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":"GOVERNANCE.md","roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["char0n"],"patreon":"char0n","ko_fi":"char0n","liberapay":"char0n","issuehunt":"char0n"}},"created_at":"2021-03-05T18:37:29.000Z","updated_at":"2024-12-13T04:17:16.000Z","dependencies_parsed_at":"2023-10-16T17:00:16.648Z","dependency_job_id":"a9619c17-e667-4eb6-b838-5f017b71a507","html_url":"https://github.com/swaggerexpert/swagger-editor-validate","commit_stats":{"total_commits":492,"total_committers":2,"mean_commits":246.0,"dds":0.2052845528455285,"last_synced_commit":"cb422b1e1eeb101aef1d8c908811c398fd4e785d"},"previous_names":["swaggerexpert/swagger-editor-validate"],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swaggerexpert%2Fswagger-editor-validate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swaggerexpert%2Fswagger-editor-validate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swaggerexpert%2Fswagger-editor-validate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swaggerexpert%2Fswagger-editor-validate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/swaggerexpert","download_url":"https://codeload.github.com/swaggerexpert/swagger-editor-validate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230415318,"owners_count":18222158,"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":["editor","openapi","openapi2","openapi3","openapi31","swagger","validate","validations"],"created_at":"2024-11-25T18:17:17.337Z","updated_at":"2025-08-20T10:32:09.777Z","avatar_url":"https://github.com/swaggerexpert.png","language":"JavaScript","funding_links":["https://github.com/sponsors/char0n","https://patreon.com/char0n","https://ko-fi.com/char0n","https://liberapay.com/char0n","https://issuehunt.io/r/char0n"],"categories":[],"sub_categories":[],"readme":"# Swagger Editor Validate Github Action\n\nThis GitHub Action validates OpenAPI (OAS) definition file using [Swagger Editor](https://editor.swagger.io/).\n\n![test](https://user-images.githubusercontent.com/193286/110246148-b7aea580-7f66-11eb-9bd7-940ece1fc6b0.png)\n\nIt's handy for use-cases when OAS definition is maintained manually and is checked within the git.\nIf modifications are made to the OAS definition you want to make sure that there are no errors\nintroduced by modifications. Errors that would appear in Swagger Editor when the OAS definition\nwould be pasted inside it.\n\n![image](https://user-images.githubusercontent.com/193286/110244618-dcebe580-7f5f-11eb-8dd8-cb31f499761e.png)\n\nIf you're interested about technical design and evolution of this GitHub Action please\nread our [release article](https://vladimirgorej.com/blog/how-to-validate-openapi-definitions-in-swagger-editor-using-github-actions/).\n\n## Inputs\n\n### `swagger-editor-url`\n\n**Optional** Defines URL of [swagger-editor](https://www.npmjs.com/package/swagger-editor) where definition\nfile is going to be validated. Default `https://editor.swagger.io/`.\n\n### `definition-file`\n\n**Required** Defines path of [OAS](https://github.com/OAI/OpenAPI-Specification) definition file that exists\nas a physical file in your repository.\n\n### `ignore-error`\n\n**Optional** Defines path to JavaScript file containing predicate for determining if the error should be ignored or not.\n\n\n### `default-timeout`\n\n**Optional** Defines maximum time in milliseconds a script waits for certain actions or events to occur.\n\n\n## Example usage\n\nThere are two major use-cases of how to use this GitHub Action.\n\n### Public use-case\n\nIf you have access to the internet and don't mind that this action sends your OAS definition\nto https://editor.swagger.io/ for validation.\n\n```yaml\non: [push]\n\njobs:\n  test_swagger_editor_validator_remote:\n    runs-on: ubuntu-latest\n    name: Swagger Editor Validator Remote\n\n    steps:\n      - uses: actions/checkout@v4\n      - name: Validate OpenAPI definition\n        uses: swaggerexpert/swagger-editor-validate@v1\n        with:\n          definition-file: examples/openapi-2-0.yaml\n```\n\n### Private use-case\n\nIf you want to maintain complete privacy and your OAS definition may contain\nsensitive information use the following workflow. The workflow uses swagger-editor\ndocker image that runs as service of the workflow.\n\n```yaml\non: [push]\n\njobs:\n  test_swagger_editor_validator_service:\n    runs-on: ubuntu-latest\n    name: Swagger Editor Validator Service\n\n    # Service containers to run with `runner-job`\n    services:\n      # Label used to access the service container\n      swagger-editor:\n        # Docker Hub image\n        image: swaggerapi/swagger-editor\n        ports:\n          # Maps port 8080 on service container to the host 80\n          - 80:8080\n\n    steps:\n      - uses: actions/checkout@v4\n      - name: Validate OpenAPI definition\n        uses: swaggerexpert/swagger-editor-validate@v1\n        with:\n          swagger-editor-url: http://localhost/\n          definition-file: examples/openapi-2-0.yaml\n          default-timeout: 20000\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswaggerexpert%2Fswagger-editor-validate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswaggerexpert%2Fswagger-editor-validate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswaggerexpert%2Fswagger-editor-validate/lists"}