Skip to content

Commit 1f29f97

Browse files
committed
docs: comprehensive documentation update for async operations
- Update README with all new async operation features and examples - Create FEATURES.md documenting all async operations in detail - Add CHANGELOG.md with detailed record of recent changes - Document all --wait flag operations across 50+ commands - Add usage examples, best practices, and automation scripts - Include comprehensive coverage of network connectivity operations - Document ACL management, user operations, and provider accounts
1 parent 56cd49b commit 1f29f97

File tree

3 files changed

+666
-15
lines changed

3 files changed

+666
-15
lines changed

CHANGELOG.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Added
11+
12+
#### Comprehensive Async Operation Support (#175-#201)
13+
- **Database Operations** - Added `--wait` flag support for all database operations including create, update, delete, import, backup, and migrate commands
14+
- **Subscription Management** - Full async support for regular and fixed subscription operations with progress tracking
15+
- **Active-Active Databases** - Complete async operation support for CRDB create, update, and delete operations
16+
- **Network Connectivity** - Implemented `--wait` flags for:
17+
- VPC Peering operations (regular and Active-Active)
18+
- Private Service Connect (PSC) operations (regular and Active-Active)
19+
- Transit Gateway (TGW) operations including attach/detach (regular and Active-Active)
20+
- **ACL Management** - Added async support for all 9 ACL commands:
21+
- Redis ACL Rules (create, update, delete)
22+
- ACL Roles (create, update, delete)
23+
- ACL Users (create, update, delete)
24+
- **User Management** - Added `--wait` flag support for user deletion operations
25+
- **Provider Accounts** - Full async support for cloud provider account operations (create, update, delete)
26+
- **Fixed Plans** - Implemented async operations for fixed databases and fixed subscriptions
27+
28+
#### Wait Flag Options
29+
- `--wait` - Wait for operation to complete with default 600s timeout
30+
- `--wait-timeout <seconds>` - Configurable timeout duration for long operations
31+
- `--wait-interval <seconds>` - Customizable polling interval (default: 10s)
32+
33+
### Changed
34+
35+
#### Code Organization Improvements
36+
- **Parameter Grouping** - Introduced parameter structs to avoid `too_many_arguments` clippy warnings:
37+
- `AsyncOperationArgs` for async operation parameters
38+
- `ConnectivityOperationParams` for network connectivity operations
39+
- `CloudAccountOperationParams` for provider account operations
40+
- `AclOperationParams` for ACL management operations
41+
- **Module Consolidation** - Reorganized connectivity commands under unified module structure
42+
- **Centralized Async Handling** - All async operations now use the centralized `handle_async_response` function for consistency
43+
44+
### Fixed
45+
- Fixed clippy warnings for functions with too many arguments
46+
- Improved error handling for async operations with better context
47+
- Enhanced progress indicators with animated spinners
48+
- Fixed task ID extraction from various API response formats
49+
50+
### Documentation
51+
- Comprehensive README update with all new async operation examples
52+
- Updated CLAUDE.md with architectural changes and patterns
53+
- Created FEATURES.md documenting all async operations in detail
54+
- Added usage examples for all new `--wait` flag operations
55+
56+
## [0.2.0] - Previous Release
57+
58+
### Added
59+
- Basic Cloud API support
60+
- Enterprise API support
61+
- Profile management system
62+
- Multiple output formats (JSON, YAML, Table)
63+
- JMESPath query filtering
64+
65+
### Changed
66+
- Improved error handling
67+
- Better configuration management
68+
69+
### Fixed
70+
- Various bug fixes and improvements
71+
72+
## [0.1.0] - Initial Release
73+
74+
### Added
75+
- Initial implementation
76+
- Basic command structure
77+
- Authentication support
78+
- Raw API access

0 commit comments

Comments
 (0)