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

update swagger specs

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
data/brizo.json
View File

@ -65,10 +65,10 @@
], ],
"responses":{ "responses":{
"201":{ "201":{
"description":"Service agreement initialize successfully." "description":"Service agreement successfully initialized."
}, },
"400":{ "400":{
"description":"One of the required attributes is missed." "description":"One of the required attributes is missing."
}, },
"404":{ "404":{
"description":"Invalid signature." "description":"Invalid signature."
@ -77,7 +77,7 @@
"description":"Error" "description":"Error"
} }
}, },
"summary":"Initialize the SLA between the puvblisher and the consumer.", "summary":"Initialize the SLA between the publisher and the consumer.",
"tags":[ "tags":[
"services" "services"
] ]
@ -88,7 +88,7 @@
"consumes":[ "consumes":[
"application/json" "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":[ "parameters":[
{ {
"description":"Asset metadata.", "description":"Asset metadata.",
@ -103,27 +103,27 @@
"type":"string" "type":"string"
}, },
"asset_did":{ "asset_did":{
"description":"Identifier of the asset registered in ocean", "description":"Identifier of the asset registered in Ocean",
"example":"0x0234242345", "example":"0x0234242345",
"type":"string" "type":"string"
}, },
"consumer_wallet":{ "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", "example":"0x0234242345",
"type":"string" "type":"string"
}, },
"cpu":{ "cpu":{
"description":"Number of cpus to execute the algorithm.", "description":"Number of CPUs to execute the algorithm.",
"example":1, "example":1,
"type":"integer" "type":"integer"
}, },
"docker_image":{ "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", "example":"python:3.6-alpine",
"type":"string" "type":"string"
}, },
"memory":{ "memory":{
"description":"Ammout of memory in Gb to run the algorithm", "description":"Ammout of memory in GB to run the algorithm",
"example":1.5, "example":1.5,
"type":"number" "type":"number"
} }
@ -140,7 +140,7 @@
"responses":{ "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":[ "tags":[
"services" "services"
] ]
@ -161,14 +161,14 @@
"type":"string" "type":"string"
}, },
{ {
"description":"The service agreement id.", "description":"The ID of the service agreement.",
"in":"query", "in":"query",
"name":"serviceAgreementId", "name":"serviceAgreementId",
"required":true, "required":true,
"type":"string" "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", "in":"query",
"name":"url", "name":"url",
"required":true, "required":true,
@ -180,7 +180,7 @@
"description":"Redirect to valid asset url." "description":"Redirect to valid asset url."
}, },
"400":{ "400":{
"description":"One of the required attributes is missed." "description":"One of the required attributes is missing."
}, },
"404":{ "404":{
"description":"Invalid asset data." "description":"Invalid asset data."