FlexMeasures / flexmeasures / 23806253080

78%

push

github

Add POST endpoints for creating annotations on accounts, assets, and sensors (#1968)

* Initial plan

* Add annotation API endpoints for accounts, assets, and sensors

Co-authored-by: Flix6x <30658763+Flix6x@users.noreply.github.com>

* Fix API issues: add response schema, fix idempotency, add error handling

Co-authored-by: Flix6x <30658763+Flix6x@users.noreply.github.com>

* Remove temporary API review file

* tests(api/dev): add comprehensive tests for annotation API endpoints

Context:
- Issue #470 implements new POST endpoints for annotations on accounts, assets, and sensors
- New endpoints at /api/dev/annotation/{accounts,assets,sensors}/<id>
- Endpoints use AnnotationSchema for validation and return AnnotationResponseSchema
- Implements idempotent behavior (201 for new, 200 for existing)

Tests added:
- Permission validation for all three endpoints (accounts, assets, sensors)
  - Tests account-admin, platform admin, regular users, and cross-account access
  - Verifies 403 Forbidden for unauthorized access and 401 for no auth
- Validation error handling:
  - Missing required fields (content, start, end)
  - Invalid type enum values
  - Content exceeding 1024 characters
  - End time before or equal to start time
- Idempotency test (201 first, 200 second with same data)
- 404 Not Found for non-existent entities
- Valid annotation type enum values (alert, holiday, label, feedback, warning, error)
- Default type value (label)
- Optional belief_time field
- Response schema validation (all expected fields present)
- Comprehensive test covering all three endpoints together
- Verification that annotations are correctly linked to entities

Test coverage:
- 17 test functions covering all requirements from issue #470
- Uses setup_api_fresh_test_data fixture for database isolation
- Follows existing FlexMeasures test patterns from v3_0 API tests
- All tests parametrized appropriately for comprehensive coverage

* Add comprehensive documentation for annotati... (continued)

81 of 92 new or added lines in 9 files covered. (88.04%)

11575 of 14879 relevant lines covered (77.79%)

0.78 hits per line