1
0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-01 15:55:34 +01:00

Merge pull request #1173 from oceanprotocol/feature/improve_files_object_description

Improve files object description
This commit is contained in:
mihaisc 2023-03-24 09:47:17 +02:00 committed by GitHub
commit 4a5f4fc70a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -226,9 +226,9 @@ where "files" contains one or more storage objects.
Static URLs. Static URLs.
Parameters: Parameters:
* `url` - File url * `url` - File url, required
* `method` - The HTTP method * `method` - The HTTP method, required
* `headers` - Additional HTTP headers * `headers` - Additional HTTP headers, optional
``` ```
{ {
@ -236,10 +236,10 @@ Parameters:
"url": "https://url.com/file1.csv", "url": "https://url.com/file1.csv",
"method": "GET", "method": "GET",
"headers": "headers":
[ {
{"Authorization": "Bearer 123"}, "Authorization": "Bearer 123",
{"APIKEY": "124"}, "APIKEY": "124",
] }
} }
``` ```
@ -262,13 +262,18 @@ Parameters:
[GraphQL](https://graphql.org/) is a query language for APIs and a runtime for fulfilling those queries with your existing data. [GraphQL](https://graphql.org/) is a query language for APIs and a runtime for fulfilling those queries with your existing data.
Parameters: Parameters:
* `url` - Server endpoint url * `url` - Server endpoint url, required
* `query` - The query to be executed * `query` - The query to be executed, required
* `headers` - Additional HTTP headers, optional
``` ```
{ {
"type": "graphql", "type": "graphql",
"url": "http://172.15.0.15:8000/subgraphs/name/oceanprotocol/ocean-subgraph", "url": "http://172.15.0.15:8000/subgraphs/name/oceanprotocol/ocean-subgraph",
"headers":{
"Authorization": "Bearer 123",
"APIKEY": "124",
},
"query": """query{ "query": """query{
nfts(orderBy: createdTimestamp,orderDirection:desc){ nfts(orderBy: createdTimestamp,orderDirection:desc){
id id
@ -285,9 +290,9 @@ Use a smart contract as data source.
Parameters: Parameters:
* `chainId` - The chainId used to query the contract * `chainId` - The chainId used to query the contract, required
* `address` - The smartcontract address * `address` - The smartcontract address, required
* `abi` - The function abi (NOT the entire contract abi) * `abi` - The function abi (NOT the entire contract abi), required
``` ```
{ {