Changelog

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.

10.0.0

Major breaking changes to the calculate and weighting APIs to make them consistent and easier to use.

  • [BREAKING] /mid/calculate endpoint is now split into /mid/zoom/calculate and /mid/continuum/calculate

    • Response body of /mid/continuum/calculate returns a single object with the continuum and spectral sensitivities/integration times, plus subband results if applicable

    • Response body of /mid/zoom/calculate returns an array of continuum and spectral sensitivities/integration times for each zoom window

  • [BREAKING] /low/zoom/calculate now also returns an array of results (and likewise accepts an array of freq_centres_mhz)

  • [BREAKING] The calculator mode (continuum, zoom, pss) and the spectral mode (continuum or line/spectral) are now distinguished in the API.

  • [BREAKING] /mid/weighting endpoint is now split into /mid/continuum/weighting and /mid/zoom/weighting. Similar to calculate, an array is returned for zoom.

  • [BREAKING] /low/{spectral_mode}/weighting has been split into explicitly separate /low/zoom/weighting and /low/continuum/weighting with separate params (eg only subbands for continuum)

  • [BREAKING] Several parameters renamed to make consistent

    • Parameters have units appended, egsensitivity -> sensitivity_jy

    • Parameters that are arrays are plural, eg subband_sensitivities_jy

    • Variations of frequency changed to freq_centre_<unit>

    • Low duration changed to integration_time_h

    • el changed to elevation_limit

  • [BREAKING] Response bodies updated to use same field names, at the top level of the object (ie no more data and status fields for mid).

  • [BREAKING] Response quantities now are an object with value and unit, rather than a number with an implicit unit.