Render attribute names for nested objected attributes correctly #357
+1,094
−750
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
bflad
approved these changes
Apr 18, 2024
Comment on lines
+111
to
+126
| <a id="nestedblock--single_nested_block_sensitive_nested_attribute"></a> | ||
| ### Nested Schema for `single_nested_block_sensitive_nested_attribute` | ||
|
|
||
| Optional: | ||
|
|
||
| - `single_nested_block_attribute` (String) example single nested block attribute | ||
| - `single_nested_block_sensitive_attribute` (String, Sensitive) example sensitive single nested block attribute | ||
|
|
||
|
|
||
| <a id="nestedblock--set_nested_block_sensitive_nested_attribute"></a> | ||
| ### Nested Schema for `set_nested_block_sensitive_nested_attribute` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `set_nested_block_attribute` (String) example set nested block attribute | ||
| - `set_nested_block_sensitive_attribute` (String, Sensitive) example sensitive set nested block attribute |
There was a problem hiding this comment.
Non-blocking: I do find it curious how these become un-alphabetically ordered. 🤔 Certainly not for this PR, but it might be nice to see if we can fix that at some point for practitioners who might scroll instead of clicking the link. 👍
...s/testdata/scripts/schema-json/generate/framework_provider_success_all_framework_types.txtar
Outdated
Show resolved
Hide resolved
...s/testdata/scripts/schema-json/generate/framework_provider_success_all_framework_types.txtar
Outdated
Show resolved
Hide resolved
Co-authored-by: Brian Flad <bflad417@gmail.com>
1 task
|
argh sorry @SBGoods - missed that in my initial PR. Thanks for fixing this ❤️ |
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Closes: #356
PR #350 introduced a new
pathTitlefield to thenestedTypestruct to fix a bug where incorrect attribute titles were being generated for nested attributes. ThepathTitlefield was not being populated in thewriteObjectAttribute()function, which caused the documentation generation to render an empty string for nested object attribute titles. This PR correctly populates thepathTitlefield and adds more extensive unit and acceptance test cases with various framework types for proper test coverage.