Audit Engine API (Architecture and API)
Review
- Architecture as described in the README: https://gitlab.servus.at/aura/engine-api
- API https://app.swaggerhub.com/apis/AURA-Engine/engine-api/1.0.0
- In Engine context the term "schedule" is used what is "timeslot" in other components. This is a legacy approach from the original engine. Let's discuss if this should be aligned. Update: Let's review the terms in overall in all components before releasing V1.0
- Do we need additional date fields for debugging and auditing, such as
log_time
(when this playlog was written to the local API database) and 'expected_play_time' (when the track should have been played, as per schedule, in contrast totrack_start
, which is more or less the time of the track started playing. Update: When needed using fieldcustom_json
or any custom logs for debugging - Should we store
studio_id
orline_in_id
in the playlog? Update: When needed using fieldcustom_json
Done as a result:
- Multiple documentation fixes and extensions done
- Add from_date and to_date for track service endpoint, similar to playlogs: #12 (closed)
- Fixed on API descriptions. Need to merge: #13 (closed)
- Added
is_synced
to the API spec of Playlog - Added new PlayLog field
custom_json
allowing future, dynamic extension of the API (such as studio ID) - More API Spec descriptions