docs: update graphql descriptions auth #3010
Merged
Conversation
This file contains 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
- Added new descriptions for empty elements - Revised and refined existing descriptions
github-actions
bot
added
type: source
✅ Deploy Preview for brilliant-pasca-3e80ec canceled.
|
Add description for the query id argument
- Pagination - Filtering - Asset code
mkurapov
reviewed
Oct 7, 2024
| state: GrantState! | ||
| "Reason a grant was finalized" | ||
| "Reason why the grant was finalized." |
There was a problem hiding this comment.
this is a tough one, I kind of think "reason" is not the best usage here for the variable in general, I would say "outcome" or "status" is more accurate.
Could be: "The specific outcome for a finalized grant" or something like that. Not a blocker though
There was a problem hiding this comment.
Good call on this one! I'd recommend renaming that variable (finalizationReason) to not have "reason" in the name.
There was a problem hiding this comment.
Makes sense, we can update it as part of a larger API change
| actions: [String]! | ||
| "Payment limits" | ||
| "Limits for payment associated with this access." |
There was a problem hiding this comment.
Suggested change
| "Limits for payment associated with this access." | |
| "Limits for an outgoing payment associated with this access." |
| type: String! | ||
| "Access action (create, read, list or complete)" | ||
| "Actions allowed with this access (create, read, list, or complete)." |
There was a problem hiding this comment.
Suggested change
| "Actions allowed with this access (create, read, list, or complete)." | |
| "Actions allowed with this access" |
There are more than those listed, and in different combination per each resource so safer to not mention I think
Changed a few descriptions per Max's PR feedback
brad-dow
changed the title
mkurapov
approved these changes
Oct 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Updated descriptions for the Auth Admin API. This fixes #2987
While these changes are enhancements to the current reference docs, I understand that the graphql schemas are also used to generate other files/types.