A clear and concise description of what problem this feature request is trying to solve
As an OpenAPI Terraform User
I want the documentation generator to look for array descriptions on the items level if there isn't one on the root property level
So that I can put descriptions on the array items (eg in the case of Goa) and have them rendered in the docs
Acceptance criteria
Given the following Swagger resource definition with an array property where the description is on the items level and there is no description on the property root level:
"Resource": {
"properties": {
"owners": {
"items": {
"description": "Users who own the resource",
"type": "string"
},
"type": "array"
},
},
}
When the OpenAPI Terraform provider documentation generator is called
Then the rendered documentation should use the description from the array items.
Checklist (for admin only)
Don't forget to go through the checklist to make sure the issue is created properly:
[x] I have added a corresponding label (feature request) to the issue (right side menu)
[x] I have added this issue to the 'API Terraform Provider' GitHub project (right side menu)
Is your feature request related to a problem?
A clear and concise description of what problem this feature request is trying to solve
Acceptance criteria
Given the following Swagger resource definition with an array property where the description is on the items level and there is no description on the property root level:
When the OpenAPI Terraform provider documentation generator is called
Then the rendered documentation should use the description from the array items.
Checklist (for admin only)
Don't forget to go through the checklist to make sure the issue is created properly: