Identify schema of the submission object

nlpsandbox / nlpsandbox-schemas

OpenAPI specifications of the NLP Sandbox services

https://nlpsandbox.io

Apache License 2.0

2 stars 4 forks source link

Identify schema of the submission object #36

Open tschaffter opened 3 years ago

tschaffter commented 3 years ago

Define a JSON object that includes all the information required for a submission.

Submission:

docker_repository
docker_digest

Submitted by (not part of the submission object):

submitter_id
submitter token

@thomasyu888 What else?

tschaffter commented 3 years ago

About Docker images: image needs to be public (any repository) or private image that has been share with one of our service user (image must be stored on Synapse).

thomasyu888 commented 3 years ago

Here are some that I can think of

description
features
references
created_on

Here is an example of what I came up with: https://github.com/Sage-Bionetworks/submission_service/blob/main/openapi_server/openapi/openapi.yaml#L446-L481

thomasyu888 commented 3 years ago

One of the nice things that Synapse does is that it caches the submission, so if the user decides to delete their docker repo after submission, it can still be ran.