Comments (1)
EDIT: This problem might only affect providers using the Terraform Plugin SDKv2. I haven't checked with a provider using the Terraform Plugin Framework
Unfortunately this also appears to affect resources.
This issue is a downstream result of the terraform providers schema -json
command utilizing an output format for list/set attributes that contains limited information about the list/set contents. Further upstream, that command relies on this json marshaller, and that json is consumed in terraform-plugin-docs
via the terraform-json unmarshalling library.
Example in the current format (note, many of the "string" attributes have associated Descriptions, and they are missing here due to the strange format):
"attributes": {
"builds": {
"type": [
"list",
[
"object",
{
"id": "string",
"images": [
"list",
[
"object",
{
"created_at": "string",
"id": "string",
"region": "string"
}
]
],
"labels": [
"map",
"string"
],
"updated_at": "string"
}
]
],
"description": "Builds for this iteration.",
"description_kind": "plain",
"computed": true
}
}
If I'm reading the discussion in this PR correctly, it looks like the infrastructure exists in terraform
and in the downstream terraform-json
to allow terraform providers schema -json
to output more detailed information about nested types without moving any mountains, it just isn't being used yet.
from terraform-plugin-docs.
Related Issues (20)
- Errors when using plugin mux with plugin sdk and framework HOT 1
- Show default values for supported timeouts HOT 5
- Hide specific config options in the docs HOT 2
- Resource schema documentation generation ignores property values HOT 2
- SchemaMarkdown contains wrong nested attribute titles
- Consider Warning/Error With Mismatched Terraform Architecture HOT 11
- Support Provider-Defined Function Documentation HOT 3
- Migrate from mitchellh/cli to hashicorp/cli HOT 1
- Bug: generate fails with "Provider registry.terraform.io/hashicorp/mongodbatlas v0.0.1 does not have a package available for your current platform, darwin_arm64." HOT 6
- Switch to `github.com/yuin/goldmark` library for all Markdown processing HOT 1
- [Question] Why do we have to provide the `--tf-version` to the `generate` command? HOT 2
- tfplugindocs migrate command outputs absolute file paths HOT 1
- Add a GitHub Action tutorial
- Improve documentation of `object` type for provider-defined functions
- Consider Tuple support for doc generator HOT 1
- The plugin has issue with id field. It marks all id fields as readonly HOT 2
- Adding `CustomType` to a `ListAttribute` changes generated description to `List of Dynamic` HOT 6
- Unexpected error `NestingSet blocks may not contain attributes of cty.DynamicPseudoType` HOT 4
- Go generate seems to be not picking up latest changes from the current project directory, somehow .git directory seems to overshadow the current project directory HOT 3
- Duplicate docs are generated when template names have `<provider-name>_` prefix HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from terraform-plugin-docs.