github.com/opentofu/opentofu@v1.7.1/internal/configs/configschema/doc.go (about)

     1  // Copyright (c) The OpenTofu Authors
     2  // SPDX-License-Identifier: MPL-2.0
     3  // Copyright (c) 2023 HashiCorp, Inc.
     4  // SPDX-License-Identifier: MPL-2.0
     5  
     6  // Package configschema contains types for describing the expected structure
     7  // of a configuration block whose shape is not known until runtime.
     8  //
     9  // For example, this is used to describe the expected contents of a resource
    10  // configuration block, which is defined by the corresponding provider plugin
    11  // and thus not compiled into OpenTofu core.
    12  //
    13  // A configschema primarily describes the shape of configuration, but it is
    14  // also suitable for use with other structures derived from the configuration,
    15  // such as the cached state of a resource or a resource diff.
    16  //
    17  // This package should not be confused with the package helper/schema, which
    18  // is the higher-level helper library used to implement providers themselves.
    19  package configschema