Add resource-level note to API Reference page#40
Open
knottnt wants to merge 1 commit into
Open
Conversation
Reads the `note` field from each controller's documentation.yaml and renders it as a distinct callout on the resource detail page, between the description and the field tables.
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: knottnt The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
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.
Issue #, if available:
Description of changes:
Reads the
notefield from each controller's documentation.yaml and renders it as a distinct callout on the resource detail page, between the description and the field tables. When no documentation.yaml note is present API Reference is unchanged.Example Screenshot:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.