API: Create Projects with Associated Data (Feb.)

[elisabettai]

Description

Extend public API to create projects with associated data in the application workspace (particularly valuable for Studies with a single Service)

Deliverable

Extended API functionality, along with documentation

Acceptance criteria:
API functionality that permits to perform the above listed functions

Deadline

Y8Q2 (Feb.)

Wrike link (account/access required)

---

The Awakening

• Script-Driven-Development: Implement use case using python osparc client to drive development

Singularity

• Refactor web-server projects module

Tasks

• Implement use case using python osparc client to drive development
• api: create study with one service (limit)
• api: add file to node's state. Implement as move file resource to study
• Refactor webserver projects: job-to-project table
• Refactor webserver-api-server comms using rpc
• api: connect services?

[bisgaard-itis]

Here's a summary of a discussion me and @pcrespov had about this issue:
The key issue to determine is how much functionality must be exposed in the api server in order to have a valuable framework while keeping the api as minimal as possible. In a first implementation we have decided to go for an approach where we utilize the concept of templates which we have in the following way:

• Rather than creating a project "piece by piece" via the api-server the user can clone template projects/studies with a desired structure. E.g. a template could be template study with a single service node inside.
• In order to place the associated data into the newly created project we will add the following endpoint to the api-server

POST /studies/{study_id}/file/{file_id}:move

whose body is

{
  relative_destination_dir: string
}

(potentially this could be a subresource of the files section of the api instead of the study section). As is, this endpoint assumes the project only holds a single node and the api-server will be responsible for figuring out what's the id of that node.

One advantage of using the template approach is that it doesn't open the door for the user to create arbitrary projects. Moreover, with a very general API it will be hard for the user to create a meaningful study/project with e.g. a complicated workbench.