update docs - specify which resources require admin token

ilia-medvedev-codefresh · ilia-medvedev-codefresh · commit 4ed843588a0d · 2024-07-10T09:24:15.000+03:00
diff --git a/codefresh/cfclient/user.go b/codefresh/cfclient/user.go
@@ -228,7 +228,9 @@ func (client *Client) GetAllUsers() (*[]User, error) {
 	var allUsers []User
 
 	for !bIsDone {
-		var userPaginatedResp struct{Docs []User `json:"docs"`}
+		var userPaginatedResp struct {
+			Docs []User `json:"docs"`
+		}
 
 		opts := RequestOptions{
 			Path:   fmt.Sprintf("/admin/user?limit=%d&page=%d", limitPerQuery, nPageIndex),
@@ -248,7 +250,7 @@ func (client *Client) GetAllUsers() (*[]User, error) {
 		}
 
 		if len(userPaginatedResp.Docs) > 0 {
-			allUsers = append(allUsers,userPaginatedResp.Docs...)
+			allUsers = append(allUsers, userPaginatedResp.Docs...)
 			nPageIndex++
 		} else {
 			bIsDone = true
diff --git a/codefresh/data_account_gitops_settings.go b/codefresh/data_account_gitops_settings.go
@@ -13,28 +13,28 @@ func dataSourceAccountGitopsSettings() *schema.Resource {
 		Read:        dataSourceAccountGitopsSettingsRead,
 		Schema: map[string]*schema.Schema{
 			"id": {
-				Type:     schema.TypeString,
+				Type:        schema.TypeString,
 				Description: "Account Id",
-				Computed: true,
+				Computed:    true,
 			},
 			"name": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
 				Description: "Account name for active account",
 			},
 			"git_provider": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
 				Description: "Git provider name",
 			},
 			"git_provider_api_url": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
 				Description: "Git provider API url",
 			},
 			"shared_config_repository": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:        schema.TypeString,
+				Computed:    true,
 				Description: "Shared config repository url",
 			},
 			"admins": {
diff --git a/codefresh/resource_account_gitops_settings.go b/codefresh/resource_account_gitops_settings.go
@@ -24,9 +24,9 @@ func resourceAccountGitopsSettings() *schema.Resource {
 		Delete: resourceAccountGitopsSettingsDelete,
 		Schema: map[string]*schema.Schema{
 			"id": {
-				Type:     schema.TypeString,
+				Type:        schema.TypeString,
 				Description: "Account Id",
-				Computed: true,
+				Computed:    true,
 			},
 			"name": {
 				Type:        schema.TypeString,
diff --git a/docs/data-sources/idps.md b/docs/data-sources/idps.md
@@ -2,7 +2,7 @@
 page_title: "codefresh_idps Data Source - terraform-provider-codefresh"
 subcategory: ""
 description: |-
-  This data source retrieves all Identity Providers (IdPs) in the system.
+  This data source retrieves all Identity Providers (IdPs) in the system. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
 ---
 
 # codefresh_idps (Data Source)
@@ -55,7 +55,7 @@ resource "codefresh_user" "user1" {
       idp_id = data.codefresh_idps.idp_azure.id
       sso = true
   }
-  
+
   login  {
       idp_id = data.codefresh_idps.local.id
       //sso = false
@@ -99,4 +99,4 @@ resource "codefresh_idp_accounts" "acc_idp" {
 - `cookie_key` (String)
 - `id` (String) The ID of this resource.
 - `scopes` (Set of String)
-- `tenant` (String)
+- `tenant` (String)
diff --git a/docs/data-sources/user.md b/docs/data-sources/user.md
@@ -7,7 +7,7 @@ description: |-
 
 # codefresh_user (Data Source)
 
-This data source retrieves a user by email.
+This data source retrieves a user by email. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
 
 ## Example usage
 
@@ -88,4 +88,4 @@ Read-Only:
 
 Read-Only:
 
-- `user_name` (String)
+- `user_name` (String)
diff --git a/docs/data-sources/users.md b/docs/data-sources/users.md
@@ -7,7 +7,7 @@ description: |-
 
 # codefresh_users (Data Source)
 
-This data source retrieves all users in the system.
+This data source retrieves all users in the system. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
 
 ## Example usage
 
@@ -81,4 +81,4 @@ Read-Only:
 
 Read-Only:
 
-- `user_name` (String)
+- `user_name` (String)
diff --git a/docs/resources/account.md b/docs/resources/account.md
@@ -2,7 +2,7 @@
 page_title: "codefresh_account Resource - terraform-provider-codefresh"
 subcategory: ""
 description: |-
-  By creating different accounts for different teams within the same company a customer can achieve complete segregation of assets between the teams.
+  By creating different accounts for different teams within the same company a customer can achieve complete segregation of assets between the teams. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
 ---
 
 # codefresh_account (Resource)
@@ -86,4 +86,4 @@ Optional:
 ## Import
 ```sh
 terraform import codefresh_account.test xxxxxxxxxxxxxxxxxxx
-```
+```
diff --git a/docs/resources/account_admins.md b/docs/resources/account_admins.md
@@ -2,7 +2,7 @@
 page_title: "codefresh_account_admins Resource - terraform-provider-codefresh"
 subcategory: ""
 description: |-
-  Use this resource to set a list of admins for any account.
+  Use this resource to set a list of admins for any account. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
 ---
 
 # codefresh_account_admins (Resource)
@@ -72,4 +72,4 @@ resource "codefresh_account_admins" "test" {
 
 ```sh
 terraform import codefresh_account_admins.test xxxxxxxxxxxxxxxxxxx
-```
+```
diff --git a/docs/resources/account_gitops_settings.md b/docs/resources/account_gitops_settings.md
@@ -41,7 +41,7 @@ resource "codefresh_account_gitops_settings" "gitops-settings" {
 - `id` (String) Account Id
 - `name` (String) Account name for active account
 
-[!WARNING]
+~>
 Once internal config repository is cloned successfully by one or more runtimes it can no longer be changed and all attempted updates will fail.
 If you need to change the repository please contact Codefresh support.
 
diff --git a/docs/resources/api_key.md b/docs/resources/api_key.md
@@ -2,14 +2,14 @@
 page_title: "codefresh_api_key Resource - terraform-provider-codefresh"
 subcategory: ""
 description: |-
-  Manages an API Key tied to an Account and a User.
+  Manages an API Key tied to an Account and a User. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
 ---
 
 # codefresh_api_key (Resource)
 
 Manages an API Key tied to an Account and a User.
 
-terraform-provider-codefresh itself uses an API key, passed as provider's attribute, but it's possible to use that API Key to generate a new one. 
+terraform-provider-codefresh itself uses an API key, passed as provider's attribute, but it's possible to use that API Key to generate a new one.
 This resource requires Codefresh system admin permissions, hence is relevant for on-prem deployments of Codefresh only.
 
 
@@ -106,4 +106,4 @@ resource "codefresh_team" "team_1" {
 ### Read-Only
 
 - `id` (String) The ID of this resource.
-- `token` (String, Sensitive) The resulting API key.
+- `token` (String, Sensitive) The resulting API key.
diff --git a/docs/resources/user.md b/docs/resources/user.md
@@ -2,7 +2,7 @@
 page_title: "codefresh_user Resource - terraform-provider-codefresh"
 subcategory: ""
 description: |-
-  This resource is used to manage a Codefresh user.
+  This resource is used to manage a Codefresh user. Requires Codefresh admin token and hence is relevant only for on premise installations of Codefresh.
 ---
 
 # codefresh_user (Resource)
@@ -43,7 +43,7 @@ resource "codefresh_user" "new" {
       idp_id = data.codefresh_idps.idp_azure.id
       sso = true
   }
-  
+
   login  {
       idp_id = data.codefresh_idps.local.id
       //sso = false
@@ -119,4 +119,3 @@ Read-Only:
 ```sh
 terraform import codefresh_user.new xxxxxxxxxxxxxxxxxxx
 ```
-
