Skip to content

lsst-sqre/sqre-uservice-nbreport

Repository files navigation

Build Status

sqre-uservice-nbreport

Service for LSST's notebook-based reports, hosted through api.lsst.codes. See SQR-023: Design of the notebook-based report system for background and https://nbreport.lsst.io for the client-side application.

Endpoints

  • GET /: returns OK (used by Google Container Engine Ingress healthcheck)

  • GET /nbreport/metadata: service metadata.

  • POST /nbreports/: register a new report.

  • POST /reports/<report>/instances/: reserve a new report instance.

  • POST /reports/<report>/instances/<instance_id>/notebook: upload a notebook file (.ipynb) for publication.