Skip to content

[SLOP(claude-opus-4-8-medium)] docs(pool-configuration): fix runner-config SDK snippet to use RivetClient from engine-api-full#5248

Open
NathanFlurry wants to merge 1 commit into
stack/slop-claude-opus-4-8-medium-docs-inspector-tabs-mark-illustrative-type-shape-snippets-as-nocheck-yosxkyoxfrom
stack/slop-claude-opus-4-8-medium-docs-pool-configuration-fix-runner-config-sdk-snippet-to-use-rivetclient-from-engine-api-full-tmoxrznq
Open

[SLOP(claude-opus-4-8-medium)] docs(pool-configuration): fix runner-config SDK snippet to use RivetClient from engine-api-full#5248
NathanFlurry wants to merge 1 commit into
stack/slop-claude-opus-4-8-medium-docs-inspector-tabs-mark-illustrative-type-shape-snippets-as-nocheck-yosxkyoxfrom
stack/slop-claude-opus-4-8-medium-docs-pool-configuration-fix-runner-config-sdk-snippet-to-use-rivetclient-from-engine-api-full-tmoxrznq

Conversation

@NathanFlurry

Copy link
Copy Markdown
Member

No description provided.

…onfig SDK snippet to use RivetClient from engine-api-full
@NathanFlurry

NathanFlurry commented Jun 13, 2026

Copy link
Copy Markdown
Member Author

Stack for rivet-dev/rivet

Get stack: forklift get 5248
Push local edits: forklift submit
Merge when ready: forklift merge 5248

@claude

claude Bot commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

Code Review

Overview

This PR updates two documentation snippets that show how to configure runner pools via the SDK. The changes fix the import path, constructor option name, method call style, and config schema nesting to match the current @rivetkit/engine-api-full generated client.

Changes Summary

Before After
Import rivetkit/client @rivetkit/engine-api-full
Constructor option endpoint environment
Method rivet.runnerConfigs.upsert() rivet.runnerConfigsUpsert()
Config shape flat serverless at top level nested under datacenters.default
@nocheck on pool-configuration.mdx absent added

Looks Good

  • Import correction@rivetkit/engine-api-full is the correct generated-client package. The old rivetkit/client path does not exist for this use case.
  • environment vs endpoint — matches the actual RivetClient constructor option; the old name would cause a silent no-op at runtime.
  • Method namerunnerConfigsUpsert is the flat generated-SDK style vs the old chained runnerConfigs.upsert; correct for the target package.
  • datacenters nesting — aligns with the current API schema that scopes serverless config per datacenter.
  • @nocheck on pool-configuration.mdx — consistent with freestyle.mdx, appropriate for illustrative SDK snippets that are not meant to be compiled directly.

Minor Observation

Both snippets use process.env.* and hardcoded placeholder strings that would not type-check cleanly, so the @nocheck flag is warranted on both. No action needed.

Verdict

Documentation-only change. Corrections are accurate and consistent across both files. No bugs, no security concerns, no performance impact. LGTM.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant