Skip to content

API routes for pipeline progress monitoring, production and job info

Ryunosuke O'Neil requested to merge roneil/api-routes-4 into master

New API routes are added:

  • /api/pipelines/jobs/<production_table_id>
    • Returns paginated list of jobs, or information about a single job (selected either by job table ID or job name). Needs a production table ID
    • job_id - int - (optional) specify a single job to fetch by ID
    • name - str - (optional) specify a single job to fetch by name
    • page - if requesting many jobs, request a "page" of jobs (default 1)
    • per_page - how many jobs to request per page (default 50)
  • /api/pipelines/progress (GET or POST) (thanks @cburr for writing the query!)
    • Returns production test job statuses for production test progress monitoring
    • POST:
      • pipeline_ids - a 1-D array of ints (pipeline IDs) to filter by
      • production_ids - a 1-D array of ints (production table IDs) to filter by
    • GET
      • pipeline_id - filter by single pipeline ID
      • production_id - filter by single production table ID
  • /api/pipelines/<pipeline_id>/<production_name> (GET)
    • basic production test summary info.
    • returns a production table ID which can be used to query the API for jobs
    • no GET query parameters needed

Existing API routes:

  • /api/pipelines - returns a pipeline -> productions mapping. now includes the production ID in the output

Relates to lhcb-dpa/project#139

Edited by Ryunosuke O'Neil

Merge request reports