hashicorp / hashicorp/terraform-plugin-framework

Add support for a Description interface for Actions

Open
#1,253 4 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Go
Stars
384
Forks
107
Avg merge
3m
Merged PRs (30d)
1

Description

### Module version

```
...
```

### Use-cases

It would be helpful to be able to document actions using definition. It is not easy to discover while implementing an action that a Definition method needs to be filled.

### Attempted Solutions

Not defining a definition

### Proposal

Could you add an interface that contains one method Definition and add to the documentation how to document an action definition using markdown.

### References

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.