Skip to content

Commit

Permalink
document api endpoint coverage map for go-tfe (#334)
Browse files Browse the repository at this point in the history
  • Loading branch information
laurenolivia committed Feb 25, 2022
1 parent a2b5498 commit 3fdd80d
Show file tree
Hide file tree
Showing 4 changed files with 64 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Expand Up @@ -56,19 +56,23 @@ 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

See the [examples directory](https://github.com/hashicorp/go-tfe/tree/main/examples).

## 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

Expand Down
File renamed without changes.
57 changes: 57 additions & 0 deletions 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
File renamed without changes.

0 comments on commit 3fdd80d

Please sign in to comment.