Skip to content

docs(sandbox): document registry creation via client.registries#4626

Open
Mukil Loganathan (langchain-infra) wants to merge 1 commit into
mainfrom
mukil/sandbox-registry-docs
Open

docs(sandbox): document registry creation via client.registries#4626
Mukil Loganathan (langchain-infra) wants to merge 1 commit into
mainfrom
mukil/sandbox-registry-docs

Conversation

@langchain-infra

Copy link
Copy Markdown
Contributor

Why

Snapshot creation no longer accepts inline registry credentials. The registry_url / registry_username / registry_password options (and the CLI --registry-url/--registry-username/--registry-password flags) were removed in favor of first-class registries referenced by id. The current docs still show the removed options, so anyone copying them hits an error.

What

  • sandbox-snapshots.mdx: replace the inline-credential example with creating a registry via client.registries.create(...) and passing its id as registry_id (Python) / registryId (TypeScript). Add a line covering list / retrieve / update / delete.
  • sandbox-cli.mdx: replace the removed registry-credential flags with --registry-id, linking to the snapshots page for creating a registry.

Both examples use the same SandboxClient the docs already show — the registries accessor is added in langchain-ai/langsmith-sdk#3087.

Dependency — do not merge before the SDK ships

client.registries / client.registries ships in langchain-ai/langsmith-sdk#3087. Keep this PR as a draft until that PR is merged and released, otherwise the docs describe an API users cannot call yet. A version-added <Note> should be added once the target langsmith release is known.

Test plan

  • make lint_prose clean on both files (0 errors, 0 warnings).
  • Code examples verified against the live API (dev) via client.registries create → retrieve → list → delete.

Authored with the assistance of an AI agent.

Inline registry url/username/password on snapshot creation are no longer
supported; update the snapshots and CLI docs to create a registry with
client.registries.create(...) and reference it by registry_id / --registry-id.
@github-actions github-actions Bot added langsmith For docs changes to LangSmith internal labels Jun 26, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Mintlify preview branch generated: preview-mukils-1782461447-28a4f81

Site preview: https://langchain-5e9cc07a-preview-mukils-1782461447-28a4f81.mintlify.app

Important

Preview links may take a few minutes to start working while the deployment finishes.

Changed documentation pages (preview deep links):

@langchain-infra Mukil Loganathan (langchain-infra) marked this pull request as ready for review June 26, 2026 14:44
@github-actions

Copy link
Copy Markdown
Contributor

Thanks for opening a docs PR, Mukil Loganathan (@langchain-infra)! When it's ready for review, please add the relevant reviewers:

  • @katmayb or @fjmorris (LangSmith)

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

Labels

internal langsmith For docs changes to LangSmith

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants