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

Merge pull request #837 from oceanprotocol/feature/v4_multiple_storage

Browse Source 
Multiple storage types
This commit is contained in:
Alex Coseru 2021-12-07 15:30:07 +02:00 committed by GitHub
commit 70aa72a707
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 76 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
content/concepts/did-ddo.md
View File

@ -196,21 +196,94 @@ Example:
} }
``` ```
During the publish process, file URLs must be encrypted with a respective _Provider_ API call before storing the DDO on-chain. For this an array of strings with one or multiple URLs is what gets encrypted and send to _Provider_: During the publish process, file URLs must be encrypted with a respective _Provider_ API call before storing the DDO on-chain. For this an array of objects defining the storage access details are sent.
Type of objects supported :
<table>
<tr>
<th>Type</th>
<th>Description</th>
<th>Example</th>
</tr>
<td>'url'</td>
<td>Static URL. Contains url and HTTP method</td>
<td>
```json ```json
["https://url.com/file1.csv", "https://url.com/file2.csv"] [
{
"type": "url",
"url": "https://url.com/file1.csv",
"method": "GET"
}
]
``` ```
To get information about the files after encryption, the `/fileinfo` endpoint of _Provider_ returns based on a passed DID an array of file metadata: </td>
</tr></table>
First class integrations supported in the future :
<table>
<tr>
<th>Type</th>
<th>Description</th>
<th>Example</th>
</tr>
<tr>
<td>"ipfs"</td><td>IPFS files</td>
<td>
```json
[
{
"type":"ipfs",
"hash": "XXX"
}
]
```
</td>
<tr><td>"filecoin"</td><td>Filecoin storage</td><td>&nbsp;</td></tr>
<tr><td>"arwave"</td><td>Arwave</td><td>&nbsp;</td></tr>
<tr><td>"storj"</td><td>Storj</td><td>&nbsp;</td></tr>
<tr><td>"sql"</td><td>Sql connection, dataset is generated by a query</td><td>&nbsp;</td></tr>
</table>
A service can contain multiple files, using multiple storage types.
Example:
```json
[
{
"type": "url",
"url": "https://url.com/file1.csv",
"method": "GET"
},
{
"type": "ipfs",
"hash": "XXXX"
}
]
```
To get information about the files after encryption, the `/fileinfo` endpoint of _Provider_ returns based on a passed DID an array of file metadata (based on the file type):
```json ```json
[ [
{ {
"type": "url",
"contentLength": 100, "contentLength": 100,
"contentType": "application/json" "contentType": "application/json"
}, },
{ {
"type": "ipfs",
"contentLength": 130, "contentLength": 130,
"contentType": "application/text" "contentType": "application/text"
} }