Skip to content

availability

Bob Weigel edited this page Jul 16, 2026 · 5 revisions

See also https://github.com/hapi-server/data-specification/wiki/file-listings

Recommended dataset naming is to end it with "DATASET/filelist", e.g., "MyDataset/filelist" (not "filelist/MyDataset"), and also add "x_parameterSchema="filelist" in the info response.

We start with a base class which is just a "Listing of Times":

  • time isotime

"Availability" required elements:

  • startDate - start date/time of coverage (isotime, required)
  • stopDate - (isotime) stop date/time of coverage; exclusive (like HAPI request end times)

Optional and recommended elements:

  • fractionalCoverage (double) discretion of provider to define. Explain in docs how this info will be used.

We need a few examples:

  1. Burst mode, start/stop bounds when instrument on. (fractionalCoverage always 100%)
  2. start/stop always fixed length. (fractionalCoverage is what provider wants to tell user about how good interval is)

For future discussion

  • numberValidRecords (int) count of the records in the interval where there is at least one non-FILL value in the record; this is easy an unambiguous to compute on the server side; the interpretation by clients is harder, esp. for non-uniform cadence (clients want to know - is this interval good or not)
  • numberOfRecords (int) - the number of records (valid data or FILL values) that are present within the startDate and stopDate
  • estimatedFractionOfIntervalFilledWithValidRecords - easy to use for clients, but hard to know how to uniformly implement on servers
  • version (str)
  • PARAMETER_NAME/numberValidRecords ???

Clone this wiki locally