Skip to content

Commit 59446a7

Browse files
committed
docs: consolidate markdown documentation
Cleaned up redundant documentation files. **Removed duplicates:** - FINAL_TYPING_STATUS.md (info in CHANGELOG.md) - IMPLEMENTATION_COMPLETE.md (redundant) - TYPING_COMPLETE_SUMMARY.md (redundant) - RELEASE_NOTES_v0.3.0.md (consolidated into CHANGELOG.md) **Kept essential docs:** - README.md (main documentation) - CHANGELOG.md (version history) - UNTYPED_ENDPOINTS.md (important reference) - CONTRIBUTING.md (contributor guide) - QUICKSTART.md (getting started) Result: Clean, organized documentation structure.
1 parent 30209aa commit 59446a7

File tree

5 files changed

+71
-1119
lines changed

5 files changed

+71
-1119
lines changed

CHANGELOG.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Changelog
2+
3+
All notable changes to the elexon-bmrs project will be documented in this file.
4+
5+
## [0.3.0] - 2024-10-16
6+
7+
### 🎉 Major Release: Full Type Safety
8+
9+
This release transforms the SDK into a fully typed Python client with 95% type coverage.
10+
11+
### Added
12+
- **275 fully typed endpoints** (95% coverage) with Pydantic models
13+
- **280 Pydantic models** auto-generated from OpenAPI spec
14+
- **39 field mixins** to eliminate code duplication (~364+ lines saved)
15+
- **Comprehensive test suite** (`tests/test_typed_endpoints.py`)
16+
- **Clear warnings** for 12 untyped endpoints in docstrings
17+
- **Type resolution** for List[Model], List[str], and wrapped responses
18+
- **Automatic response parsing** with fallback to raw data
19+
- **Documentation**: `UNTYPED_ENDPOINTS.md` for reference
20+
21+
### Changed
22+
- All 287 methods now have proper return type annotations
23+
- Generated client methods return Pydantic models instead of `Dict[str, Any]`
24+
- Version bumped to 0.3.0
25+
- User-Agent updated to `elexon-bmrs-python/0.3.0`
26+
27+
### Fixed
28+
- PN endpoint model structure (fixed field definitions)
29+
- BOALF endpoint model (corrected field mappings)
30+
- Settlement stack model (added missing fields)
31+
- URL construction in `_make_request`
32+
- Import errors (removed obsolete `typed_client.py`)
33+
34+
### Removed
35+
- `elexon_bmrs/typed_client.py` (typing now integrated in main client)
36+
- `tools/generate_typed_client.py` (no longer needed)
37+
38+
### Technical Details
39+
- **Type Coverage**: 275/287 endpoints (95%)
40+
- Single models: 181
41+
- List[Model]: 90
42+
- List[str]: 4
43+
- Untyped (Dict): 12 (API spec limitation)
44+
- **Code Generation**: Fully automated from OpenAPI spec
45+
- **Backward Compatible**: Zero breaking changes
46+
47+
### Documentation
48+
- Added `UNTYPED_ENDPOINTS.md` - Complete reference for untyped endpoints
49+
- Added in-code warnings for all untyped methods
50+
- Updated all docstrings with proper return type documentation
51+
52+
## [0.2.0] - Previous Release
53+
54+
### Added
55+
- BOALF endpoint support
56+
- Physical Notifications (PN) endpoint
57+
- Settlement stack methods
58+
- Custom helper methods for common operations
59+
60+
### Fixed
61+
- API endpoint URL construction
62+
- Various model validation issues
63+
64+
## [0.1.0] - Initial Release
65+
66+
### Added
67+
- Initial BMRS API client
68+
- Basic endpoint coverage
69+
- Exception handling
70+
- API key support
71+

FINAL_TYPING_STATUS.md

Lines changed: 0 additions & 212 deletions
This file was deleted.

0 commit comments

Comments
 (0)