{"id":15286038,"url":"https://github.com/elibracha/openapi-diff-ignore","last_synced_at":"2026-02-17T21:01:52.486Z","repository":{"id":39813400,"uuid":"238002799","full_name":"elibracha/openapi-diff-ignore","owner":"elibracha","description":"This repository describes an ignore specification, and can be used to integrate with OpenAPI-diff and customize your breaking changes. ","archived":false,"fork":false,"pushed_at":"2022-05-25T06:53:18.000Z","size":531,"stargazers_count":1,"open_issues_count":3,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-10-18T10:53:51.633Z","etag":null,"topics":["api-first","java","openapi","openapi-diff","openapi3"],"latest_commit_sha":null,"homepage":"","language":"Java","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/elibracha.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":"2020-02-03T15:53:55.000Z","updated_at":"2020-05-05T14:09:53.000Z","dependencies_parsed_at":"2022-08-28T02:51:09.886Z","dependency_job_id":null,"html_url":"https://github.com/elibracha/openapi-diff-ignore","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/elibracha/openapi-diff-ignore","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elibracha%2Fopenapi-diff-ignore","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elibracha%2Fopenapi-diff-ignore/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elibracha%2Fopenapi-diff-ignore/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elibracha%2Fopenapi-diff-ignore/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/elibracha","download_url":"https://codeload.github.com/elibracha/openapi-diff-ignore/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/elibracha%2Fopenapi-diff-ignore/sbom","scorecard":{"id":372604,"data":{"date":"2025-08-11","repo":{"name":"github.com/elibracha/openapi-diff-ignore","commit":"b138a9aef21696a1fa2b807b912548ef4049fdaa"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.6,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/18 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: samples/sample-api-first-approach/.mvn/wrapper/maven-wrapper.jar:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 14 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"69 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-668q-qrv7-99fm","Warn: Project is vulnerable to: GHSA-6v67-2wr5-gvf4","Warn: Project is vulnerable to: GHSA-pr98-23f8-jwxv","Warn: Project is vulnerable to: GHSA-vmq6-5m68-f53m","Warn: Project is vulnerable to: GHSA-h46c-h94j-95f3","Warn: Project is vulnerable to: GHSA-wf8f-6423-gfxg","Warn: Project is vulnerable to: GHSA-288c-cq4h-88gq","Warn: Project is vulnerable to: GHSA-3x8x-79m2-3w2w","Warn: Project is vulnerable to: GHSA-57j2-w4cx-62h2","Warn: Project is vulnerable to: GHSA-jjjh-jjxp-wpff","Warn: Project is vulnerable to: GHSA-rgv9-q543-rqg4","Warn: Project is vulnerable to: GHSA-78wr-2p64-hpwj","Warn: Project is vulnerable to: GHSA-gwrp-pvrq-jmwv","Warn: Project is vulnerable to: GHSA-j288-q9x7-2f5v","Warn: Project is vulnerable to: GHSA-6gf2-pvqw-37ph","Warn: Project is vulnerable to: GHSA-rfmp-97jj-h8m6","Warn: Project is vulnerable to: GHSA-3mc7-4q67-w48m","Warn: Project is vulnerable to: GHSA-98wm-3w3q-mw94","Warn: Project is vulnerable to: GHSA-9w3m-gqgf-c4p9","Warn: Project is vulnerable to: GHSA-c4r9-r8fh-9vj2","Warn: Project is vulnerable to: GHSA-hhhw-99gj-p3c3","Warn: Project is vulnerable to: GHSA-mjmj-j48q-9wg2","Warn: Project is vulnerable to: GHSA-rvwf-54qp-4r6v","Warn: Project is vulnerable to: GHSA-w37g-rhq8-7m4j","Warn: Project is vulnerable to: GHSA-3f7h-mf4q-vrm4","Warn: Project is vulnerable to: GHSA-v2xm-76pq-phcf","Warn: Project is vulnerable to: GHSA-27hp-xhwr-wr2m","Warn: Project is vulnerable to: GHSA-2rvv-w9r2-rg7m","Warn: Project is vulnerable to: GHSA-5j33-cvvr-w245","Warn: Project is vulnerable to: GHSA-7w75-32cg-r6g2","Warn: Project is vulnerable to: GHSA-83qj-6fr2-vhqg","Warn: Project is vulnerable to: GHSA-fccv-jmmp-qg76","Warn: Project is vulnerable to: GHSA-g8pj-r55q-5c2v","Warn: Project is vulnerable to: GHSA-h2fw-rfh5-95r3","Warn: Project is vulnerable to: GHSA-h3gc-qfqq-6h8f","Warn: Project is vulnerable to: GHSA-hfrx-6qgj-fp6c","Warn: Project is vulnerable to: GHSA-j39c-c8hj-x4j3","Warn: Project is vulnerable to: GHSA-jgwr-3qm3-26f3","Warn: Project is vulnerable to: GHSA-p22x-g9px-3945","Warn: Project is vulnerable to: GHSA-q3mw-pvr8-9ggc","Warn: Project is vulnerable to: GHSA-qppj-fm5r-hxr3","Warn: Project is vulnerable to: GHSA-r6j3-px5g-cq3x","Warn: Project is vulnerable to: GHSA-wc4r-xq3c-5cf3","Warn: Project is vulnerable to: GHSA-wm9w-rjj3-j356","Warn: Project is vulnerable to: GHSA-v682-8vv8-vpwr","Warn: Project is vulnerable to: GHSA-7v6m-28jr-rg84","Warn: Project is vulnerable to: GHSA-rmrm-75hp-phr2","Warn: Project is vulnerable to: GHSA-x83m-pf6f-pf9g","Warn: Project is vulnerable to: GHSA-cm59-pr5q-cw85","Warn: Project is vulnerable to: GHSA-rc42-6c7j-7h5r","Warn: Project is vulnerable to: GHSA-jjfh-589g-3hjx","Warn: Project is vulnerable to: GHSA-g5h3-w546-pj7f","Warn: Project is vulnerable to: GHSA-xf96-w227-r7c4","Warn: Project is vulnerable to: GHSA-36p3-wjmg-h94x","Warn: Project is vulnerable to: GHSA-hh26-6xwr-ggv7","Warn: Project is vulnerable to: GHSA-4gc7-5j7h-4qph","Warn: Project is vulnerable to: GHSA-4wp7-92pw-q264","Warn: Project is vulnerable to: GHSA-g5mm-vmx4-3rg7","Warn: Project is vulnerable to: GHSA-558x-2xjg-6232","Warn: Project is vulnerable to: GHSA-564r-hj7v-mcr5","Warn: Project is vulnerable to: GHSA-9cmq-m9j5-mvww","Warn: Project is vulnerable to: GHSA-wxqc-pxw9-g2p8","Warn: Project is vulnerable to: GHSA-2rmj-mq67-h97g","Warn: Project is vulnerable to: GHSA-2wrp-6fg6-hmc5","Warn: Project is vulnerable to: GHSA-4wrc-f8pq-fpqp","Warn: Project is vulnerable to: GHSA-ccgv-vj62-xf9h","Warn: Project is vulnerable to: GHSA-gfwj-fwqj-fp3v","Warn: Project is vulnerable to: GHSA-hgjh-9rj2-g67j","Warn: Project is vulnerable to: GHSA-g5vr-rgqm-vf78"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-18T13:21:18.132Z","repository_id":39813400,"created_at":"2025-08-18T13:21:18.132Z","updated_at":"2025-08-18T13:21:18.132Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29558100,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-17T20:52:40.164Z","status":"ssl_error","status_checked_at":"2026-02-17T20:48:10.325Z","response_time":100,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["api-first","java","openapi","openapi-diff","openapi3"],"created_at":"2024-09-30T15:10:15.726Z","updated_at":"2026-02-17T21:01:52.465Z","avatar_url":"https://github.com/elibracha.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"OpenAPI-diff-ignore\n============\n[![Build Status](https://travis-ci.com/elibracha/openapi-diff-ignore.svg?branch=master)](https://travis-ci.com/elibracha/openapi-diff-ignore)\n[![codecov](https://codecov.io/gh/elibracha/openapi-diff-ignore/branch/master/graph/badge.svg)](https://codecov.io/gh/elibracha/openapi-diff-ignore)\n[![Jion the Slack chat room](https://img.shields.io/badge/Slack-Join%20the%20chat%20room-orange)](https://join.slack.com/t/openapi-diff-ignore/shared_invite/enQtOTM4MzYxNDAxMTEwLTk0ZDlmYzcwYWVlNWRiNDA4YmI1MDIwYjZlMTk4Mjc5OTI3NjY0Zjg0ZTEyNjA0NzBkOWY3MmNhNjQ2NjgxYjY)\n\nParse a OpenAPI-diff ignore file specifications(1.x). \nCan be use to integrate with OpenAPI-diff and customize your breaking changes.\n\nIf you think you have found a bug, please file an issue in the [Github Issues](https://github.com/elibracha/openapi-diff-ignore/issues).\n\nIgnore Specification\n------------------------\n\n### Schema\nIn the following description, if a field is not explicitly REQUIRED or described with a MUST or SHALL, it can be considered OPTIONAL.\n\n##### Fixed Fields\n\nField Name | Type | Description\n---|:---:|---\n\u003ca name=\"extends\"\u003e\u003c/a\u003eextends | `string` | Can be used to inherit a pre defined ignore file functionality. Provides metadata about basic ignore file for your custom API ignore. (Like -\u003e \".default\")\n\u003ca name=\"version\"\u003e\u003c/a\u003eversion | `string` | **REQUIRED**. This string MUST be the [semantic version number](https://semver.org/spec/v2.0.0.html) of the [Ignore Specification version](#versions) that the OpenAPI ignore document uses. The `version` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI ignore document.\n\u003ca name=\"info\"\u003e\u003c/a\u003einfo | `string` | Provides metadata about general info for the API ignore. The metadata MAY be used by tooling as required.\n\u003ca name=\"project\"\u003e\u003c/a\u003eproject | `string` | Provides metadata about the Project using the ignore file. The metadata MAY be used by tooling as required.\n\u003ca name=\"paths\"\u003e\u003c/a\u003epaths | [Paths Object](#pathsObject) |  The available paths and operations for the API that needed to be ignored.\n\n#### \u003ca name=\"pathsObject\"\u003e\u003c/a\u003ePaths Object\n\nHolds the relative paths to the individual endpoints and their operations.\n\n##### Patterned Fields\n\nField Pattern | Type | Description\n---|:---:|---\n\u003ca name=\"pathsPath\"\u003e\u003c/a\u003e/{path} | [Path Item Object](#pathItemObject) | A relative path to an individual endpoint. The field name MUST begin with a slash. Wildcard is allowed. When matching URLs. In case of ambiguous matching, it's up to the tooling to decide the execution order.\n\n##### Path Wildcard Matching\n\nAssuming the following paths, the concrete definition, `/pets/mine`, will be matched if used:\n\n```\n  /pets/**        # will match and also match all pets endpoints\n  /**             # will match and also will match all endpoints\n```\nNOTICE! When using wildcards all endpoints matching the wildcard will apply the ignore specified.\n\n##### Paths Object Example\n\n```yaml\npaths:\n  /pet/**, /store/**:        # this path will match any 'pet' or 'store' endpoint \n    get:                      \n      response:\n        200:\n          new: true\n      parameters:\n        - username\n        - password\n\n    post:\n      request:\n        content:\n          application/json, application/octet-stream: $\n      response:\n        200:\n          new: true\n          content:\n            application/json:\n              schema:\n                properties:\n                  - petId\n                  - quantity\n                  - shipDate\n                  - complete\n      security:\n        petstore_auth:\n          - 'write:pets'\n          - 'read:pets'\n\n  /user/login:               # this path will match only '/user/login' endpoint. \n    post: $        \n```\n\n#### \u003ca name=\"pathItemObject\"\u003e\u003c/a\u003ePath Item Object\n\nDescribes the operations available on a single path.\nA Path Item MAY be empty, due to [ACL constraints](#securityFiltering).\nThe path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n##### Fixed Fields\n\nField Name | Type | Description\n---|:---:|---\n\u003ca name=\"pathItemGet\"\u003e\u003c/a\u003eget | [Operation Object](#operationObject) | A definition of a GET operation on this path.\n\u003ca name=\"pathItemPut\"\u003e\u003c/a\u003eput | [Operation Object](#operationObject) | A definition of a PUT operation on this path.\n\u003ca name=\"pathItemPost\"\u003e\u003c/a\u003epost | [Operation Object](#operationObject) | A definition of a POST operation on this path.\n\u003ca name=\"pathItemDelete\"\u003e\u003c/a\u003edelete | [Operation Object](#operationObject) | A definition of a DELETE operation on this path.\n\u003ca name=\"pathItemOptions\"\u003e\u003c/a\u003eoptions | [Operation Object](#operationObject) | A definition of a OPTIONS operation on this path.\n\u003ca name=\"pathItemHead\"\u003e\u003c/a\u003ehead | [Operation Object](#operationObject) | A definition of a HEAD operation on this path.\n\u003ca name=\"pathItemPatch\"\u003e\u003c/a\u003epatch | [Operation Object](#operationObject) | A definition of a PATCH operation on this path.\n\u003ca name=\"pathItemTrace\"\u003e\u003c/a\u003etrace | [Operation Object](#operationObject) | A definition of a TRACE operation on this path.\n\n##### Path Item Object Example\n\n\n```yaml\n post:\n      request:\n        content:\n          application/json, application/octet-stream: $\n      response:\n        200:\n          new: true\n          content:\n            application/json:\n              schema:\n                properties:\n                  - petId\n                  - quantity\n                  - shipDate\n                  - complete\n      security:\n        petstore_auth:\n          - 'write:pets'\n          - 'read:pets'\nput: $\ndelete: $\n```\n\n#### \u003ca name=\"operationObject\"\u003e\u003c/a\u003eOperation Object\n\nDescribes a single API ignore operation on a path.\n\n##### Fixed Fields\n\nField Name | Type | Description\n---|:---:|---\n\u003ca name=\"security\"\u003e\u003c/a\u003esecurity | [Security Object](#parameterObject) | A list of security requirements that are going to be ignored.\n\u003ca name=\"parameters\"\u003e\u003c/a\u003eparameters | [Parameter Object](#parameterObject)| A list of parameters that are going to be ignored.\n\u003ca name=\"request\"\u003e\u003c/a\u003erequest | [Request Object](#requestBodyObject) | The request body applicable for this operation. can specify ignore for content-type.\n\u003ca name=\"response\"\u003e\u003c/a\u003eresponse | [Response Object](#responsesObject) | The list of possible response statuses that are going to be ignored.\n\n##### Operation Object Example\n\n```yaml\nrequest:\n  content:\n    application/json, application/octet-stream: $\n\nparameters:\n  - username\n  - password\n\nresponse:\n  200:\n    new: true\n    content:\n      application/json:\n        schema:\n          properties:\n            - petId\n            - quantity\n            - shipDate\n            - complete\n\nsecurity:\n  petstore_auth:\n    - 'write:pets'\n    - 'read:pets'\n```\n#### \u003ca name=\"securityObject\"\u003e\u003c/a\u003eSecurity Object\n\nDescribes a security requirements that needed to be ignored.\n\n##### Fixed Fields\n\nField Name | Type | Description\n---|:---:|---\n\u003ca name=\"schmea\"\u003e\u003c/a\u003e{schema} | Map\u003cString, List\u003e | A map of security requirements that are going to be ignored.\n##### Security Object Example\n\n```yaml\nsecurity:\n  petstore_auth:\n    - 'write:pets'\n    - 'read:pets'\n  api_key:\n    - 'read:users'\n```\n\nDocumentation\n-------------\n\nMore information can be found on [Docs][openapi-diff-ignore-home].\n\n\nWhere can I get the latest release?\n-----------------------------------\nYou can download release source from our release page.\n\nContributing\n------------\n\nIf you are interested in the development of OpenAPI-diff-ignore, please consult the \ndocumentation first and afterwards you are welcome to join the developers \nmailing list to ask question or discuss new ideas / features / bugs etc.\n\nTake a look into the [contribution guidelines](CONTRIBUTING.md).\n\n\n\nQuick Build\n-------\nIf you want to bootstrap openapi-diff-ignore, you'll need:\n- Java 1.8+\n- Maven 3.x.x or later\n- Run Maven, specifying a location into which the completed Maven distro should be installed:\n```\n./mvnw clean package\n```\n\n[openapi-diff-ignore-home]: https://maven.apache.org/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felibracha%2Fopenapi-diff-ignore","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felibracha%2Fopenapi-diff-ignore","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felibracha%2Fopenapi-diff-ignore/lists"}