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

GITBOOK-610: Minor changes in the storage specifications page

Browse Source
This commit is contained in:
Ana Loznianu 2023-06-26 09:38:46 +00:00 committed by gitbook-bot
parent a2c03b8868
commit 5e496bb34d
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
1 changed files with 33 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
developers/storage.md
View File

@ -25,9 +25,9 @@ The remainder of this document specifies the different types of storage objects
Parameters: Parameters:
* `url` - File url, required * `url` - File _URL_, **required**
* `method` - The HTTP method, required * `method` - The HTTP _method_, **required**
* `headers` - Additional HTTP headers, optional * `headers` - Additional HTTP _headers_, **optional**
```json ```json
{ {
@ -50,14 +50,13 @@ The [Interplanetary File System](https://ipfs.tech/) (IPFS) is a distributed fil
Parameters: Parameters:
* `hash` - The file hash * `hash` - The file _hash,_ **required**
```json <pre class="language-json"><code class="lang-json">{
{ <strong> "type": "ipfs",
"type": "ipfs", </strong> "hash": "XXX"
"hash": "XXX"
} }
``` </code></pre>
## GraphQL ## GraphQL
@ -67,9 +66,9 @@ Parameters:
Parameters: Parameters:
* `url` - Server endpoint url, required * `url` - Server endpoint _URL_, **required**
* `query` - The query to be executed, required * `query` - The _query_ to be executed, **required**
* `headers` - Additional HTTP headers, optional * `headers` - Additional HTTP headers, **optional**
```json ```json
{ {
@ -95,17 +94,17 @@ Use a smart contract as data source.
Parameters: Parameters:
* `chainId` - The chainId used to query the contract, required * `chainId` - The _chainId_ used to query the contract, **required**
* `address` - The smartcontract address, required * `address` - The smartcontract _address_, **required**
* `abi` - The function abi (NOT the entire contract abi), required * `abi` - The function _abi_ (NOT the entire contract abi), **required**
{% code overflow="wrap" %} {% code overflow="wrap" %}
```json ```json
{ {
"type": "smartcontract", "type": "smartcontract",
"chainId": 1, "chainId": 1,
"address": "0x8149276f275EEFAc110D74AFE8AFECEaeC7d1593", "address": "0x8149276f275EEFAc110D74AFE8AFECEaeC7d1593",
"abi": { "abi": {
"inputs": [], "inputs": [],
"name": "swapOceanFee", "name": "swapOceanFee",
"outputs": [{"internalType": "uint256", "name": "", "type": "uint256"}], "outputs": [{"internalType": "uint256", "name": "", "type": "uint256"}],
@ -118,22 +117,20 @@ Parameters:
## Arweave ## Arweave
[Arweave](https://www.arweave.org/) is a decentralized data storage that allows to permanently store files over a distributed network of computers. [Arweave](https://www.arweave.org/) is a decentralized data storage that allows permanently storing files over a distributed network of computers.
Parameters: Parameters:
* `transactionId` - The transaction identifier * `transactionId` - The _transaction identifier,_ **required**
```json ```json
{ {
{
"type": "arweave", "type": "arweave",
"transactionId": "a4qJoQZa1poIv5guEzkfgZYSAD0uYm7Vw4zm_tCswVQ", "transactionId": "a4qJoQZa1poIv5guEzkfgZYSAD0uYm7Vw4zm_tCswVQ",
}
} }
``` ```
First class integrations supported in the future : **`Filecoin`** **`Storj`** **`SQL`** First-class integrations supported in the future : **`Filecoin`** **`Storj`** **`SQL`**
A service can contain multiple files, using multiple storage types. A service can contain multiple files, using multiple storage types.
@ -157,7 +154,7 @@ Example:
} }
``` ```
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): To get information about the files after encryption, the `/fileinfo` endpoint of the [_Provider_](provider/) returns based on a passed DID an array of file metadata (based on the file type):
```json ```json
[ [