{"id":19944124,"url":"https://github.com/rebilly/api-definitions","last_synced_at":"2025-04-06T15:13:17.062Z","repository":{"id":37075899,"uuid":"252579214","full_name":"Rebilly/api-definitions","owner":"Rebilly","description":"Rebilly's public API definitions","archived":false,"fork":false,"pushed_at":"2025-03-27T12:51:48.000Z","size":6978,"stargazers_count":52,"open_issues_count":0,"forks_count":25,"subscribers_count":24,"default_branch":"main","last_synced_at":"2025-03-30T13:10:09.238Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","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/Rebilly.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}},"created_at":"2020-04-02T22:34:17.000Z","updated_at":"2025-03-27T12:51:52.000Z","dependencies_parsed_at":"2024-07-18T00:42:40.087Z","dependency_job_id":"367f1f69-fc17-45d7-90bd-95dd642eff04","html_url":"https://github.com/Rebilly/api-definitions","commit_stats":{"total_commits":1771,"total_committers":56,"mean_commits":31.625,"dds":0.8537549407114624,"last_synced_commit":"2cdbd02736f788592f7dbf2f78686d6996f969f9"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rebilly%2Fapi-definitions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rebilly%2Fapi-definitions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rebilly%2Fapi-definitions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rebilly%2Fapi-definitions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Rebilly","download_url":"https://codeload.github.com/Rebilly/api-definitions/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247500469,"owners_count":20948880,"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-13T00:19:10.898Z","updated_at":"2025-04-06T15:13:17.044Z","avatar_url":"https://github.com/Rebilly.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rebilly OpenAPI Definitions\n\n-   Our website (www.rebilly.com) is powered by [Redocly Revel](https://redocly.com/developer-portal/).\n-   Our API reference is powered by [Redocly Realm](https://redocly.com/product-updates/).\n\nTBD: Add Redocly validation status badge.\n\n## View API docs\n\nTo view the full Rebilly API reference documentation, go to [https://www.rebilly.com/catalog/all/](https://www.rebilly.com/catalog/all/).\n\nThe full Rebilly API reference documentation has over 500 operations. This is likely more than you may need to implement your use cases. If you would like to implement a particular use case, [contact Rebilly](https://www.rebilly.com/support/) for guidance and feedback on the best API operations to use for the task.\n\nTo integrate Rebilly, and learn about related resources and concepts,\nsee [Get started](https://www.rebilly.com/docs/dev-docs#get-started).\n\n## Contributing\n\n[Read our contribution guide](./CONTRIBUTING.md).\n\n## Environment setup\n\nIf you use VS Code, use the [Redocly VS Code extension](https://marketplace.visualstudio.com/items?itemName=Redocly.openapi-vs-code) to edit this repo and get inline lint feedback and previews.\n\n### Install\n\n1. Install [Node JS](https://nodejs.org/) (version 14 or more recent)\n2. Clone repo and run `npm ci` in the repo root\n\n### Usage\n\n#### Preview\n\nThis process describes how to start a development server docs preview for the Rebilly API docs.\nChanges made to the API specification while the development server is running are immediately displayed in the docs preview.\n\nRebilly uses [Redocly](https://redocly.com/) to generate, manage, and preview API docs.\n\n1. In a terminal, install the [Redocly CLI](https://github.com/Redocly/redocly-cli). \\\n   Use this command to install the package globally on your machine: `npm install @redocly/cli -g`\n1. [Sign in or create a Redocly account](https://app.redocly.com/signup). \\\n   If you are a Rebilly employee, sign in using SSO and your Rebilly email address.\n1. In Redocly, in the top right of the screen, press your name, then press **My profile**.\n1. In the **Personal API keys** section, press **Add API key**.\n1. Enter an API key name, then press **Save**.\n1. Copy the API key.\n1. In a terminal, execute the following command: `npx @redocly/cli login`.\n1. When prompted, paste your API key.\n1. Execute one of the following commands to start a development server docs preview:\n    - Core API docs: `npx @redocly/cli preview-docs core@latest`\n    - All API docs: `npx @redocly/cli preview-docs all@latest`\n1. In a web browser, open the preview server URL that is displayed in the terminal.\n\n#### Bundle\n\nRun `npm run build:latest` to bundle the definitions into a single file in the `catalog` folder.\n\n#### Validate\n\nRun `npx @redocly/cli lint` to validate the definitions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frebilly%2Fapi-definitions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frebilly%2Fapi-definitions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frebilly%2Fapi-definitions/lists"}