wf-catalogue-service

Workflow and notebook catalogue service API.

Running locally

docker-compose up

API available at http://localhost:8000/api/v1.0. Swagger docs at http://localhost:8000/api/v1.0/docs.

API Endpoints

Endpoint	Description
GET /health	Health check
GET /collections	List catalogues
GET /collections/{id}	Get catalogue details
GET /collections/{id}/items	List records
GET /collections/{id}/items/{record_id}	Get record
POST /register	Register workflow/notebook
DELETE /register/{record_id}	Delete record

All endpoints are prefixed with /api/v1.0.

Getting started

Create the environment:

make env

Run pre-commit hooks:

make pc

Dev LOG

See the log of changes and experiment results. Best to view it via mkdocs serve command.

Guides

Read more here:

• Development env setup
• Contributing
• Makefile usage
• Running tests

Docs

To build project documentation run:

make docs

and then:

mkdocs serve