docgen: include Authorization header requirement in OpenRPC method de…#4818
Open
Sushil-19 wants to merge 1 commit intocelestiaorg:mainfrom
Open
docgen: include Authorization header requirement in OpenRPC method de…#4818Sushil-19 wants to merge 1 commit intocelestiaorg:mainfrom
Sushil-19 wants to merge 1 commit intocelestiaorg:mainfrom
Conversation
Sushil-19
requested review from
Wondertan,
mcrakhman,
renaynay,
vgonkivs and
walldiss
as code owners
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.
This change improves the OpenRPC documentation by explicitly indicating that
authenticated RPC methods require the HTTP header:
Authorization: Bearer
Previously the documentation only indicated the permission level
(e.g. "Auth level: read"), which could lead to confusion when users
copied request examples and encountered authorization errors.
This change updates the OpenRPC generator so that all methods with
permissions automatically include the required Authorization header
information in their descriptions.