Skip to content

Commit

Permalink
Update URL for SCHEMA.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GermanBluefox committed Dec 30, 2023
1 parent b418dc3 commit 2804f0f
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 14 deletions.
27 changes: 14 additions & 13 deletions docs/en/dev/adapterjsonconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,27 +117,28 @@ Possible types:
```

- `objectId` - object ID: show it with name, color and icon
- `types` - Desired type: `channel`, `device`, ... (has only `state` by default). It is singular, because `type` is already occupied.
- `types` - Desired type: `channel`, `device`, ... (has only `state` by default). It is plural, because `type` is already occupied.
- `root` - [optional] Show only this root object and its children
- `customFilter` - [optional] Cannot be used together with `type` settings. Examples
`{common: {custom: true}}` - show only objects with some custom settings
`{common: {custom: 'sql.0'}}` - show only objects with sql.0 custom settings (only of the specific instance)
`{common: {custom: '_dataSources'}}` - show only objects of adapters `influxdb` or `sql` or `history`
`{common: {custom: 'adapterName.'}}` - show only objects of custom settings of specific adapter (all instances)
`{type: 'channel'}` - show only channels
`{type: ['channel', 'device']}` - show only channels and devices
`{common: {type: 'number'}` - show only states of type 'number
`{common: {type: ['number', 'string']}` - show only states of type 'number and string
`{common: {role: 'switch']}` - show only states with roles starting from switch
`{common: {role: ['switch', 'button]}` - show only states with roles starting from `switch` and `button`
- `customFilter` - [optional] Cannot be used together with `type` settings. It is an object and not a JSON string. Examples
- `{common: {custom: true}}` - show only objects with some custom settings
- `{common: {custom: 'sql.0'}}` - show only objects with sql.0 custom settings (only of the specific instance)
- `{common: {custom: '_dataSources'}}` - show only objects of adapters `influxdb` or `sql` or `history`
- `{common: {custom: 'adapterName.'}}` - show only objects of custom settings of specific adapter (all instances)
- `{type: 'channel'}` - show only channels
- `{type: ['channel', 'device']}` - show only channels and devices
- `{common: {type: 'number'}` - show only states of type 'number
- `{common: {type: ['number', 'string']}` - show only states of type 'number and string
- `{common: {role: 'switch']}` - show only states with roles starting from switch
- `{common: {role: ['switch', 'button]}` - show only states with roles starting from `switch` and `button`
- `filterFunc` - [optional] Cannot be used together with `type` settings. It is a function that will be called for every object and must return true or false. Example: `obj.common.type === 'number'`

- `password` - password field
This field-type just have an effect in the UI.
Passwords and other sensitive data should be stored encrypted!
To do this, the key must be provided in the io-package.json under [nativeEncrypted](https://github.com/ioBroker/ioBroker.js-controller#automatically-encryptdecrypt-configuration-fields).
Additionally, you can protect this property from being served to other adapters but `admin` and `cloud` by adding it to `protectedNative` in `io-package.json` file.
- `repeat` - repeat password must be compared with password
- `visible` - true if allow viewing the password by toggling the view button
- `visible` - true if allow viewing the password by toggling the view button (only for a new password while entering)
- `maxLength` - max length of the text in field

- `instance`
Expand Down
2 changes: 1 addition & 1 deletion engine/gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,7 @@ gulp.task('2.downloadAdapters', () =>
console.log(JSON.stringify(content))));

gulp.task('3.downloadJsonConfig', () =>
axios('https://raw.githubusercontent.com/ioBroker/ioBroker.admin/master/src/src/components/JsonConfigComponent/SCHEMA.md')
axios('https://raw.githubusercontent.com/ioBroker/ioBroker.admin/master/packages/jsonConfig/SCHEMA.md')
.then(result => fs.writeFileSync(path.join(consts.SRC_DOC_DIR, 'en/dev/adapterjsonconfig.md'), result.data)));


Expand Down

0 comments on commit 2804f0f

Please sign in to comment.