Add Admin API Update Endpoints and Organization Resource

[jhamon]

Add Admin API Update Endpoints and Organization Resource

Summary

This PR implements new update endpoints for the Admin API and adds a new OrganizationResource class to expose organization management functionality. The changes include:

1. API Key Updates: Added update() method to ApiKeyResource to support updating API key names and roles
2. Organization Resource: Created a new OrganizationResource class attached to the Admin class with full CRUD operations (list, fetch, get, describe, update)
3. Integration: Exposed OrganizationResource in the Admin class via organization and organizations properties
4. Testing: Added comprehensive integration tests for all new functionality

Changes

1. API Key Resource Updates

File: pinecone/admin/resources/api_key.py

• Added update() method to ApiKeyResource class
• Supports updating API key name and roles
• Includes RST-formatted docstrings with examples
• Follows existing patterns from other resource classes

Example Usage:

from pinecone import Admin

# When initializing, the Admin class reads creds from PINECONE_CLIENT_ID 
and PINECONE_CLIENT_SECRET environment variables
admin = Admin() 

# Update API key name
api_key = admin.api_key.update(
    api_key_id='my-api-key-id',
    name='updated-api-key-name'
)

# Update API key roles
api_key = admin.api_key.update(
    api_key_id='my-api-key-id',
    roles=['ProjectViewer']
)

2. Organization Resource

File: pinecone/admin/resources/organization.py (new file)

Created a new OrganizationResource class with the following methods:

• list(): List all organizations associated with the account
• fetch(organization_id): Fetch an organization by ID
• get(organization_id): Alias for fetch()
• describe(organization_id): Alias for fetch()
• update(organization_id, name): Update an organization's name

Example Usage:

from pinecone import Admin

admin = Admin()

# List all organizations
organizations = admin.organization.list()
for org in organizations.data:
    print(org.name)

# Fetch an organization
org = admin.organization.get(organization_id="my-org-id")

# Update an organization
org = admin.organization.update(
    organization_id="my-org-id",
    name="updated-name"
)

3. Integration Tests

File: tests/integration/admin/test_api_key.py

• Added test_update_api_key() test covering:
  • Updating API key name only
  • Updating API key roles only
  • Updating both name and roles
  • Verifying changes persist after fetch
  • Proper cleanup of created resources

File: tests/integration/admin/test_organization.py (new file)

Added comprehensive integration tests:

• test_update_organization(): Tests updating organization name with proper cleanup (reverts name changes)
• test_list_organizations(): Tests listing organizations, verifies response structure, field types, and dictionary/get-style access
• test_fetch_organization(): Tests fetching an organization by ID, verifies all fields match list results
• test_fetch_aliases(): Tests that fetch(), get(), and describe() return identical results

All tests include proper error handling and cleanup to avoid resource waste.

Implementation Details

• All methods follow existing patterns from ProjectResource and ApiKeyResource
• Uses @require_kwargs decorator for parameter validation
• Error handling follows existing patterns
• Tests verify both attribute access and dictionary-style access for compatibility

Backward Compatibility

✅ All changes are backward compatible. No existing functionality is modified or removed.

Related

• Implements update endpoints found in pinecone/core/openapi/admin/ (generated OpenAPI code)
• Follows workspace rules for RST docstrings and integration testing