-
Notifications
You must be signed in to change notification settings - Fork 67
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Render attribute names for nested objected attributes correctly #357
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Excellent fix and additional testing, @SBGoods! Looks good to me 🚀
<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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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>
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. |
Closes: #356
PR #350 introduced a new
pathTitle
field to thenestedType
struct to fix a bug where incorrect attribute titles were being generated for nested attributes. ThepathTitle
field 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 thepathTitle
field and adds more extensive unit and acceptance test cases with various framework types for proper test coverage.