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

replace userInput with customParameters

Browse Source
This commit is contained in:
Alex Coseru 2022-02-13 10:43:56 +02:00 committed by GitHub
parent b520355324
commit 0f0993df8f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -132,7 +132,7 @@ An asset of type `algorithm` has additional attributes under `metadata.algorithm
| --------------- | --------------------------- | -------- | ------------------------------------------------------------------------------------------ | | --------------- | --------------------------- | -------- | ------------------------------------------------------------------------------------------ |
| **`language`** | `string` | | Language used to implement the software. | | **`language`** | `string` | | Language used to implement the software. |
| **`version`** | `string` | | Version of the software preferably in [SemVer](https://semver.org) notation. E.g. `1.0.0`. | | **`version`** | `string` | | Version of the software preferably in [SemVer](https://semver.org) notation. E.g. `1.0.0`. |
| **`userInput`** | [User Input](#user-input) | | An object the defines required user input before running the algorithm | | **`consumerParameters`** | [Consumer Parameters](#consumer-parameters) | | An object the defines required consumer input before running the algorithm |
| **`container`** | `container` | **✓** | Object describing the Docker container image. See below | | **`container`** | `container` | **✓** | Object describing the Docker container image. See below |
The `container` object has the following attributes defining the Docker image for running the algorithm: The `container` object has the following attributes defining the Docker image for running the algorithm:
@ -163,7 +163,7 @@ The `container` object has the following attributes defining the Docker image fo
"tag": "latest", "tag": "latest",
"checksum": "44e10daa6637893f4276bb8d7301eb35306ece50f61ca34dcab550" "checksum": "44e10daa6637893f4276bb8d7301eb35306ece50f61ca34dcab550"
}, },
"userInput":{}, "consumerParameters":{},
} }
} }
} }
@ -186,7 +186,7 @@ An asset should have at least one service to be actually accessible, and can hav
| **`files`** | [Files](#files) | **✓** | Encrypted file URLs. | | **`files`** | [Files](#files) | **✓** | Encrypted file URLs. |
| **`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. |
| **`compute`** | [Compute](#compute-options) | **✓** (for compute assets only) | If service is of `type` `compute`, holds information about the compute-related privacy settings & resources. | | **`compute`** | [Compute](#compute-options) | **✓** (for compute assets only) | If service is of `type` `compute`, holds information about the compute-related privacy settings & resources. |
| **`userInput`** | [User Input](#user-input) | | An object the defines required user input before consuming the asset| | **`consumerParameters`** | [Consumer Parameters](#consumer-parameters) | | An object the defines required consumer input before consuming the asset|
#### Files #### Files
@ -373,7 +373,7 @@ Example:
} }
``` ```
#### User Input #### Consumer Parameters
Sometimes, you may need some input before consuming a dataset or running an algorithm. Sometimes, you may need some input before consuming a dataset or running an algorithm.
Examples: Examples:
@ -401,7 +401,7 @@ where:
- name = defines the parameter name (this is sent as HTTP param or key towards algo) - name = defines the parameter name (this is sent as HTTP param or key towards algo)
- type = defines the form type (text, number, select, boolean) - type = defines the form type (text, number, select, boolean)
- label = defines the label which is displayed - label = defines the label which is displayed
- required = if this field is mandatory to have a user input. - required = if this field is mandatory to have a consumer input.
- default = default value - default = default value
- description = description of this element - description = description of this element
- options = for select types, a list of options - options = for select types, a list of options
@ -706,7 +706,7 @@ Example:
"datatokenAddress": "0x123", "datatokenAddress": "0x123",
"serviceEndpoint": "https://myprovider.com", "serviceEndpoint": "https://myprovider.com",
"timeout": 0, "timeout": 0,
"userInput": [ "consumerParameters": [
{ {
"name":"surname", "name":"surname",
"type": "text", "type": "text",