diff --git a/README.md b/README.md index 0d336a2d4..f7e69ac57 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,11 @@ if err != nil { ## Documentation -For complete usage of the API client, see the full [package docs](https://pkg.go.dev/github.com/hashicorp/go-tfe). +For complete usage of the API client, see the [full package docs](https://pkg.go.dev/github.com/hashicorp/go-tfe). + +## API Coverage + +This API client covers most of the existing Terraform Cloud API calls and is updated regularly to add new or missing endpoints. For a complete list of what is supported/unsupported, please [refer to this page](docs/COVERAGE.md). ## Examples @@ -64,11 +68,11 @@ See the [examples directory](https://github.com/hashicorp/go-tfe/tree/main/examp ## Running tests -See [TESTS.md](TESTS.md). +See [TESTS.md](docs/TESTS.md). ## Issues and Contributing -See [CONTRIBUTING.md](CONTRIBUTING.md) +See [CONTRIBUTING.md](docs/CONTRIBUTING.md) ## Releases diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md diff --git a/docs/COVERAGE.md b/docs/COVERAGE.md new file mode 100644 index 000000000..687fc82e6 --- /dev/null +++ b/docs/COVERAGE.md @@ -0,0 +1,57 @@ +## API Coverage + + +- [x] Account +- [x] Agent Pools +- [x] Agent Tokens +- [x] Applies +- [ ] Audit Trails +- [x] Configuration Versions +- [x] Cost Estimation +- [ ] Feature Sets +- [ ] Invoices +- [x] IP Ranges +- [x] Modules +- [x] Notification Configurations +- [x] OAuth Clients +- [x] OAuth Tokens +- [x] Organizations +- [x] Organization Memberships +- [x] Organization Tags +- [x] Organization Tokens +- [x] Plan Exports +- [x] Plans +- [x] Policies +- [x] Policy Checks +- [x] Policy Sets +- [x] Policy Set Parameters +- [x] Providers +- [x] Runs +- [x] Run Tasks +- [x] Run Triggers +- [x] SSH Keys +- [x] State Versions +- [x] State Version Outputs +- [ ] Subscriptions +- [x] Team Access +- [x] Team Membership +- [x] Team Tokens +- [x] Teams +- [x] User Tokens +- [x] Users +- [x] Variables +- [ ] VCS Events +- [x] Workspaces +- [x] Workspace-Specific Variables +- [x] Workspace Resources +- [x] Variable Sets +- [x] Admin + - [x] Module Sharing + - [x] Organizations + - [x] Runs + - [x] Settings + - [x] Terraform Versions + - [x] Users + - [x] Workspaces +- [x] Changelog +- [x] Stability Policy diff --git a/TESTS.md b/docs/TESTS.md similarity index 100% rename from TESTS.md rename to docs/TESTS.md