{"id":44150376,"url":"https://github.com/artifact-keeper/artifact-keeper-api","last_synced_at":"2026-04-02T17:17:14.388Z","repository":{"id":335958252,"uuid":"1147627015","full_name":"artifact-keeper/artifact-keeper-api","owner":"artifact-keeper","description":"OpenAPI 3.1 specification for the Artifact Keeper REST API. 165 endpoints, CI validation, TypeScript + Rust SDK generation.","archived":false,"fork":false,"pushed_at":"2026-03-29T00:15:04.000Z","size":632,"stargazers_count":3,"open_issues_count":2,"forks_count":4,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-29T01:45:12.217Z","etag":null,"topics":["artifact-registry","openapi","openapi-specification","rest-api","rust-sdk","sdk-generation","swagger","typescript-sdk"],"latest_commit_sha":null,"homepage":"https://artifactkeeper.com/docs","language":"Swift","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/artifact-keeper.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","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":"artifact-keeper"}},"created_at":"2026-02-02T02:31:41.000Z","updated_at":"2026-03-28T23:23:33.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/artifact-keeper/artifact-keeper-api","commit_stats":null,"previous_names":["artifact-keeper/artifact-keeper-api"],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/artifact-keeper/artifact-keeper-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artifact-keeper%2Fartifact-keeper-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artifact-keeper%2Fartifact-keeper-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artifact-keeper%2Fartifact-keeper-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artifact-keeper%2Fartifact-keeper-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/artifact-keeper","download_url":"https://codeload.github.com/artifact-keeper/artifact-keeper-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artifact-keeper%2Fartifact-keeper-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31311266,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T12:59:32.332Z","status":"ssl_error","status_checked_at":"2026-04-02T12:54:48.875Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["artifact-registry","openapi","openapi-specification","rest-api","rust-sdk","sdk-generation","swagger","typescript-sdk"],"created_at":"2026-02-09T03:15:24.993Z","updated_at":"2026-04-02T17:17:14.384Z","avatar_url":"https://github.com/artifact-keeper.png","language":"Swift","readme":"# Artifact Keeper API\n\nOpenAPI 3.1 specification for the Artifact Keeper management REST API.\n\n\u003e **Note:** This spec is **auto-generated** from the Rust backend's utoipa annotations.\n\u003e Do not edit `openapi.yaml` or `openapi.json` by hand — they are overwritten on every backend release.\n\u003e To change the API, modify the handler annotations in `artifact-keeper/backend/src/api/handlers/`.\n\n## What's included\n\n- **`openapi.yaml`** / **`openapi.json`** — Auto-generated OpenAPI 3.1 spec covering 277 operations across 24 endpoint groups\n- **CI validation** — Spectral + Redocly linting on every push/PR\n- **SDK generation** — TypeScript, Kotlin, Swift, and Rust clients auto-generated and published on release tags\n\n## SDK packages\n\nTagged releases (`v*`) automatically generate SDKs and publish them to GitHub Packages.\n\n### TypeScript (npm)\n\n```bash\nnpm install @artifact-keeper/sdk --registry=https://npm.pkg.github.com\n```\n\n```typescript\nimport { client } from '@artifact-keeper/sdk';\nimport { listRepositories, getHealth } from '@artifact-keeper/sdk';\n\nclient.setConfig({\n  baseUrl: 'https://your-registry.example.com',\n  headers: { Authorization: `Bearer ${token}` },\n});\n\nconst repos = await listRepositories();\n```\n\n### Kotlin (Gradle)\n\n```kotlin\n// settings.gradle.kts — add GitHub Packages Maven\ndependencyResolutionManagement {\n    repositories {\n        maven {\n            url = uri(\"https://maven.pkg.github.com/artifact-keeper/artifact-keeper-api\")\n            credentials {\n                username = providers.gradleProperty(\"gpr.user\").orNull ?: System.getenv(\"GITHUB_ACTOR\")\n                password = providers.gradleProperty(\"gpr.token\").orNull ?: System.getenv(\"GITHUB_TOKEN\")\n            }\n        }\n    }\n}\n\n// app/build.gradle.kts\ndependencies {\n    implementation(\"com.artifactkeeper:client:\u003cversion\u003e\")\n}\n```\n\n### Swift (SPM build plugin)\n\nThe Swift SDK uses Apple's swift-openapi-generator as an SPM build plugin. Download `artifact-keeper-swift-\u003cversion\u003e.zip` from the GitHub Release, unzip it into your project, then add it as a local package:\n\n```swift\n// In your app's Package.swift or Xcode project\n.package(path: \"../artifact-keeper-swift\")\n```\n\nTypes are generated at compile time — no pre-built binary needed.\n\n```swift\nimport ArtifactKeeperClient\nimport OpenAPIURLSession\n\nlet client = Client(\n    serverURL: URL(string: \"https://your-registry.example.com/api/v1\")!,\n    transport: URLSessionTransport()\n)\n```\n\n### Rust (Cargo)\n\nDownload `artifact-keeper-rust-\u003cversion\u003e.zip` from the GitHub Release.\n\n```toml\n[dependencies]\nartifact-keeper-client = { path = \"./artifact-keeper-rust\" }\n```\n\n## Endpoint groups\n\n| Tag | Description |\n|-----|-------------|\n| Health | Service health and readiness probes |\n| Auth | Authentication and session management |\n| Users | User accounts, roles, and API tokens |\n| Repositories | Artifact repository management |\n| Artifacts | Individual artifact operations |\n| Search | Full-text and faceted search |\n| Groups | User group management |\n| Permissions | Access control and permission grants |\n| Webhooks | Event notification webhooks |\n| Plugins | WASM plugin lifecycle management |\n| Formats | Package format handler registry |\n| Signing | Artifact signing and verification |\n| Security | Vulnerability scanning and security policies |\n| Edge Nodes | Edge node management and content replication |\n| Admin | System administration and backups |\n| Migration | Registry migration from Artifactory/Nexus |\n| Builds | Build information tracking |\n| Packages | Package-level views across versions |\n| Tree | Repository file tree browsing |\n| SBOM | Software Bill of Materials and license compliance |\n| Dependency Track | Dependency-Track vulnerability management |\n| Analytics | Storage analytics and usage metrics |\n| Monitoring | Service health monitoring and alerting |\n| Telemetry | Crash reporting and telemetry settings |\n| Lifecycle | Artifact retention and cleanup policies |\n| SSO Admin | SSO provider configuration (OIDC, LDAP, SAML) |\n| SSO | SSO authentication flows |\n\n## Scope\n\nThis spec covers Artifact Keeper's own REST API for managing the registry. It does **not** include format-specific protocol endpoints (npm, PyPI, Maven, Docker/OCI, Cargo, etc.) — those implement upstream specifications and are documented separately.\n\n## Local development\n\n### Validate spec\n\n```bash\nnpm install -g @stoplight/spectral-cli @redocly/cli\nspectral lint openapi.yaml\nredocly lint openapi.yaml\n```\n\n### Generate SDKs locally\n\n```bash\n# TypeScript\ncd sdk/typescript \u0026\u0026 npm install \u0026\u0026 npx openapi-ts\n\n# Kotlin (requires Docker)\ndocker run --rm -v \"${PWD}:/github/workspace\" openapitools/openapi-generator-cli:v7.12.0 \\\n  generate -c /github/workspace/sdk/kotlin/openapi-generator-config.yaml\n\n# Swift (copy spec, then build with SPM)\ncp openapi.yaml sdk/swift/Sources/ArtifactKeeperClient/openapi.yaml\ncd sdk/swift \u0026\u0026 swift build\n\n# Rust\ndocker run --rm -v \"${PWD}:/local\" openapitools/openapi-generator-cli:v7.12.0 generate \\\n  -i /local/openapi.yaml -g rust -o /local/generated/rust \\\n  --additional-properties=packageName=artifact-keeper-client\n```\n\n## Authentication\n\nThe API supports two authentication methods:\n\n- **Bearer token** — JWT obtained via `POST /api/v1/auth/login`\n- **API key** — Long-lived token passed in the `X-API-Key` header\n\n## License\n\nMIT\n","funding_links":["https://github.com/sponsors/artifact-keeper"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartifact-keeper%2Fartifact-keeper-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fartifact-keeper%2Fartifact-keeper-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartifact-keeper%2Fartifact-keeper-api/lists"}