docs: add auth preview capability - #153
Open
villagesql-adam wants to merge 2 commits into
Open
Conversation
- preview-capabilities.mdx: new Authentication Methods section, capability-index row, and frontmatter description entry for vsql::preview::auth (AuthCapability, handler contract, ops table, vsql_auth_test example, SQL binding + client flow) - Aligns to villagesql-server@c841e1caaff (auth capability, PR #762); SQL flow and output verified on the live server AI=CLAUDE Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
The auth preview capability was redesigned after this branch was
cut. Rewrite the Authentication Methods section to the current API:
- typed handler `AuthResult authenticate(AuthContext&)` replacing the
raw `vef_auth_result_t(ctx, ops)` form; scoped `AuthResult::kOk/
kReject/kError` replacing raw VEF_AUTH_* constants
- fluent `make_auth<&handler>("name").client_plugin(...).build()`
builder + single-descriptor `AuthCapability` constructor, replacing
the removed 3-arg constructor
- `client_plugin` documented as optional (defaults to
mysql_clear_password), correcting the prior "required" claim
- document the new `set_active_roles` staging + no-escalation semantics
- condense the Complete Example to the core token flow
Aligns to villagesql-server@4d7219dcdf1 (preview/auth.h redesign)
AI=CLAUDE
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
| `vsql_auth_test` is a registered VEF auth method — the same way an installed | ||
| plugin name is accepted. | ||
|
|
||
| The method pins `mysql_clear_password`, so the client must pass |
Member
There was a problem hiding this comment.
there are some changes coming here, so let's wait a bit until that arrives to document. The plan is to accept any secret that is provided unscrambled, --enable-cleartext-plugin is one option to do so, there are other options
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
AI=CLAUDE