Implement new release_version REST API / method to support versioning of the BIDS and collab project datasets

[sebastientourbier]

To support versioning of the BIDS and collab project datasets, the release_version REST API method need to be implemented.

Input

• JSON-formatted data containing the following specified attributes:
• "dataset": Absolute path to the Datalad-managed BIDS / Collab project dataset
• "release_type": can be "patch" (for 1.0.0 -> 1.0.1), "minor" (for 1.0.1 -> 1.1.0), and "major" (for 1.1.0 -> 2.0.0).
• "changes": array of string describing each change.

Output

• JSON-formatted data containing the dataset summary of the dataset for which the version release was made or an error message.

Description

Make a new version release of (1) a BIDS dataset of the public space and the private space of the user, and (2) the project dataset of the collab space of the HIP.

This should perform the following steps depicted in the diagram below:

• Make the version release of the BIDS / collab project dataset with dataset.release_version command of DataHIPy.
• Get a summary of the published dataset in JSON format with dataset.get command of DataHIPy.
• Index the published dataset to ELK public space index by using the generated summary.
• Return the dataset summary as JSON object.

Process diagram for the release_version method called by the REST API

flowchart TB
    in0(["input_data"])
    p1["Make version release via call to DataHIPy"]
    p2["Get JSON dataset summary via call to DataHIPy"]
    p3["Re-index the dataset to ELK public space index"]
    out0(["output_file"])
    err0(["error"])
    subgraph "input"
    in0
    end
    in0-->p1
    subgraph "`release_version()`"
    p1-->p2-->p3
    end
    subgraph "output"
    p3-->out0
    p1-->err0
    end

Loading