Add user (Basic auth) to Connect-RPC API reference endpoints#194
Open
Add user (Basic auth) to Connect-RPC API reference endpoints#194
Conversation
The `user` parameter is sent as an Authorization: Basic header but isn't part of the protobuf message, so it was missing from the generated API reference. Add a SandboxUserAuth security scheme and inject it into the 8 Connect-RPC endpoints that support it.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
1 participant
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.
Summary
SandboxUserAuth(HTTP Basic) security scheme to the OpenAPI spec for 8 Connect-RPC endpoints that accept an optionaluservia theAuthorizationheaderuserparameter is a transport-level concern (not a protobuf field), so it was previously missing from the generated API referenceProcess/Start,Filesystem/ListDir,Filesystem/MakeDir,Filesystem/Move,Filesystem/Remove,Filesystem/Stat,Filesystem/WatchDir,Filesystem/CreateWatcherProcess/Connect,Process/List, etc.) are unchanged