sim4life.io - WP6: API

[mguidon]

Description

At sim4life.io, we recognize the importance of providing a comprehensive API that is both flexible and user-friendly. As part of this commitment, we have ensured that our API supports a wide range of features:

• Files: upload/download/delete
• Solvers: start/stop/delete jobs, streaming of job progress
• Studies: create/modify/delete/run
• Users: personal preferences, remaining simulation hours

Via API, users will also be able to define the hardware on which their services run.

### This is Sparta!
- [ ] https://github.com/ITISFoundation/osparc-simcore/issues/5236
- [ ] https://github.com/ITISFoundation/osparc-issues/issues/1255

### Kobayashi Maru
- [ ] https://github.com/ITISFoundation/osparc-simcore/issues/4604

### Microhistory
- [ ] https://github.com/ITISFoundation/osparc-simcore/issues/4768
- [ ] https://github.com/ITISFoundation/osparc-simcore-clients/issues/50
- [ ] https://github.com/ITISFoundation/osparc-simcore/issues/4153
- [ ] https://github.com/ITISFoundation/osparc-simcore/issues/4231
- [ ] https://github.com/ITISFoundation/osparc-simcore/issues/4234
- [ ] https://github.com/ITISFoundation/osparc-simcore/issues/4914
- [ ] https://github.com/ITISFoundation/osparc-simcore/issues/4652

## Quilmes
- [ ] https://github.com/ITISFoundation/osparc-simcore/issues/4641

### Baklava
- [ ] https://github.com/ITISFoundation/osparc-simcore/issues/4651

### Sundae
- [ ] https://github.com/ITISFoundation/osparc-simcore/issues/4110

### Watermelon
- [ ] https://github.com/ITISFoundation/osparc-simcore/issues/4111
- [ ] https://github.com/ITISFoundation/osparc-issues/issues/733
- [ ] https://github.com/ITISFoundation/osparc-simcore/issues/4345
- [ ] https://github.com/ITISFoundation/osparc-simcore/issues/4313
- [ ] https://github.com/ITISFoundation/osparc-simcore/issues/3626

[pcrespov]

Update for sprint Pastel de Nata

• Defined openapi specs for new API release:
  • ✨ defines openapi specs for new studies resources osparc-simcore#4250
• Implemented/fixed:
  • API: Timestamps are wrong osparc-simcore#4231
  • API: I would like to get hold of the solver log even if I stop a job osparc-simcore#4234
• Reviewed auto-generation of python-client (ongoing)

[pcrespov]

Update Watermelon

Improving API development& release workflow

Specification-based design starts in openapi specs (OAS) which acts as a contract. Both client and server are built to satisfy that contract. The OAS need to be backwards compatible. The core-part of the client is auto-generated.

The following is a list of actions which have been performed this sprint. Each action is a step towards achieving one/multiple bigger goals which are listed next to the actions.

action	goal
automate generation of python client	enable osparc team to develop and support new features fast support for clients from different languages
automatic testing client vs server	ensure quality (quickly detect bugs)
automatic testing of tutorials/documentation	ensure we have great, user-friendly documentation
add client support for new features on server	expose new functionality to users

Extending osparc public API

• Improved testing:
  • New backwards compatibility tests
  • New mocks of backend stack responses for fast testing
• These are the new/changed entrypoints

1. GET /v0/files/page
2. GET /v0/solvers/page
3. GET /v0/solvers/releases/page
4. GET /v0/solvers/{solver_key}/releases/page
5. GET /v0/solvers/{solver_key}/releases/{version}/ports
6. GET /v0/solvers/{solver_key}/releases/{version}/jobs/page
7. GET /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}/metadata
8. PUT /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}/metadata
9. GET /v0/studies/
10. GET /v0/studies/{study_id}
11. GET /v0/studies/{study_id}/ports
12. GET /v0/studies/{study_id}/jobs
13. POST /v0/studies/{study_id}/jobs
14. GET /v0/studies/{study_id}/jobs/{job_id}
15. DELETE /v0/studies/{study_id}/jobs/{job_id}
16. POST /v0/studies/{study_id}/jobs/{job_id}:start
17. POST /v0/studies/{study_id}/jobs/{job_id}:stop
18. POST /v0/studies/{study_id}/jobs/{job_id}:inspect
19. POST /v0/studies/{study_id}/jobs/{job_id}/outputs
20. POST /v0/studies/{study_id}/jobs/{job_id}/outputs/logfile
21. GET /v0/studies/{study_id}/jobs/{job_id}/metadata
22. PUT /v0/studies/{study_id}/jobs/{job_id}/metadata
23. DELETE /v0/files/{file_id}
24. DELETE /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}

See more details comparing swagger views for:

• current openapi.json
• new openapi-dev.json

Snapshot of progress and next steps

Goal

• full tutorial/s in python that demos all entrypoints above
• online doc

[elisabettai]

See more details comparing swagger views for:

current [openapi.json](https://editor.swagger.io/?url=https://raw.githubusercontent.com/pcrespov/sandbox-python/c1d3e4f7565a26461f510df8f333548cfa83e3ce/api/openapi.json)
new [openapi-dev.json](https://editor.swagger.io/?url=https://raw.githubusercontent.com/pcrespov/sandbox-python/c1d3e4f7565a26461f510df8f333548cfa83e3ce/api/openapi-dev.json)

@pcrespov, am I missing something or these two links above point to the same version of the API? I'm unable to see the diffs by eye in Swagger. 🙃