Update docblocks' return types in client.lua #14390
Open
+5
−5
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
I found it confusing that the kong.client documentation said
kong.client.get_credential()
returns a string, but the@treturn
and example usage indicate that in fact a table is returned. While I was in there, I saw other places where return values seem to have been mis-documented the other way around - where@treturn
was indicated, but the return values were actually string.I am not sure of all of the table items returned from get_credential(), but from what I can tell it is just id, consumer_id, and username. I need someone to confirm if that is all.
Checklist
changelog/unreleased/kong
orskip-changelog
label added on PR if changelog is unnecessary. README.mdngx.ctx.authenticated_credential
.Issue reference
Fix #[issue number]