{"id":18447173,"url":"https://github.com/roadrunner-server/api","last_synced_at":"2026-02-28T01:54:41.200Z","repository":{"id":37612372,"uuid":"445097424","full_name":"roadrunner-server/api","owner":"roadrunner-server","description":"🔌 RoadRunner API, powered with protobuf. Contains plugins interfaces and proto api.","archived":false,"fork":false,"pushed_at":"2025-11-06T11:22:16.000Z","size":3230,"stargazers_count":14,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-11-06T13:14:11.441Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":false,"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/roadrunner-server.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"roadrunner-server"}},"created_at":"2022-01-06T08:33:46.000Z","updated_at":"2025-11-06T11:21:33.000Z","dependencies_parsed_at":"2023-10-12T21:17:52.076Z","dependency_job_id":"b6a75f77-0af9-4889-92c3-b9c16cfa10e0","html_url":"https://github.com/roadrunner-server/api","commit_stats":{"total_commits":268,"total_committers":3,"mean_commits":89.33333333333333,"dds":0.07835820895522383,"last_synced_commit":"21d8e3bb3df042eb63f3a9e942224f96e1dfc3ab"},"previous_names":[],"tags_count":74,"template":false,"template_full_name":null,"purl":"pkg:github/roadrunner-server/api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roadrunner-server%2Fapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roadrunner-server%2Fapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roadrunner-server%2Fapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roadrunner-server%2Fapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/roadrunner-server","download_url":"https://codeload.github.com/roadrunner-server/api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roadrunner-server%2Fapi/sbom","scorecard":{"id":779560,"data":{"date":"2025-08-11","repo":{"name":"github.com/roadrunner-server/api","commit":"e422ab8ebdd7f209f99a5a045c8b5b2eafc3c303"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":3,"reason":"4 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 3","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/15 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 20 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-23T04:35:22.334Z","repository_id":37612372,"created_at":"2025-08-23T04:35:22.334Z","updated_at":"2025-08-23T04:35:22.334Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29922533,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-27T19:37:42.220Z","status":"ssl_error","status_checked_at":"2026-02-27T19:37:41.463Z","response_time":57,"last_error":"SSL_read: 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-11-06T07:12:12.491Z","updated_at":"2026-02-28T01:54:41.189Z","avatar_url":"https://github.com/roadrunner-server.png","language":"Go","funding_links":["https://github.com/sponsors/roadrunner-server"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003ca href=\"https://roadrunner.dev\" target=\"_blank\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://github.com/roadrunner-server/.github/assets/8040338/e6bde856-4ec6-4a52-bd5b-bfe78736c1ff\"\u003e\n    \u003cimg align=\"center\" src=\"https://github.com/roadrunner-server/.github/assets/8040338/040fb694-1dd3-4865-9d29-8e0748c2c8b8\"\u003e\n  \u003c/picture\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n \u003ca href=\"https://packagist.org/packages/spiral/roadrunner\"\u003e\u003cimg src=\"https://poser.pugx.org/spiral/roadrunner/version\"\u003e\u003c/a\u003e\n\t\u003ca href=\"https://pkg.go.dev/github.com/roadrunner-server/api/v4?tab=doc\"\u003e\u003cimg src=\"https://godoc.org/github.com/roadrunner-server/api/v4?status.svg\"\u003e\u003c/a\u003e\n\t\u003ca href=\"https://github.com/roadrunner-server/api/actions\"\u003e\u003cimg src=\"https://github.com/roadrunner-server/api/workflows/Linters/badge.svg\" alt=\"\"\u003e\u003c/a\u003e\n\t\u003ca href=\"https://goreportcard.com/report/github.com/roadrunner-server/api\"\u003e\u003cimg src=\"https://goreportcard.com/badge/github.com/roadrunner-server/api\"\u003e\u003c/a\u003e\n\t\u003ca href=\"https://discord.gg/TFeEmCs\"\u003e\u003cimg src=\"https://img.shields.io/badge/discord-chat-magenta.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# RoadRunner API\n\nThis repository contains the **Protocol Buffer definitions** for [RoadRunner](https://roadrunner.dev). These protos are used for external integrations (RPC) and internal communications between RoadRunner plugins.\n\nGenerated Go code lives in a separate repository: [`roadrunner-server/api-go`](https://github.com/roadrunner-server/api-go).\n\n## Repository structure\n\n```\nroadrunner/api/   — RoadRunner proto definitions (jobs, kv, http, status, etc.)\nthird_party/api/  — Temporal API submodule (used as a proto dependency)\nbuf.yaml          — Buf module configuration\nbuf.gen.yaml      — Buf code generation configuration\n```\n\n## Using generated Go packages\n\nInstall a package from the [`api-go`](https://github.com/roadrunner-server/api-go) repository:\n\n```bash\ngo get github.com/roadrunner-server/api-go/v5/build/\u003cmodule\u003e/\u003cversion\u003e\n```\n\nExample usage:\n\n```go\npackage foo\n\nimport (\n\tjobsv1 \"github.com/roadrunner-server/api-go/v5/build/jobs/v1\"\n)\n\nfunc Push(in *jobsv1.PushRequest, out *jobsv1.Empty) error {\n\treturn nil\n}\n```\n\n## Auto-generation\n\nPushing to `master` in this repo triggers a GitHub Actions workflow in [`api-go`](https://github.com/roadrunner-server/api-go) that:\n\n1. Pulls the latest proto definitions via a git submodule.\n2. Runs `buf generate` to produce Go code.\n3. Commits and pushes the result.\n\nYou do not need to run code generation manually — CI handles it automatically.\n\n## Local development\n\nInstall [Buf](https://buf.build/docs/installation):\n\n```bash\ngo install github.com/bufbuild/buf/cmd/buf@latest\n```\n\nLint proto files:\n\n```bash\nbuf lint\n```\n\nGenerate code locally (output goes to `build/`):\n\n```bash\nbuf generate\n```\n\n## Centrifugal API\n\n- [API](https://github.com/centrifugal/centrifugo/blob/master/internal/apiproto/api.proto)\n- [Proxy](https://github.com/centrifugal/centrifugo/blob/master/internal/proxyproto/proxy.proto)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froadrunner-server%2Fapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froadrunner-server%2Fapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froadrunner-server%2Fapi/lists"}