Expand the API proposal to include a "behavior" section #582
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
The behavior of certain APIs may not be immediately clear from the API schema. Add a separate section for "behavior" to allow authors to specify notes related to the behavior of the API if they are non- obvious.
|
@Rob--W Please review -- let me know if this looks good to you, and I'll tag in a couple other folks. I don't want to be too prescriptive in this section, but I do think it's worth having as part of the default proposal. |
Rob--W
approved these changes
Apr 2, 2024
xeenon
approved these changes
Apr 2, 2024
|
Thanks, Rob and Timothy! @dotproto and @oliverdunk , please also review. If it looks good to you, please merge. |
github-actions bot
added a commit
that referenced
this pull request
Apr 3, 2024
…or_section SHA: b0a84d4 Reason: push, by oliverdunk Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
github-actions bot
added a commit
that referenced
this pull request
Apr 3, 2024
…or_section SHA: b0a84d4 Reason: push, by oliverdunk Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.
The behavior of certain APIs may not be immediately clear from the
API schema. Add a separate section for "behavior" to allow authors
to specify notes related to the behavior of the API if they are non-
obvious.