Skip to content

Commit 1609e7b

Browse files
committed
Update CHANGELOG.md
1 parent cbeefd6 commit 1609e7b

File tree

1 file changed

+78
-2
lines changed

1 file changed

+78
-2
lines changed

CHANGELOG.md

Lines changed: 78 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,85 @@
11
# CHANGELOG
22

3+
## Version 0.59.2 (December 2024)
4+
5+
**Released**: December 2024
6+
7+
This is a maintenance release that adds support for deprecated SLE endpoints and reorganizes project structure.
8+
9+
---
10+
11+
## 1. FUNCTIONS ADDED
12+
13+
### **src/mistapi/api/v1/sites/sle.py**
14+
- `getSiteSleSummary(mist_session, site_id, scope, scope_id, metric, start, end, duration)` - Get SLE metric summary (marked as deprecated in Mist API, replaced by `getSiteSleSummaryTrend`)
15+
- `getSiteSleSummaryTrend(mist_session, site_id, scope, scope_id, metric, start, end, duration)` - Get SLE metric summary trend (replacement for deprecated endpoint)
16+
- `getSiteSleClassifierDetails(mist_session, site_id, scope, scope_id, metric, classifier, start, end, duration)` - Get SLE classifier details (marked as deprecated in Mist API, replaced by `getSiteSleClassifierSummaryTrend`)
17+
- `getSiteSleClassifierSummaryTrend(mist_session, site_id, scope, scope_id, metric, classifier, start, end, duration)` - Get SLE classifier summary trend (replacement for deprecated endpoint)
18+
19+
---
20+
21+
## 2. FUNCTIONS DEPRECATED
22+
23+
### **src/mistapi/api/v1/sites/sle.py**
24+
- `getSiteSleSummary` - Deprecated in version 0.59.2, will be removed in 0.65.0 (replaced by `getSiteSleSummaryTrend`)
25+
- `getSiteSleClassifierDetails` - Deprecated in version 0.59.2, will be removed in 0.65.0 (replaced by `getSiteSleClassifierSummaryTrend`)
26+
27+
**Note**: These functions are marked with `@deprecation.deprecated` decorator and will show deprecation warnings when used.
28+
29+
---
30+
31+
## Summary Statistics
32+
33+
- **Functions Added**: 4 (2 deprecated, 2 replacement)
34+
- **Functions Deprecated**: 2
35+
- **Total Files Modified**: 7
36+
- **Lines Added**: 296
37+
- **Lines Removed**: 6
38+
39+
---
40+
41+
## Breaking Changes
42+
43+
None. All deprecated functions remain available with deprecation warnings.
44+
45+
---
46+
47+
## Migration Guide
48+
49+
If you're using the deprecated SLE functions:
50+
51+
**Before (deprecated):**
52+
```python
53+
# This will show deprecation warning
54+
response = mistapi.api.v1.sites.sle.getSiteSleSummary(
55+
mist_session, site_id, scope, scope_id, metric
56+
)
57+
```
58+
59+
**After (recommended):**
60+
```python
61+
# Use the new trend endpoint
62+
response = mistapi.api.v1.sites.sle.getSiteSleSummaryTrend(
63+
mist_session, site_id, scope, scope_id, metric
64+
)
65+
```
66+
67+
Both functions will continue to work until version 0.65.0.
68+
69+
---
70+
71+
## Resources
72+
73+
- **Full API Documentation**: [Mist API Documentation](https://doc.mist-lab.fr)
74+
- **GitHub Repository**: [mistapi_python](https://github.com/tmunzer/mistapi_python)
75+
- **PyPI Package**: [mistapi](https://pypi.org/project/mistapi/)
76+
- **Issue Tracker**: [GitHub Issues](https://github.com/tmunzer/mistapi_python/issues)
77+
78+
---
79+
380
## Version 0.59.1 (December 2024)
481

5-
**Released**: December 2024
6-
**Previous Version**: 0.58.0
82+
**Released**: December 2024
783

884
This release introduces significant enhancements to the Mist API Python SDK, including new endpoints, improved pagination support, and updated API specifications.
985

0 commit comments

Comments
 (0)