adding docs for the framework Required field (#13884)

* adding docs for the framework Required field * minor fix * Update sdk/framework/backend.go Co-authored-by: Jim Kalafut <[email protected]> Co-authored-by: Jim Kalafut <[email protected]>
hashicorp · Feb 3, 2022 · c61d0d2 · c61d0d2
1 parent 2999fb8
commit c61d0d2
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/sdk/framework/backend.go b/sdk/framework/backend.go
@@ -625,8 +625,11 @@ type FieldSchema struct {
 	Type        FieldType
 	Default     interface{}
 	Description string
-	Required    bool
-	Deprecated  bool
+
+	// The Required and Deprecated members are only used by openapi, and are not actually
+	// used by the framework.
+	Required   bool
+	Deprecated bool
 
 	// Query indicates this field will be sent as a query parameter:
 	//