Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Register
  • Sign in
  • engine-api engine-api
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Issues 14
    • Issues 14
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Artifacts
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Container Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • AURAAURA
  • engine-apiengine-api
  • Issues
  • #10
Closed
Open
Issue created Sep 18, 2020 by David Trattnig@davidOwner

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 to track_start, which is more or less the time of the track started playing. Update: When needed using field custom_json or any custom logs for debugging
  • Should we store studio_id or line_in_id in the playlog? Update: When needed using field custom_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
Edited Oct 02, 2020 by David Trattnig
Assignee
Assign to
Time tracking