{"id":51858588,"url":"https://github.com/stuttgart-things/machinery-registry-api","last_synced_at":"2026-07-24T03:31:08.864Z","repository":{"id":337129782,"uuid":"1152428848","full_name":"stuttgart-things/machinery-registry-api","owner":"stuttgart-things","description":"lightweight machinery inventory API","archived":false,"fork":false,"pushed_at":"2026-06-14T06:54:03.000Z","size":48,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-14T08:20:20.073Z","etag":null,"topics":["claims","crossplane","golang","machinery"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stuttgart-things.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":".github/agents.md","dco":null,"cla":null}},"created_at":"2026-02-07T21:30:23.000Z","updated_at":"2026-02-17T13:56:10.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/stuttgart-things/machinery-registry-api","commit_stats":null,"previous_names":["stuttgart-things/machinery-registry-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/stuttgart-things/machinery-registry-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuttgart-things%2Fmachinery-registry-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuttgart-things%2Fmachinery-registry-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuttgart-things%2Fmachinery-registry-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuttgart-things%2Fmachinery-registry-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stuttgart-things","download_url":"https://codeload.github.com/stuttgart-things/machinery-registry-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuttgart-things%2Fmachinery-registry-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35826032,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-07-20T02:08:10.276Z","status":"online","status_checked_at":"2026-07-24T02:00:07.870Z","response_time":62,"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":["claims","crossplane","golang","machinery"],"created_at":"2026-07-24T03:31:07.433Z","updated_at":"2026-07-24T03:31:08.843Z","avatar_url":"https://github.com/stuttgart-things.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# machinery-registry-api\n\nLightweight, read-only REST API that serves the claim inventory from a GitHub-hosted `registry.yaml`.\n\nPart of the [claim-machinery](https://github.com/stuttgart-things) platform (Phase 2). Periodically syncs the claim registry from a GitHub repository and exposes it via a filtered REST API.\n\n## Architecture\n\n```\nGitHub Repo (harvester)          machinery-registry-api\n┌────────────────────┐          ┌─────────────────────┐\n│ claims/             │  HTTP   │  Git Syncer          │\n│   registry.yaml    │◄────────│  (background poll)   │\n└────────────────────┘  poll    │         │            │\n                                │    RWMutex snapshot  │\n                                │         │            │\n                                │  HTTP API Server     │\n                                │  (Gorilla Mux)       │\n                                └─────────────────────┘\n```\n\n## Endpoints\n\n| Method | Path | Description |\n|--------|------|-------------|\n| `GET` | `/health` | Health check |\n| `GET` | `/version` | Build version info |\n| `GET` | `/api/v1/claims` | List all claims (with query filters) |\n| `GET` | `/api/v1/claims/{name}` | Get a single claim by name |\n| `GET` | `/openapi.yaml` | OpenAPI 3.0 spec |\n| `GET` | `/docs` | Redoc API documentation |\n\n### Query Filters\n\n`/api/v1/claims` supports filtering via query parameters:\n\n```\n/api/v1/claims?category=cli\u0026template=volumeclaim\u0026status=active\u0026source=cli\n```\n\n## Configuration\n\n| Env Var | Default | Description |\n|---------|---------|-------------|\n| `REGISTRY_REPO` | (required) | GitHub repo slug, e.g. `stuttgart-things/harvester` |\n| `REGISTRY_PATH` | `claims/registry.yaml` | Path to registry file in repo |\n| `REGISTRY_BRANCH` | `main` | Git branch |\n| `SYNC_INTERVAL` | `60s` | Polling interval |\n| `PORT` | `8080` | HTTP server port |\n| `GITHUB_TOKEN` | (optional) | For private repos |\n| `LOG_FORMAT` | `text` | `json` for structured logging |\n\n## Getting Started\n\n### Prerequisites\n\n- Go 1.25.6+\n- [Task](https://taskfile.dev/) (optional)\n\n### Run\n\n```bash\n# Using go directly\nREGISTRY_REPO=stuttgart-things/harvester go run .\n\n# Using Task\nREGISTRY_REPO=stuttgart-things/harvester task run\n```\n\n### Verify\n\n```bash\ncurl localhost:8080/health\ncurl localhost:8080/version\ncurl localhost:8080/api/v1/claims\ncurl localhost:8080/api/v1/claims/hacky\ncurl \"localhost:8080/api/v1/claims?category=cli\u0026template=volumeclaim\"\n```\n\n### Build\n\n```bash\ngo build -o bin/machinery-registry-api .\n# or\ntask build\n```\n\n### Test\n\n```bash\ngo test ./...\n# or\ntask test\n```\n\n## License\n\nSee [LICENSE](LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstuttgart-things%2Fmachinery-registry-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstuttgart-things%2Fmachinery-registry-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstuttgart-things%2Fmachinery-registry-api/lists"}