search

collab-uniba / pynblint

Pynblint is a linter for Python Jupyter notebooks.
MIT License
40 stars 2 forks source link

[API] Describe available lint resources #34

Closed louieQ closed 3 years ago

louieQ commented 3 years ago

As a user of the pynblint REST API, I want to be able to see the list of linters that I can invoke.

Example call:

curl -X GET http://pynblint.io/api/linters

Example body response:

{
    "data": [
        {
            "id": "nb-linter",
            "description": "Lints Python Jupyter notebooks, one at a time."
        },
        {
            "id": "repo-linter",
            "description": "Lints all Jupyter notebooks in a Python project."
        }
    ]
}