{"id":18051752,"url":"https://github.com/apimatic/apimatic-spectral-ruleset","last_synced_at":"2026-01-19T00:14:04.492Z","repository":{"id":174895146,"uuid":"640619445","full_name":"apimatic/apimatic-spectral-ruleset","owner":"apimatic","description":"Custom ruleset for improving the code generated for SDKs using APIMatic","archived":false,"fork":false,"pushed_at":"2023-06-13T04:51:31.000Z","size":11,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-05T07:13:44.322Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/apimatic.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":"2023-05-14T17:27:32.000Z","updated_at":"2023-06-13T04:53:09.000Z","dependencies_parsed_at":null,"dependency_job_id":"18fd153b-141d-440f-94ac-e2b0fb814776","html_url":"https://github.com/apimatic/apimatic-spectral-ruleset","commit_stats":null,"previous_names":["apimatic/apimatic-spectral-ruleset"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/apimatic/apimatic-spectral-ruleset","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apimatic%2Fapimatic-spectral-ruleset","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apimatic%2Fapimatic-spectral-ruleset/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apimatic%2Fapimatic-spectral-ruleset/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apimatic%2Fapimatic-spectral-ruleset/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apimatic","download_url":"https://codeload.github.com/apimatic/apimatic-spectral-ruleset/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apimatic%2Fapimatic-spectral-ruleset/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28554374,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T23:48:35.235Z","status":"ssl_error","status_checked_at":"2026-01-18T23:47:49.178Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":[],"created_at":"2024-10-30T22:55:40.770Z","updated_at":"2026-01-19T00:14:04.476Z","avatar_url":"https://github.com/apimatic.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# APIMatic Spectral Custom Ruleset\n\nGenerating code libraries for SDKs from API definitions require specific validation rules to ensure high quality code and accompanying documentation. \n\nWe've developed this custom Spectral ruleset for those generating code from their OpenAPI definition with APIMatic.\n\n## How to use the APIMatic rulset\n\nInstall Spectral following [these instructions](https://github.com/stoplightio/spectral#-installation).\n\nClone this repository and copy your API definition into the repository at the same level the .apimatic.yaml file.\n\nReplace petstore-good.yaml with your API definition file name and run the command.\n\n```\nspectral lint petstore-good.yaml --ruleset .apimatic.yaml\n```\n\n## Current Ruleset\n\nBelow are the rules defined in .apimatic.yaml\n\n* Property must include description\n* Property must include an example\n* Parameters must include description\n* Parameters must include examples\n* Request body must include description\n* Request body must include examples\n* Schemas must include description\n* Schemas must include examples\n* Response content must include examples\n\n## Roadmap\n\nAdd more rules to improve the quality of generated SDKs","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapimatic%2Fapimatic-spectral-ruleset","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapimatic%2Fapimatic-spectral-ruleset","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapimatic%2Fapimatic-spectral-ruleset/lists"}