SKA QA Metrics Data API

The QA Metrics Data API is a part of the SKA QA Display system that deals with the backend API access. It is a RESTful API server which subscribes to a message broker, which uses the Realtime receive processors for submitting QA data. The data is further used by the QA Display (a frontend repository) to visualise the data. It also has the functionality to generate the waterfall images of the spectrogram plots.

The QA Display system is composed of the API and the Display.

1. The API acts as a middleware. It receives data from the generator(s) and sends it to the display. ska-sdp-qa-data-api is the repository that contains the code for the main API image.

2. The display visualises the data in different sections, including multiple graphs and general statistics. ska-sdp-qa-display is the repository that contains the code for the main QA Display image.

Contents:

• API Overview
  • Getting Started with the API
  • Finding API Endpoints
  • REST Endpoints
  • WebSocket Endpoints
• Developing the QA Display API
  • Tooling Pre-requisites
  • Docker Development
  • Link to Running Instance
  • Running locally
  • Host Development
• Changelog
  • Development
  • 1.6.0
  • 1.5.0
  • 1.4.0
  • 1.3.0
  • 1.2.1
  • 1.2.0
  • 1.1.0
  • 1.0.2 (Helm Only)
  • 1.0.1 (Helm only)
  • 1.0.0
  • 0.29.0
  • 0.28.1
  • 0.28.0
  • 0.27.0
  • 0.26.0
  • 0.25.3
  • 0.25.2
  • 0.25.1
  • 0.25.0
  • 0.24.0