chore(api): formalize /metadata

[MasterPtato]

No description provided.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
rivetkit-serverless	Ready	Preview	Comment	Dec 1, 2025 9:30pm

3 Skipped Deployments

Project	Deployment	Preview	Comments	Updated (UTC)
rivet-cloud	Ignored			Dec 1, 2025 9:30pm
rivet-inspector	Ignored	Preview		Dec 1, 2025 9:30pm
rivet-site	Ignored	Preview		Dec 1, 2025 9:30pm

[MasterPtato]

• chore: add op name to logs #3564
• chore(api): formalize /metadata #3563 👈 (View in Graphite)
• main

---

How to use the Graphite Merge Queue

Add the label merge-queue to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

[claude]

PR Review: Formalize /metadata Endpoint

Summary

This PR formalizes the /metadata endpoint by adding proper OpenAPI documentation, type-safe response structures, and consistent error handling. It also includes cleanup of unused protobuf dependencies and formatting fixes.

Code Quality

Strengths:

• Proper use of strongly-typed response struct instead of json!() macro
• Follows repository patterns for API handlers (inner function + error handling wrapper)
• Good use of utoipa for OpenAPI documentation
• Consistent with other endpoint implementations in the codebase

Issues Found:

CRITICAL BUG - Wrong HTTP Method in OpenAPI Doc

In engine/packages/api-public/src/metadata.rs line 26, the utoipa annotation specifies delete but the actual route is GET /metadata (line 57 in router.rs). This will generate incorrect OpenAPI documentation.

Fix: Change line 26 from delete to get

Performance Considerations

• Minimal allocations (only string conversions)
• No database queries or external calls
• Very lightweight endpoint - good performance profile

Security Concerns

• Correctly uses ctx.skip_auth() since this is public metadata
• No sensitive information exposed (build metadata is safe to share)
• Follows auth handling pattern properly

Best Practices

Minor Issues:

1. Unnecessary String Allocations: The response converts all static str constants to String. Since build metadata are compile-time constants, consider using static str in the response struct to avoid allocations.

2. OpenAPI Schema Naming: The schema alias MetadataGetResponse follows good naming conventions.

Dependency Cleanup

• Removal of unused protobuf dependency is good housekeeping
• Properly removed from both workspace and package manifests
• Removed from all Docker build configurations

Formatting Changes

The tab indentation changes in various files align with the repository's rustfmt.toml configuration (hard tabs). These are good cleanup changes.

Test Coverage

No tests were added for the formalized endpoint. Consider adding:

• Integration test to verify response structure
• Test to ensure all build metadata fields are populated
• OpenAPI schema validation test

Recommendations

Must Fix:

• Change delete to get in utoipa::path annotation (metadata.rs:26)

Consider:

• Use static str instead of String in GetResponse for better performance
• Add integration tests for the endpoint
• Verify the generated OpenAPI spec includes the metadata endpoint correctly after fixing the HTTP method

Overall Assessment

Good refactoring that improves type safety and API documentation. One critical bug needs fixing (wrong HTTP method in OpenAPI doc), but otherwise the implementation follows best practices and repository conventions well.

Status: Needs changes before merge

[pkg-pr-new]

More templates

• example-ai-agent
• chat-room
• example-cloudflare-workers
• example-cloudflare-workers-hono
• example-cloudflare-workers-inline-client
• example-counter
• example-counter-next-js
• example-counter-serverless
• example-cursors
• example-cursors-raw-websocket
• example-deno
• example-sqlite
• example-elysia
• example-express
• example-freestyle
• example-hono
• example-hono-bun
• example-hono-react
• example-kitchen-sink
• example-next-js
• quickstart-actions
• quickstart-cross-actor-actions
• quickstart-multi-region
• quickstart-raw-websockets
• quickstart-realtime
• quickstart-scheduling
• quickstart-state
• example-raw-fetch-handler
• example-raw-websocket-handler
• example-raw-websocket-handler-proxy
• example-react
• starter
• example-stream
• example-trpc

@rivetkit/cloudflare-workers

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/cloudflare-workers@3563

@rivetkit/db

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/db@3563

@rivetkit/framework-base

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/framework-base@3563

@rivetkit/next-js

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/next-js@3563

@rivetkit/react

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/react@3563

rivetkit

pnpm add https://pkg.pr.new/rivet-dev/rivet/rivetkit@3563

@rivetkit/sql-loader

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/sql-loader@3563

@rivetkit/engine-runner

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/engine-runner@3563

@rivetkit/engine-runner-protocol

pnpm add https://pkg.pr.new/rivet-dev/rivet/@rivetkit/engine-runner-protocol@3563

commit: 70bb42d

[graphite-app]

Merge activity

• Dec 2, 7:45 AM UTC: NathanFlurry added this pull request to the Graphite merge queue.
• Dec 2, 7:45 AM UTC: CI is running for this pull request on a draft pull request (#3568) due to your merge queue CI optimization settings.
• Dec 2, 7:46 AM UTC: Merged by the Graphite merge queue via draft PR: #3568.