1
0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-26 19:49:26 +01:00

update swagger specs

This commit is contained in:
Matthias Kretschmann 2018-11-30 17:35:59 +01:00
parent b0852d2754
commit 8f3c109602
Signed by: m
GPG Key ID: 606EEEF3C479A91F
2 changed files with 695 additions and 695 deletions

@ -65,10 +65,10 @@
],
"responses":{
"201":{
"description":"Service agreement initialize successfully."
"description":"Service agreement successfully initialized."
},
"400":{
"description":"One of the required attributes is missed."
"description":"One of the required attributes is missing."
},
"404":{
"description":"Invalid signature."
@ -77,7 +77,7 @@
"description":"Error"
}
},
"summary":"Initialize the SLA between the puvblisher and the consumer.",
"summary":"Initialize the SLA between the publisher and the consumer.",
"tags":[
"services"
]
@ -88,7 +88,7 @@
"consumes":[
"application/json"
],
"description":"<br/><br/>If the publisher of the assets<br/>provide this service in the Service agreement related with the asset_did requested.<br/>",
"description":"",
"parameters":[
{
"description":"Asset metadata.",
@ -103,27 +103,27 @@
"type":"string"
},
"asset_did":{
"description":"Identifier of the asset registered in ocean",
"description":"Identifier of the asset registered in Ocean",
"example":"0x0234242345",
"type":"string"
},
"consumer_wallet":{
"description":"Address of the wallet of the consumer of the asset. Ex. data-science...",
"description":"Address of the wallet of the asset consumer. Ex. data-science...",
"example":"0x0234242345",
"type":"string"
},
"cpu":{
"description":"Number of cpus to execute the algorithm.",
"description":"Number of CPUs to execute the algorithm.",
"example":1,
"type":"integer"
},
"docker_image":{
"description":"Docker image where the algorithm is going to be executed. It must include all the libraries needs to run it.",
"description":"Docker image where the algorithm is going to be executed. Docker image must include all the libraries needed to run it.",
"example":"python:3.6-alpine",
"type":"string"
},
"memory":{
"description":"Ammout of memory in Gb to run the algorithm",
"description":"Ammout of memory in GB to run the algorithm",
"example":1.5,
"type":"number"
}
@ -140,7 +140,7 @@
"responses":{
},
"summary":"Allows to execute an algorithm inside in a docker instance in the cloud aquarius.",
"summary":"Allows to execute an algorithm inside a Docker instance in the cloud. Requires the publisher of the assets to provide this service in the service agreement related with the requested `asset_did`.",
"tags":[
"services"
]
@ -161,14 +161,14 @@
"type":"string"
},
{
"description":"The service agreement id.",
"description":"The ID of the service agreement.",
"in":"query",
"name":"serviceAgreementId",
"required":true,
"type":"string"
},
{
"description":"This URL is only valid if BRIZO acts as a proxy. Consumer can't download using the URL if it's not through Brizo.",
"description":"This URL is only valid if Brizo acts as a proxy. Consumer can't download using the URL if it's not through Brizo.",
"in":"query",
"name":"url",
"required":true,
@ -180,7 +180,7 @@
"description":"Redirect to valid asset url."
},
"400":{
"description":"One of the required attributes is missed."
"description":"One of the required attributes is missing."
},
"404":{
"description":"Invalid asset data."