schema: add more documentation #5611
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
MetRonnie
reviewed
Jul 3, 2023
Comment on lines
+913
to
+914
| configuration as opposed to task "instances" which you will find | ||
| in the `TaskProxies` field. |
There was a problem hiding this comment.
Perhaps
Suggested change
| configuration as opposed to task "instances" which you will find | |
| in the `TaskProxies` field. | |
| configuration as opposed to dynamic task "instances" which you | |
| will find in the `TaskProxies` field. |
There was a problem hiding this comment.
Not sure about "dynamic" (note some fields on the Task are dynamic).
Co-authored-by: Ronnie Dutta <[email protected]>
MetRonnie
approved these changes
Jul 4, 2023
|
Going to go with single approval for these docs. |
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.
Partially addresses: #5612
There are a few folks poking around with the GraphQL schema which is great, but the documentation is a bit lacking.
Add a quick description to the most commonly used fields.
Check List
CONTRIBUTING.mdand added my name as a Code Contributor.setup.cfg(andconda-environment.ymlif present).CHANGES.mdentry included if this is a change that can affect users?.?.xbranch.