{"id":15091143,"url":"https://github.com/klahap/coam","last_synced_at":"2026-02-06T14:18:28.694Z","repository":{"id":252402788,"uuid":"840337026","full_name":"klahap/coam","owner":"klahap","description":"Gradle plugin that ensures specified OpenAPI spec files are fully merged into a main spec via $ref","archived":false,"fork":false,"pushed_at":"2024-08-09T13:38:46.000Z","size":66,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-14T09:44:48.610Z","etag":null,"topics":["gradle-plugin","kotlin","openapi","validator"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","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/klahap.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":"2024-08-09T13:30:19.000Z","updated_at":"2025-06-16T11:22:50.000Z","dependencies_parsed_at":"2024-08-11T00:15:31.585Z","dependency_job_id":null,"html_url":"https://github.com/klahap/coam","commit_stats":null,"previous_names":["klahap/coam"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/klahap/coam","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klahap%2Fcoam","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klahap%2Fcoam/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klahap%2Fcoam/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klahap%2Fcoam/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/klahap","download_url":"https://codeload.github.com/klahap/coam/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/klahap%2Fcoam/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29164848,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-06T12:44:37.655Z","status":"ssl_error","status_checked_at":"2026-02-06T12:44:13.991Z","response_time":59,"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":["gradle-plugin","kotlin","openapi","validator"],"created_at":"2024-09-25T10:35:53.245Z","updated_at":"2026-02-06T14:18:28.669Z","avatar_url":"https://github.com/klahap.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenAPI Spec Merger Checker (coam)\n\n![GitHub License](https://img.shields.io/github/license/klahap/coam)\n![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/klahap/coam/check.yml)\n![Static Badge](https://img.shields.io/badge/coverage-100%25-success)\n\nOpenAPI Spec Merger Checker (coam) is a Gradle plugin that ensures all paths from one or more OpenAPI specification files (merged specs) are fully included in a main OpenAPI specification file. This helps maintain consistent and complete API documentation across your project.\n\n## Features\n\n- **Validation of OpenAPI Spec Merges:** Ensures that the paths from the specified OpenAPI files are correctly referenced in the main OpenAPI spec file using `$ref`.\n- **Simple Gradle Integration:** Easily integrates with your Gradle build process to automate the validation of OpenAPI specs.\n- **Customizable Configuration:** Supports multiple OpenAPI spec files to be merged into a single main spec file.\n\n## Installation\n\nTo use the OpenAPI Spec Merger Checker in your Gradle project, add the following to your `build.gradle.kts` file:\n\n```kotlin\nplugins {\n    id(\"io.github.klahap.coam\") version \"$VERSION\"\n}\n```\n\n## Usage\n\nTo configure the plugin, add the following configuration block to your `build.gradle.kts`:\n\n```kotlin\ncoam { \n    mainSpec = \"$projectDir/main.yaml\"  // Path to the main OpenAPI spec file\n    mergedSpecs { \n        add(\"$projectDir/other1.yaml\")  // Path to the first spec to be merged\n        add(\"$projectDir/other2.yaml\")  // Path to the second spec to be merged\n    }\n}\n```\n\n### Running the Check\n\nYou can run the OpenAPI spec merge check using the following Gradle tasks:\n\n- **`gradle checkOpenApiMerge`**: Specifically runs the OpenAPI merge check.\n- **`gradle check`**: Runs the OpenAPI merge check along with other checks configured in your project.\n\nIf all paths from the merged specs are correctly referenced in the main spec, the task will pass. Otherwise, it will fail, indicating which parts of the merged specs are missing from the main spec.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n## Contributing\n\nContributions are welcome! Please open an issue or submit a pull request.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklahap%2Fcoam","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fklahap%2Fcoam","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fklahap%2Fcoam/lists"}