docs: add warning on possible CTFd model inconsistency

ctfer-io · Mar 2, 2024 · e36c79a · e36c79a
1 parent 112db2b
commit e36c79a
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/provider/team_data_source.go b/provider/team_data_source.go
@@ -79,7 +79,7 @@ func (team *teamDataSource) Schema(ctx context.Context, req datasource.SchemaReq
 				Computed:            true,
 			},
 			"captain": schema.StringAttribute{
-				MarkdownDescription: "Member who is captain of the team. Must be part of the members too.",
+				MarkdownDescription: "Member who is captain of the team. Must be part of the members too. Note it could cause a fatal error in case of resource import with an inconsistent CTFd configuration i.e. if a team has no captain yet (should not be possible).",
 				Computed:            true,
 			},
 		},

diff --git a/provider/team_resource.go b/provider/team_resource.go
@@ -103,7 +103,7 @@ func (r *teamResource) Schema(ctx context.Context, req resource.SchemaRequest, r
 				Required:            true,
 			},
 			"captain": schema.StringAttribute{
-				MarkdownDescription: "Member who is captain of the team. Must be part of the members too.",
+				MarkdownDescription: "Member who is captain of the team. Must be part of the members too. Note it could cause a fatal error in case of resource import with an inconsistent CTFd configuration i.e. if a team has no captain yet (should not be possible).",
 				Required:            true,
 			},
 		},