Skip to content

Document credential field labels - #605

Merged
masnwilliams merged 1 commit into
mainfrom
hypeship/credential-field-labels
Sep 18, 2026
Merged

masnwilliams merged 1 commit into
mainfrom
hypeship/credential-field-labels

Conversation

@masnwilliams

@masnwilliams masnwilliams commented Sep 18, 2026

Copy link
Copy Markdown
Contributor

summary

  • document optional credential field label values and stable name semantics
  • explain label validation, non-secret metadata behavior, exact field ordering, and unlabeled fallback
  • update TypeScript, Python, and CLI examples to the ordered field array contract
  • keep update examples keyed by stable field name

rollout

Publish after kernel/kernel#4214 and the corresponding SDK release are live.

validation

  • rendered /vaults/credentials with a local Mintlify preview
  • git diff --check

Note

Low Risk
Documentation-only changes with no runtime or security behavior in this repo.

Overview
Updates vault credential docs and snippets to match the ordered fields array contract (each entry has name, optional label, plus type/required/sensitive) instead of a keyed object map.

Adds guidance that name stays the stable key for state.fields, updates, and fill, while label is optional display metadata with validation and name fallback. Collection forms and custom UIs should preserve declaration order and show labels when set.

TypeScript, Python, and CLI creation examples are refreshed; value update samples still send changes keyed by field name.

Reviewed by Cursor Bugbot for commit 8329f3e. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Sep 18, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
Kernel 🟢 Ready View Preview Sep 18, 2026, 6:01 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk Assessment: Very Low

Decision: Approve

This PR only updates Mintlify documentation (vaults/credentials.mdx and snippets/collect-browser-credentials.mdx). The diff rewrites credential fields examples from a keyed object to an ordered array with name / optional label, and adds matching API-docs prose. There is no application code, config, CI, infrastructure, auth, or runtime logic in the change set.

Evidence

  • 2 files, +104 / −32, both .mdx
  • No CODEOWNERS file in the repo
  • No production codepaths, shared libraries, or schema/infra changes

Risk factors

  • Codepaths: docs pages and snippet examples only
  • Blast radius: documentation site copy
  • Complexity: mechanical example updates plus field-table/prose edits
  • Infra / operational / security impact in this repo: none

No existing reviews on this PR. Approving as Very Low risk.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@masnwilliams
masnwilliams merged commit c4501af into main Sep 18, 2026
4 checks passed
@masnwilliams
masnwilliams deleted the hypeship/credential-field-labels branch September 18, 2026 20:50
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