{"id":31718681,"url":"https://github.com/speakeasy-api/branchgen-pr-test","last_synced_at":"2025-10-09T02:54:53.598Z","repository":{"id":309603849,"uuid":"1032770749","full_name":"speakeasy-api/branchgen-pr-test","owner":"speakeasy-api","description":null,"archived":false,"fork":false,"pushed_at":"2025-10-01T14:32:16.000Z","size":76,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-01T15:28:04.400Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/speakeasy-api.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-05T19:54:40.000Z","updated_at":"2025-10-01T14:32:20.000Z","dependencies_parsed_at":"2025-08-12T21:11:57.258Z","dependency_job_id":"2387fa46-6474-4baf-a3ab-4aa35b6b8fb8","html_url":"https://github.com/speakeasy-api/branchgen-pr-test","commit_stats":null,"previous_names":["speakeasy-api/branchgen-pr-test"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/speakeasy-api/branchgen-pr-test","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fbranchgen-pr-test","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fbranchgen-pr-test/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fbranchgen-pr-test/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fbranchgen-pr-test/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/speakeasy-api","download_url":"https://codeload.github.com/speakeasy-api/branchgen-pr-test/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fbranchgen-pr-test/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000731,"owners_count":26082906,"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","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":"2025-10-09T02:54:50.444Z","updated_at":"2025-10-09T02:54:53.589Z","avatar_url":"https://github.com/speakeasy-api.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# openapi\n\nDeveloper-friendly \u0026 type-safe Ruby SDK specifically catered to leverage *openapi* API.\n\n\u003cdiv align=\"left\"\u003e\n    \u003ca href=\"https://www.speakeasy.com/?utm_source=openapi\u0026utm_campaign=ruby\"\u003e\u003cimg src=\"https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge\u0026logoColor=FBE331\u0026logo=speakeasy\u0026labelColor=545454\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://opensource.org/licenses/MIT\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/License-MIT-blue.svg\" style=\"width: 100px; height: 28px;\" /\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n\n\u003cbr /\u003e\u003cbr /\u003e\n\u003e [!IMPORTANT]\n\u003e This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/ian/ian). Delete this section before \u003e publishing to a package manager.\n\n\u003c!-- Start Summary [summary] --\u003e\n## Summary\n\nSwagger Petstore: This is a sample server Petstore server.  You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).  For this sample, you can use the api key `special-key` to test the authorization filters.\n\nFor more information about the API: [Find out more about Swagger](http://swagger.io)\n\u003c!-- End Summary [summary] --\u003e\n\n\u003c!-- Start Table of Contents [toc] --\u003e\n## Table of Contents\n\u003c!-- $toc-max-depth=2 --\u003e\n* [openapi](#openapi)\n  * [SDK Installation](#sdk-installation)\n  * [SDK Example Usage](#sdk-example-usage)\n  * [Authentication](#authentication)\n  * [Available Resources and Operations](#available-resources-and-operations)\n  * [Error Handling](#error-handling)\n  * [Server Selection](#server-selection)\n* [Development](#development)\n  * [Maturity](#maturity)\n  * [Contributions](#contributions)\n\n\u003c!-- End Table of Contents [toc] --\u003e\n\n\u003c!-- Start SDK Installation [installation] --\u003e\n## SDK Installation\n\nThe SDK can be installed using [RubyGems](https://rubygems.org/):\n\n```bash\ngem install specific_install\ngem specific_install  \n```\n\u003c!-- End SDK Installation [installation] --\u003e\n\n\u003c!-- Start SDK Example Usage [usage] --\u003e\n## SDK Example Usage\n\n### Example\n\n```ruby\nrequire 'openapi'\n\nModels = ::OpenApiSDK::Models\ns = ::OpenApiSDK::Openapi.new(\n      petstore_auth: '\u003cYOUR_PETSTORE_AUTH_HERE\u003e',\n    )\n\nreq = Models::Components::PetInput.new(\n  name: 'doggie',\n  photo_urls: [\n    'https://example.com/photo.png',\n  ],\n)\n\nres = s.pet.add_pet(request: req)\n\nif res.status_code == 200\n  # handle response\nend\n\n```\n\u003c!-- End SDK Example Usage [usage] --\u003e\n\n\u003c!-- Start Authentication [security] --\u003e\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security scheme globally:\n\n| Name            | Type   | Scheme       |\n| --------------- | ------ | ------------ |\n| `petstore_auth` | oauth2 | OAuth2 token |\n\nTo authenticate with the API the `petstore_auth` parameter must be set when initializing the SDK client instance. For example:\n```ruby\nrequire 'openapi'\n\nModels = ::OpenApiSDK::Models\ns = ::OpenApiSDK::Openapi.new(\n      petstore_auth: '\u003cYOUR_PETSTORE_AUTH_HERE\u003e',\n    )\n\nreq = Models::Components::PetInput.new(\n  name: 'doggie',\n  photo_urls: [\n    'https://example.com/photo.png',\n  ],\n)\n\nres = s.pet.add_pet(request: req)\n\nif res.status_code == 200\n  # handle response\nend\n\n```\n\n### Per-Operation Security Schemes\n\nSome operations in this SDK require the security scheme to be specified at the request level. For example:\n```ruby\nrequire 'openapi'\n\nModels = ::OpenApiSDK::Models\ns = ::OpenApiSDK::Openapi.new\n\nres = s.pet.get_pet_by_id(security: Models::Operations::GetPetByIdSecurity.new(\n    api_key: '\u003cYOUR_API_KEY_HERE\u003e',\n  ), pet_id: 311_674)\n\nunless res.body.nil?\n  # handle response\nend\n\n```\n\u003c!-- End Authentication [security] --\u003e\n\n\u003c!-- Start Available Resources and Operations [operations] --\u003e\n## Available Resources and Operations\n\n\u003cdetails open\u003e\n\u003csummary\u003eAvailable methods\u003c/summary\u003e\n\n\n### [pet](docs/sdks/pet/README.md)\n\n* [add_pet](docs/sdks/pet/README.md#add_pet) - Add a new pet to the store\n* [add_pet_raw](docs/sdks/pet/README.md#add_pet_raw) - Add a new pet to the store\n* [update_pet](docs/sdks/pet/README.md#update_pet) - Update an existing pet\n* [update_pet_raw](docs/sdks/pet/README.md#update_pet_raw) - Update an existing pet\n* [find_pets_by_status](docs/sdks/pet/README.md#find_pets_by_status) - Finds Pets by status\n* [~~find_pets_by_tags~~](docs/sdks/pet/README.md#find_pets_by_tags) - Finds Pets by tags :warning: **Deprecated**\n* [get_pet_by_id](docs/sdks/pet/README.md#get_pet_by_id) - Find pet by ID\n* [update_pet_with_form](docs/sdks/pet/README.md#update_pet_with_form) - Updates a pet in the store with form data\n* [delete_pet](docs/sdks/pet/README.md#delete_pet) - Deletes a pet\n* [upload_file](docs/sdks/pet/README.md#upload_file) - Uploads an image\n\n### [store](docs/sdks/store/README.md)\n\n* [get_inventory](docs/sdks/store/README.md#get_inventory) - Returns pet inventories by status\n* [place_order](docs/sdks/store/README.md#place_order) - Place an order for a pet\n* [get_order_by_id](docs/sdks/store/README.md#get_order_by_id) - Find purchase order by ID\n* [delete_order](docs/sdks/store/README.md#delete_order) - Delete purchase order by ID\n\n### [user](docs/sdks/user/README.md)\n\n* [create_user](docs/sdks/user/README.md#create_user) - Create user\n* [create_users_with_array_input](docs/sdks/user/README.md#create_users_with_array_input) - Creates list of users with given input array\n* [create_users_with_list_input](docs/sdks/user/README.md#create_users_with_list_input) - Creates list of users with given input array\n* [login_user](docs/sdks/user/README.md#login_user) - Logs user into the system\n* [logout_user](docs/sdks/user/README.md#logout_user) - Logs out current logged in user session\n* [get_user_by_name](docs/sdks/user/README.md#get_user_by_name) - Get user by user name\n* [update_user](docs/sdks/user/README.md#update_user) - Updated user\n* [delete_user](docs/sdks/user/README.md#delete_user) - Delete user\n\n\u003c/details\u003e\n\u003c!-- End Available Resources and Operations [operations] --\u003e\n\n\u003c!-- Start Error Handling [errors] --\u003e\n## Error Handling\n\nHandling errors in this SDK should largely match your expectations. All operations return a response object or raise an error.\n\nBy default an API error will raise a `Errors::APIError`, which has the following properties:\n\n| Property       | Type                                    | Description           |\n|----------------|-----------------------------------------|-----------------------|\n| `message`     | *string*                                 | The error message     |\n| `status_code`  | *int*                                   | The HTTP status code  |\n| `raw_response` | *Faraday::Response*                     | The raw HTTP response |\n| `body`        | *string*                                 | The response content  |\n\nWhen custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `add_pet` method throws the following exceptions:\n\n| Error Type       | Status Code | Content Type |\n| ---------------- | ----------- | ------------ |\n| Errors::APIError | 4XX, 5XX    | \\*/\\*        |\n\n### Example\n\n```ruby\nrequire 'openapi'\n\nModels = ::OpenApiSDK::Models\ns = ::OpenApiSDK::Openapi.new(\n      petstore_auth: '\u003cYOUR_PETSTORE_AUTH_HERE\u003e',\n    )\n\nbegin\n    req = Models::Components::PetInput.new(\n      name: 'doggie',\n      photo_urls: [\n        'https://example.com/photo.png',\n      ],\n    )\n\n    res = s.pet.add_pet(request: req)\n\n    if res.status_code == 200\n      # handle response\n    end\nrescue Errors::APIError =\u003e e\n  # handle default exception\n  raise e\nend\n\n```\n\u003c!-- End Error Handling [errors] --\u003e\n\n\u003c!-- Start Server Selection [server] --\u003e\n## Server Selection\n\n### Override Server URL Per-Client\n\nThe default server can be overridden globally by passing a URL to the `server_url (String)` optional parameter when initializing the SDK client instance. For example:\n```ruby\nrequire 'openapi'\n\nModels = ::OpenApiSDK::Models\ns = ::OpenApiSDK::Openapi.new(\n      server_url: 'http://petstore.swagger.io/v2',\n      petstore_auth: '\u003cYOUR_PETSTORE_AUTH_HERE\u003e',\n    )\n\nreq = Models::Components::PetInput.new(\n  name: 'doggie',\n  photo_urls: [\n    'https://example.com/photo.png',\n  ],\n)\n\nres = s.pet.add_pet(request: req)\n\nif res.status_code == 200\n  # handle response\nend\n\n```\n\u003c!-- End Server Selection [server] --\u003e\n\n\u003c!-- Placeholder for Future Speakeasy SDK Sections --\u003e\n\n# Development\n\n## Maturity\n\nThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage\nto a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally\nlooking for the latest version.\n\n## Contributions\n\nWhile we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. \nWe look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. \n\n### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=openapi\u0026utm_campaign=ruby)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeakeasy-api%2Fbranchgen-pr-test","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspeakeasy-api%2Fbranchgen-pr-test","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeakeasy-api%2Fbranchgen-pr-test/lists"}