Skip to content

Align auth credential create contract#444

Open
DhruvPareek wants to merge 1 commit intomainfrom
auth-v2-credential-create-contract
Open

Align auth credential create contract#444
DhruvPareek wants to merge 1 commit intomainfrom
auth-v2-credential-create-contract

Conversation

@DhruvPareek
Copy link
Copy Markdown
Contributor

@DhruvPareek DhruvPareek commented May 6, 2026

  • Fix descriptions for API endpoints based on new changes where we only add additional auth methods rather than create the first auth method for an account

@vercel
Copy link
Copy Markdown

vercel Bot commented May 6, 2026

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

Project Deployment Actions Updated (UTC)
grid-flow-builder Ready Ready Preview, Comment May 7, 2026 11:27pm

Request Review

Copy link
Copy Markdown
Contributor Author

DhruvPareek commented May 6, 2026

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

✱ Stainless preview builds

This PR will update the grid SDKs with the following commit messages.

kotlin

docs(api): update credential registration documentation

openapi

docs(api): clarify auth credentials flow and remove passkey limit in embedded wallet

python

chore(tests): update auth credentials docs and test fixtures

typescript

docs(api): update auth credentials method descriptions

Edit this comment to update them. They will appear in their respective SDK's changelogs.

grid-python studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅build ✅lint ✅test ✅

pip install https://pkg.stainless.com/s/grid-python/86c474383f37e5ec5aa26da0d133398bacd56630/grid-0.0.1-py3-none-any.whl
grid-kotlin studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅build ✅lint ✅test ✅

grid-typescript studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅build ✅ (prev: build ❗) → lint ❗test ✅ (prev: test ❗)

npm install https://pkg.stainless.com/s/grid-typescript/a1096382f7e249c77d32fa1862ed1bd9837d827b/dist.tar.gz
grid-openapi studio · code · diff

Your SDK build had at least one "note" diagnostic, but this did not represent a regression.
generate ✅


This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push.
If you push custom code to the preview branch, re-run this workflow to update the comment.
Last updated: 2026-05-07 23:31:20 UTC

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 7, 2026

Greptile Summary

This PR updates the POST /auth/credentials endpoint documentation to reflect a new backend contract where internal accounts are always initialized with an EMAIL_OTP credential, so this endpoint is now always used to add additional credentials rather than to create a first one.

  • The two-section description ("First credential" / "Adding an additional credential") is collapsed into a single always-signed flow, and the 202 response is now described as unconditional rather than conditional on an existing credential being present.
  • Example summaries are renamed from "Register …" to "Add …" and the 400 description is tightened to cover both EMAIL_OTP_CREDENTIAL_ALREADY_EXISTS and PASSKEY_CREDENTIAL_ALREADY_EXISTS in one sentence.
  • The AuthCredentialResponseOneOf schema loses its OAuth actionable hint ("call POST /auth/credentials/{id}/verify with a fresh OIDC token instead") — worth confirming that guidance is covered elsewhere in the docs.

Confidence Score: 4/5

Safe to merge — all changes are documentation strings and no executable code is touched.

The rewrite accurately models the new always-signed flow. One small grammatical typo ("an credential") made it through in three files (source + both bundles), but this has no functional impact.

The typo in the Request-Id description propagates through openapi/paths/auth/auth_credentials.yaml, openapi.yaml, and mintlify/openapi.yaml — fixing it in the source and re-running make build will resolve all three at once.

Important Files Changed

Filename Overview
openapi/paths/auth/auth_credentials.yaml Main source for the endpoint description rewrite — collapses the two-section (first credential / additional credential) flow into a single always-signed flow; contains one grammatical typo ("an credential").
openapi/components/schemas/auth/AuthCredentialResponseOneOf.yaml Removes the OAuth actionable hint ("call POST /auth/credentials/{id}/verify with a fresh OIDC token") — description is slightly less complete but otherwise correct.
openapi/components/schemas/auth/EmailOtpCredentialCreateRequestFields.yaml Whitespace-only reformatting of the type field description — no semantic change.
openapi.yaml Generated bundle reflecting the same changes as openapi/paths/auth/auth_credentials.yaml; contains the same "an credential" typo in the Request-Id header description.
mintlify/openapi.yaml Mintlify bundle — identical changes to openapi.yaml, same "an credential" typo present.

Fix All in Claude Code

Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
openapi/paths/auth/auth_credentials.yaml:49-50
Grammatical typo: "an credential" should be "a credential". This appears in the `Request-Id` header description and will be visible to API consumers in documentation.

```suggestion
        challenge. Required on the signed retry when registering a
        credential; must be paired with `Grid-Wallet-Signature`.
```

Reviews (1): Last reviewed commit: "Align auth credential create contract" | Re-trigger Greptile

Comment on lines +49 to +50
challenge. Required on the signed retry when registering an
additional credential; must be paired with `Grid-Wallet-Signature`.
credential; must be paired with `Grid-Wallet-Signature`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 Grammatical typo: "an credential" should be "a credential". This appears in the Request-Id header description and will be visible to API consumers in documentation.

Suggested change
challenge. Required on the signed retry when registering an
additional credential; must be paired with `Grid-Wallet-Signature`.
credential; must be paired with `Grid-Wallet-Signature`.
challenge. Required on the signed retry when registering a
credential; must be paired with `Grid-Wallet-Signature`.
Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/paths/auth/auth_credentials.yaml
Line: 49-50

Comment:
Grammatical typo: "an credential" should be "a credential". This appears in the `Request-Id` header description and will be visible to API consumers in documentation.

```suggestion
        challenge. Required on the signed retry when registering a
        credential; must be paired with `Grid-Wallet-Signature`.
```

How can I resolve this? If you propose a fix, please make it concise.

Fix in Claude Code

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