{"id":26470626,"url":"https://github.com/LimeFlight/openapi-diff","last_synced_at":"2025-03-19T19:22:35.859Z","repository":{"id":38360633,"uuid":"254633980","full_name":"LimeFlight/openapi-diff","owner":"LimeFlight","description":"Lib, CLI and GitHub Action to compare two OpenAPI Specification files v3","archived":false,"fork":false,"pushed_at":"2024-06-21T12:23:15.000Z","size":364,"stargazers_count":4,"open_issues_count":3,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-11T10:52:44.262Z","etag":null,"topics":["csharp","diff","dotnet","dotnetstandard","openapi-specification"],"latest_commit_sha":null,"homepage":"","language":"C#","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-10T12:53:02.000Z","updated_at":"2024-06-21T12:20:47.000Z","dependencies_parsed_at":"2024-11-16T03:13:53.471Z","dependency_job_id":"aa2347e5-7f2f-4938-b550-d386a555112c","html_url":"https://github.com/LimeFlight/openapi-diff","commit_stats":null,"previous_names":["yaos/openapi-diff"],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LimeFlight%2Fopenapi-diff","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LimeFlight%2Fopenapi-diff/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LimeFlight%2Fopenapi-diff/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LimeFlight%2Fopenapi-diff/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LimeFlight","download_url":"https://codeload.github.com/LimeFlight/openapi-diff/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244489566,"owners_count":20461018,"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":["csharp","diff","dotnet","dotnetstandard","openapi-specification"],"created_at":"2025-03-19T19:22:33.515Z","updated_at":"2025-03-19T19:22:35.851Z","avatar_url":"https://github.com/LimeFlight.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- PROJECT SHIELDS --\u003e\n\u003c!--\n*** I'm using markdown \"reference style\" links for readability.\n*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).\n*** See the bottom of this document for the declaration of the reference variables\n*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.\n*** https://www.markdownguide.org/basic-syntax/#reference-style-links\n--\u003e\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003ch1\u003eOpenAPI-Diff\u003c/h1\u003e\n\n\u003cp\u003e\n  Compares two OpenAPI documents! \n  \u003cbr /\u003e\n  \u003ca href=\"https://github.com/LimeFlight/openapi-diff/issues\"\u003eReport Bug\u003c/a\u003e\n  ·\n  \u003ca href=\"https://github.com/LimeFlight/openapi-diff/issues\"\u003eRequest Feature\u003c/a\u003e\n\u003c/p\u003e\n\u003cbr /\u003e\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails open=\"open\"\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#acknowledgements\"\u003eAcknowledgements\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\n\nIn order to identify any breaking API change of our B2B SaaS solution we created this project to outline the changes in the OpenAPI document.\nWe are using this together with GitHub Actions ([https://github.com/LimeFlight/openapi-diff-action](https://github.com/LimeFlight/openapi-diff-action)) to highlight changes in every Pull Request.\n\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\nTo get a local copy up and running follow these simple example steps.\n\n### Prerequisites\n\nComing soon.\n\n### Installation\n\nComing soon.\n\n\n\n\u003c!-- USAGE EXAMPLES --\u003e\n## Usage\n\nComing soon.\n\n### CLI\n\nInstall globally:\n\n```shell\ndotnet tool install --global LimeFlight.OpenAPI.Diff.CLI --version 3.0.9\n```\n\nInvoke:\n\n```\nopenapi-diff --help\n```\n```\nOptions:\n  -o|--old \u003cOLD_PATH\u003e       Path to old OpenAPI Specification file\n  -n|--new \u003cNEW_PATH\u003e       Path to new OpenAPI Specification file\n  -e|--exit \u003cEXIT_TYPE\u003e     Define exit behavior. Default: Fail only if API changes broke backward compatibility\n                            Allowed values are: PrintState, FailOnChanged.\n  -m|--markdown \u003cMARKDOWN\u003e  Export diff as markdown in given file\n  -c|--console              Export diff in console\n  -h|--html \u003cHTML\u003e          Export diff as html in given file\n  -?|--help                 Show help information.\n```\n\n**Example:**\n\n```shell\ndirectory=\"test/LimeFlight.OpenApi.Diff.Test/Resources\";\nopenapi-diff -o $directory/petstore_v2_1.yaml -n $directory/security_diff_1.yaml -m difflog.md\n```\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n\n\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\nLimeFlight - hello@limeflight.com\n\nProject Link: [https://github.com/LimeFlight/openapi-diff](https://github.com/LimeFlight/openapi-diff)\n\n\n\n\u003c!-- ACKNOWLEDGEMENTS --\u003e\n## Acknowledgements\n* [OpenAPITools OpenAPI-diff](https://github.com/OpenAPITools/openapi-diff)\n* [Img Shields](https://shields.io)\n* [Choose an Open Source License](https://choosealicense.com)\n\n\n\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n[contributors-shield]: https://img.shields.io/github/contributors/LimeFlight/openapi-diff?style=flat-square\n[contributors-url]: https://github.com/LimeFlight/openapi-diff/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/LimeFlight/openapi-diff?style=flat-square\n[forks-url]: https://github.com/LimeFlight/openapi-diff/network/members\n[stars-shield]: https://img.shields.io/github/stars/LimeFlight/openapi-diff?style=flat-square\n[stars-url]: https://github.com/LimeFlight/openapi-diff/stargazers\n[issues-shield]: https://img.shields.io/github/issues/LimeFlight/openapi-diff?style=flat-square\n[issues-url]: https://github.com/LimeFlight/openapi-diff/issues\n[license-shield]: https://img.shields.io/github/license/LimeFlight/openapi-diff?style=flat-square\n[license-url]: https://github.com/LimeFlight/openapi-diff/blob/master/LICENSE.txt\n[product-screenshot]: images/screenshot.png\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLimeFlight%2Fopenapi-diff","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FLimeFlight%2Fopenapi-diff","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLimeFlight%2Fopenapi-diff/lists"}