{"id":14986690,"url":"https://github.com/nexmo/oas_parser","last_synced_at":"2025-07-20T08:36:25.045Z","repository":{"id":29245158,"uuid":"114796887","full_name":"Nexmo/oas_parser","owner":"Nexmo","description":"An open source Open API Spec 3 Definition Parser","archived":false,"fork":false,"pushed_at":"2024-02-14T19:25:56.000Z","size":170,"stargazers_count":51,"open_issues_count":9,"forks_count":15,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-04-07T07:13:30.028Z","etag":null,"topics":["developer-destination","nexmo","oas3","openapi-specification","openapi3","ruby","vonage"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/Nexmo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2017-12-19T18:12:33.000Z","updated_at":"2023-07-06T13:35:44.000Z","dependencies_parsed_at":"2024-06-18T19:52:51.370Z","dependency_job_id":"ae528566-e803-4f62-9a92-2418a70d7b01","html_url":"https://github.com/Nexmo/oas_parser","commit_stats":{"total_commits":126,"total_committers":14,"mean_commits":9.0,"dds":0.5476190476190477,"last_synced_commit":"2d3f445a16daf42ff5c27566406de10794808893"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nexmo%2Foas_parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nexmo%2Foas_parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nexmo%2Foas_parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nexmo%2Foas_parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Nexmo","download_url":"https://codeload.github.com/Nexmo/oas_parser/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247608153,"owners_count":20965952,"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":["developer-destination","nexmo","oas3","openapi-specification","openapi3","ruby","vonage"],"created_at":"2024-09-24T14:13:21.681Z","updated_at":"2025-04-07T07:13:34.651Z","avatar_url":"https://github.com/Nexmo.png","language":"Ruby","readme":"# ⚠️ This repository is no longer maintained.\n\n---\n\n# Open API Definition Parser\n\n\u003cimg src=\"https://developer.nexmo.com/assets/images/Vonage_Nexmo.svg\" height=\"48px\" alt=\"Nexmo is now known as Vonage\" /\u003e\n\nA Ruby parser for Open API Spec 3.0+ definitions.\n\n### Install\n\nInstall the gem:\n\n```\n$ gem install oas_parser\n```\n\nOr add it to your Gemfile:\n\n```ruby\ngem 'oas_parser'\n```\n\n### Usage\n\nHere is a basic example of how you can traverse through an Open API Spec 3 Definition:\n\n```ruby\nrequire 'oas_parser'\n\ndefinition = OasParser::Definition.resolve('petstore.yml')\n# =\u003e #\u003cOasParser::Definition\u003e\n\n# Get a specific path\npath = definition.path_by_path('/pets')\n# =\u003e #\u003cOasParser::Path\u003e\n\n# Get all paths.\ndefinition.paths\n# =\u003e [#\u003cOasParser::Path\u003e, ...]\n\n# Get a specific endpoint by method\nendpoint = path.endpoint_by_method('get')\n# =\u003e #\u003cOasParser::Endpoint\u003e\n\n# Get all endpoints\npath.endpoints\n# =\u003e [#\u003cOasParser::Endpoint\u003e, ...]\n\n# Get endpoint description\nendpoint.description\n# =\u003e \"Returns all pets from the system that the user has access to\"\n```\n\nCheckout the tests and `lib` directory for more classes and methods.\n\n### Development\n\nRun tests:\n\n```\n$ rspec\n```\n\n### Publishing\n\nClone the repo and navigate to its directory:\n\n```\n$ cd oas-parser\n```\n\nBump the latest version in `oas_parser/lib/oas_parser/version.rb`:\n\n```\n//old\nmodule OasParser\n  VERSION = '1.0.0'.freeze\nend\n\n//new\nmodule OasParser\n  VERSION = '1.1.0'.freeze\nend\n```\n\nBuild the gem:\n\n```\n$ gem build oas_parser.gemspec\n```\n\n_This will create a `oas_parser-1.1.0.gem` file._\n\nPush the gem to rubygems.org:\n\n```\n$ gem push oas_parser-1.1.0.gem\n```\n\nVerify the change was made by checking for the [new version on rubygems.org](https://rubygems.org/gems/oas_parser)\n\n\n\n## Contributing\n\nContributions are welcome, please follow [GitHub Flow](https://guides.github.com/introduction/flow/index.html)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnexmo%2Foas_parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnexmo%2Foas_parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnexmo%2Foas_parser/lists"}