Auto pagination org users (#26)

* Add auto-pagination for organization users data resource

* Include plugindocs

* Set default batch size to 100, for org users data

Author: Fodoj

README.md

@@ -81,6 +81,8 @@ cd terraform-provider-openai
 # Install dependencies and build
 make install
 
+# or make install-dev, to avoid conflicts with published version
+
 # Run tests
 make test
 ```
@@ -158,6 +160,10 @@ export OPENAI_ADMIN_KEY="your-admin-key"  # For admin operations
 export OPENAI_ORGANIZATION_ID="your-org-id"  # Optional
 ```
 
+#### Documentation
+
+Make sure to run `tfplugindocs` if resources are updated.
+
 ## Testing
 
 ### Environment Setup

docs/data-sources/organization_users.md

@@ -33,17 +33,12 @@ output "all_users_count" {
 
 ### Optional
 
-- `after` (String) A cursor for use in pagination. 'after' is an object ID that defines your place in the list.
 - `emails` (List of String) Filter by the email address of users.
-- `limit` (Number) A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
 - `user_id` (String) The ID of a specific user to retrieve. If provided, other filter parameters are ignored.
 
 ### Read-Only
 
-- `first_id` (String) The ID of the first user in the list
-- `has_more` (Boolean) Whether there are more users that can be retrieved by paginating
 - `id` (String) The ID of this resource.
-- `last_id` (String) The ID of the last user in the list
 - `users` (List of Object) List of users in the organization (see [below for nested schema](#nestedatt--users))
 
 <a id="nestedatt--users"></a>

internal/provider/data_source_openai_organization_users.go

@@ -20,17 +20,6 @@ func dataSourceOpenAIOrganizationUsers() *schema.Resource {
 				Optional:    true,
 				Description: "The ID of a specific user to retrieve. If provided, other filter parameters are ignored.",
 			},
-			"after": {
-				Type:        schema.TypeString,
-				Optional:    true,
-				Description: "A cursor for use in pagination. 'after' is an object ID that defines your place in the list.",
-			},
-			"limit": {
-				Type:        schema.TypeInt,
-				Optional:    true,
-				Default:     20,
-				Description: "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.",
-			},
 			"emails": {
 				Type:     schema.TypeList,
 				Optional: true,
@@ -78,21 +67,6 @@ func dataSourceOpenAIOrganizationUsers() *schema.Resource {
 				},
 				Description: "List of users in the organization",
 			},
-			"first_id": {
-				Type:        schema.TypeString,
-				Computed:    true,
-				Description: "The ID of the first user in the list",
-			},
-			"last_id": {
-				Type:        schema.TypeString,
-				Computed:    true,
-				Description: "The ID of the last user in the list",
-			},
-			"has_more": {
-				Type:        schema.TypeBool,
-				Computed:    true,
-				Description: "Whether there are more users that can be retrieved by paginating",
-			},
 		},
 	}
 }
@@ -139,27 +113,9 @@ func dataSourceOpenAIOrganizationUsersRead(ctx context.Context, d *schema.Resour
 			return diag.FromErr(fmt.Errorf("error setting users: %s", err))
 		}
 
-		// For a single user, has_more is always false
-		if err := d.Set("has_more", false); err != nil {
-			return diag.FromErr(fmt.Errorf("error setting has_more: %s", err))
-		}
-
-		// Set first_id and last_id to the user's ID
-		if err := d.Set("first_id", user.ID); err != nil {
-			return diag.FromErr(fmt.Errorf("error setting first_id: %s", err))
-		}
-
-		if err := d.Set("last_id", user.ID); err != nil {
-			return diag.FromErr(fmt.Errorf("error setting last_id: %s", err))
-		}
-
 		return nil
 	}
 
-	// If no specific user ID, list users with filters
-	after := d.Get("after").(string)
-	limit := d.Get("limit").(int)
-
 	// Extract the emails filter if provided
 	var emails []string
 	if rawEmails, ok := d.GetOk("emails"); ok {
@@ -168,46 +124,53 @@ func dataSourceOpenAIOrganizationUsersRead(ctx context.Context, d *schema.Resour
 		}
 	}
 
-	tflog.Debug(ctx, fmt.Sprintf("Listing organization users with limit: %d", limit))
+	// Automatic pagination - fetch all users with default batch size
+	const batchSize = 100
+	tflog.Debug(ctx, fmt.Sprintf("Fetching all organization users with batch size: %d", batchSize))
 
-	// Call the API using the provider's API key
-	resp, err := c.ListUsers(after, limit, emails)
-	if err != nil {
-		return diag.Errorf("error listing organization users: %s", err)
-	}
+	var allUsers []map[string]interface{}
+	var after string
+	hasMore := true
+	pageCount := 0
 
-	// Set a unique ID based on the query parameters
-	d.SetId(fmt.Sprintf("organization-users-%s-%d", after, limit))
-
-	// Prepare the users list
-	users := make([]map[string]interface{}, 0, len(resp.Data))
-	for _, user := range resp.Data {
-		u := map[string]interface{}{
-			"id":       user.ID,
-			"object":   user.Object,
-			"email":    user.Email,
-			"name":     user.Name,
-			"role":     user.Role,
-			"added_at": user.AddedAt,
+	// Paginate through all results
+	for hasMore {
+		pageCount++
+		tflog.Debug(ctx, fmt.Sprintf("Fetching page %d with after: %s", pageCount, after))
+
+		resp, err := c.ListUsers(after, batchSize, emails)
+		if err != nil {
+			return diag.Errorf("error listing organization users (page %d): %s", pageCount, err)
 		}
-		users = append(users, u)
-	}
 
-	// Set the computed values
-	if err := d.Set("users", users); err != nil {
-		return diag.FromErr(fmt.Errorf("error setting users: %s", err))
-	}
+		// Add users from this page to the collection
+		for _, user := range resp.Data {
+			u := map[string]interface{}{
+				"id":       user.ID,
+				"object":   user.Object,
+				"email":    user.Email,
+				"name":     user.Name,
+				"role":     user.Role,
+				"added_at": user.AddedAt,
+			}
+			allUsers = append(allUsers, u)
+		}
 
-	if err := d.Set("has_more", resp.HasMore); err != nil {
-		return diag.FromErr(fmt.Errorf("error setting has_more: %s", err))
+		// Check if there are more pages
+		hasMore = resp.HasMore
+		if hasMore && resp.LastID != "" {
+			after = resp.LastID
+		}
 	}
 
-	if err := d.Set("first_id", resp.FirstID); err != nil {
-		return diag.FromErr(fmt.Errorf("error setting first_id: %s", err))
-	}
+	tflog.Debug(ctx, fmt.Sprintf("Fetched %d total users across %d pages", len(allUsers), pageCount))
+
+	// Set a unique ID for the data source
+	d.SetId(fmt.Sprintf("organization-users-all-%d", len(allUsers)))
 
-	if err := d.Set("last_id", resp.LastID); err != nil {
-		return diag.FromErr(fmt.Errorf("error setting last_id: %s", err))
+	// Set the computed values
+	if err := d.Set("users", allUsers); err != nil {
+		return diag.FromErr(fmt.Errorf("error setting users: %s", err))
 	}
 
 	return nil

internal/provider/resource_openai_model_response.go

@@ -254,7 +254,7 @@ func resourceOpenAIModelResponseCreate(ctx context.Context, d *schema.ResourceDa
 
 	// Use the /v1/responses endpoint
 	path := "/v1/responses"
-	
+
 	// Make the request using the client's method
 	respBody, err := providerClient.DoRequest("POST", path, requestBody)
 	if err != nil {

internal/provider/resource_openai_organization_user.go

@@ -199,4 +199,3 @@ func resourceOpenAIOrganizationUserDelete(ctx context.Context, d *schema.Resourc
 	d.SetId("")
 	return nil
 }
-

tools/tools.go

@@ -0,0 +1,8 @@
+//go:build tools
+
+package tools
+
+import (
+  // Documentation generation
+  _ "github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs"
+)