Skip to content

Commit

Permalink
pkg doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
austinvalle committed May 6, 2024
1 parent eb08273 commit 9450487
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions helper/schema/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,11 @@ type Provider struct {

TerraformVersion string

// deferralAllowed is populated by the ConfigureProvider RPC request, however
// it should only be used during provider configuration.
// deferralAllowed is populated by the ConfigureProvider RPC request and
// should only be used during provider configuration.
//
// MAINTAINER NOTE: Other RPCs that need to check if deferrals are allowed
// should use the relevant RPC request field in ClientCapabilities.
deferralAllowed bool

// providerDeferred is a global deferred response that will be returned automatically
Expand All @@ -119,11 +122,13 @@ type Provider struct {
}

type ConfigureProviderRequest struct {
// DeferralAllowed indicates whether the Terraform client initiating
// the read request allows a deferred response.
// DeferralAllowed indicates whether the Terraform request configuring
// the provider allows a deferred response. This field should be used to determine
// if `(schema.ConfigureProviderResponse).DeferredResponse` can be set.
//
// If true: `(schema.ConfigureProviderResponse).DeferredResponse` can be
// set.
// set to automatically defer all resources and data sources associated
// with this provider.
//
// If false: `(schema.ConfigureProviderResponse).DeferredResponse`
// will return an error diagnostic if set.
Expand Down

0 comments on commit 9450487

Please sign in to comment.