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

fixes, providerEndpoint -> providerUrl

Browse Source
This commit is contained in:
Matthias Kretschmann 2021-11-05 09:01:11 +00:00
parent e80a5fd093
commit 3cb0b63aa9
Signed by: m
GPG Key ID: 606EEEF3C479A91F
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -176,15 +176,15 @@ Services define the access for an asset, and each service is represented by its
An asset should have at least one service to be actually accessible, and can have as many services which make sense for a specific use case. An asset should have at least one service to be actually accessible, and can have as many services which make sense for a specific use case.
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| ---------------------- | --------------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | ---------------------- | --------------------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| **`type`** | `string` | **✓** | Type of service (`access`, `compute`, `wss`, etc. | | **`type`** | `string` | **✓** | Type of service (`access`, `compute`, `wss`, etc. |
| **`name`** | `string` | | Service friendly name | | **`name`** | `string` | | Service friendly name |
| **`description`** | `string` | | Service description | | **`description`** | `string` | | Service description |
| **`datatokenAddress`** | `string` | **✓** | Datatoken address | | **`datatokenAddress`** | `string` | **✓** | Datatoken address |
| **`providerEndpoint`** | `string` | **✓** | Provider endpoint URI (URI + path) | | **`providerUrl`** | `string` | **✓** | Provider URL (schema + host) |
| **`timeout`** | `number` | **✓** | Describing how long the service can be used after consumption is initiated. A timeout of 0 represents no time limit. Expressed in seconds. | | **`timeout`** | `number` | **✓** | Describing how long the service can be used after consumption is initiated. A timeout of `0` represents no time limit. Expressed in seconds. |
| **`privacy`** | [Privacy](#compute-privacy) | **✓** (for compute assets only) | If service is of `type` `compute`, holds information about the compute-related privacy settings. | | **`privacy`** | [Privacy](#compute-privacy) | **✓** (for compute assets only) | If service is of `type` `compute`, holds information about the compute-related privacy settings. |
#### Compute Privacy #### Compute Privacy
@ -193,7 +193,7 @@ An asset with a service of `type` `compute` has the following additional attribu
| Attribute | Type | Required | Description | | Attribute | Type | Required | Description |
| ------------------------------------------ | ------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------------------ | ------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`allowRawAlgorithm`** | `boolean` | **✓** | If `true`, any passed raw text will be allowed to run. Useful for an algorithm drag & drop use case, but increases risk of data escape through malicious user input. Should be `false` by default in all implementations. | | **`allowRawAlgorithm`** | `boolean` | **✓** | If `true`, any passed raw text will be allowed to run. Useful for an algorithm drag & drop use case, but increases risk of data escape through malicious user input. Should be `false` by default in all implementations. |
| **`allowNetworkAccess`** | `boolean` | **✓** | If `true`, the algorithm job will have network access (still WIP) | | **`allowNetworkAccess`** | `boolean` | **✓** | If `true`, the algorithm job will have network access. |
| **`publisherTrustedAlgorithmPublishers `** | Array of `string` | **✓** | If empty, then any published algorithm is allowed. Otherwise, only published algorithms by some publishers are allowed | | **`publisherTrustedAlgorithmPublishers `** | Array of `string` | **✓** | If empty, then any published algorithm is allowed. Otherwise, only published algorithms by some publishers are allowed |
| **`publisherTrustedAlgorithms `** | Array of `publisherTrustedAlgorithms` | **✓** | If empty, then any published algorithm is allowed. (see below) | | **`publisherTrustedAlgorithms `** | Array of `publisherTrustedAlgorithms` | **✓** | If empty, then any published algorithm is allowed. (see below) |
@ -230,7 +230,7 @@ Example:
"name": "Download service", "name": "Download service",
"description": "Download service", "description": "Download service",
"datatokenAddress": "0x123", "datatokenAddress": "0x123",
"providerEndpoint": "https://myprovider", "providerUrl": "https://myprovider.com",
"timeout": 0 "timeout": 0
}, },
{ {
@ -238,7 +238,7 @@ Example:
"name": "Compute service", "name": "Compute service",
"description": "Compute service", "description": "Compute service",
"datatokenAddress": "0x124", "datatokenAddress": "0x124",
"providerEndpoint": "https://myprovider", "providerUrl": "https://myprovider.com",
"timeout": 0, "timeout": 0,
"privacy": { "privacy": {
"allowRawAlgorithm": false, "allowRawAlgorithm": false,
@ -466,7 +466,7 @@ Example:
"name": "Download service", "name": "Download service",
"description": "Download service", "description": "Download service",
"datatokenAddress": "0x123", "datatokenAddress": "0x123",
"providerEndpoint": "https://myprovider.com", "providerUrl": "https://myprovider.com",
"timeout": 0 "timeout": 0
} }
], ],