Skip to content

Commit 944d82a

Browse files
committed
Prepare release 1.3.0: Entity resolution and scheduling improvements
1 parent 56d2e1e commit 944d82a

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

docs/history.rst

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,49 @@
22
History
33
=======
44

5+
1.3.0 (2026-01-08)
6+
-------------------
7+
8+
| Entity resolution and scheduling improvements - Consistent API patterns across canvas, versioning, and parameters modules
9+
10+
**Entity Resolution** (``nipyapi.utils``)
11+
12+
- **resolve_entity()**: New utility for consistent entity resolution - accepts object, ID, or name across 31 refactored functions
13+
- **resolve_schedule_state()**: Standardized bool/string to state normalization for scheduling functions
14+
- **parse_bool()**: Extracted utility for CLI boolean parameter handling (fixes ``--flag=false`` being truthy)
15+
16+
**Canvas Module Enhancements**
17+
18+
- **Port scheduling**: New ``get_port()`` and ``schedule_port()`` functions for input/output port management
19+
- **String state scheduling**: ``schedule_controller()`` and ``schedule_all_controllers()`` now accept string states ('ENABLED', 'DISABLED') in addition to bool
20+
- **INVALID controller fix**: ``schedule_all_controllers()`` now correctly skips INVALID controllers when enabling, avoiding 30-second timeouts
21+
- **create_controller()**: Fixed to set component name in initial creation request (was returning stale object)
22+
- **Flexible entity input**: 17 canvas functions now accept object, ID, or name via ``resolve_entity()``
23+
- **get_controller()**: Added ``greedy`` parameter for name matching control
24+
- **Optional location**: ``create_process_group()`` and ``create_funnel()`` no longer require location parameter
25+
26+
**Versioning Module Enhancements**
27+
28+
- **Flexible entity input**: 9 versioning functions now accept object, ID, or name via ``resolve_entity()``
29+
30+
**Parameters Module Enhancements**
31+
32+
- **Flexible entity input**: 5 parameters functions now accept object, ID, or name via ``resolve_entity()``
33+
34+
**Deprecations**
35+
36+
- Removed deprecated ``get_variable_registry()`` and ``update_variable_registry()`` (use parameter contexts)
37+
38+
**Breaking Changes**
39+
40+
- Invalid ``scheduled`` values now raise ``ValueError`` instead of ``AssertionError`` (more appropriate exception type)
41+
42+
**Infrastructure**
43+
44+
- Consolidated ``_run_verification_request()`` helper for controller verification pattern
45+
- Added ``PortEntity`` to ``config.py`` registered_filters for ``filter_obj`` support
46+
- Updated contributing guide with CLI boolean parameter handling examples
47+
548
1.2.0 (2025-12-31)
649
-------------------
750

0 commit comments

Comments
 (0)