{"id":21406707,"url":"https://github.com/ringcentral/vscode-openapi-linter","last_synced_at":"2025-07-14T00:32:45.022Z","repository":{"id":61234572,"uuid":"473277697","full_name":"ringcentral/vscode-openapi-linter","owner":"ringcentral","description":"OpenAPI Linter as a Visual Code extension","archived":false,"fork":false,"pushed_at":"2022-05-24T21:30:53.000Z","size":378,"stargazers_count":8,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-07T20:42:25.599Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/ringcentral.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}},"created_at":"2022-03-23T16:49:44.000Z","updated_at":"2024-10-30T00:49:45.000Z","dependencies_parsed_at":"2022-10-13T05:31:24.947Z","dependency_job_id":null,"html_url":"https://github.com/ringcentral/vscode-openapi-linter","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/ringcentral/vscode-openapi-linter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fvscode-openapi-linter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fvscode-openapi-linter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fvscode-openapi-linter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fvscode-openapi-linter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ringcentral","download_url":"https://codeload.github.com/ringcentral/vscode-openapi-linter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ringcentral%2Fvscode-openapi-linter/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265227898,"owners_count":23731059,"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":[],"created_at":"2024-11-22T16:41:59.737Z","updated_at":"2025-07-14T00:32:42.372Z","avatar_url":"https://github.com/ringcentral.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OpenAPI Linter for VS Code\n\n![](./images/screenshot-1.png)\n\nIt will lint YAML files which start with \"openapi:\". By default, it doesn't lint JSON files. You may change the `openApiLinter.validateFiles` settings to enable JSON support.\n\nIt is powered by [Spectral](https://stoplight.io/open-source/spectral/). You can specify a custom ruleset file by adding\n\n```\n\"openApiLinter.spectralRulesetsFile\": \"/path/to/.spectral.yml\"\n```\n\nto `settings.json` of VS Code.\n\nYou could also put a `.spectral.yml` file at the root folder of your workspace to override the global settings.\n\nIf there is neither local nor global `.spectral.yml` specified. A default `.spectral.yml` file with content `extends: [\"spectral:oas\", \"spectral:asyncapi\"]` will be used.\n\n\n## For maintainers and contributors\n\n### References\n\n- Get started: https://code.visualstudio.com/api/get-started/your-first-extension\n- Programming guide: https://code.visualstudio.com/api/language-extensions/language-server-extension-guide\n- Sample project: https://github.com/microsoft/vscode-extension-samples/tree/main/lsp-sample\n- Publish: https://code.visualstudio.com/api/working-with-extensions/publishing-extension\n- Demo project for Spectral: https://github.com/tylerlong/spectral-demo\n\t- there is an known issue\n\n\n### Enable trace logging\n\nAdd the following to VS Code `setting.json`:\n\n```\n\"openApiLinter.trace.server\": \"verbose\"\n```\n\nThen go open the \"OUTPUT\" window of VS Code and check channel \"OpenAPI Linter\":\n\n![](./images/screenshot-2.png)\n\n\n### Release\n\n```\nyarn vsce package\nyarn vsce publish\n```\n\nIf Azure personal token expired, login dev.azure.com, find the publisher name, find the the token and edit it to extend its lifetime. No need to create a new token.\n\n\n### Known issues\n\n- https://github.com/tylerlong/spectral-demo#known-issues\n- https://github.com/stoplightio/spectral/pull/2062#issuecomment-1108787968\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fvscode-openapi-linter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fringcentral%2Fvscode-openapi-linter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fringcentral%2Fvscode-openapi-linter/lists"}