nmathar / opsi-api-wrapper Goto Github PK

Add Example Code to jsdoc comments with asycn examples

echo '{ "method": "getProductStates_hash", "params": ["testclient.opsi.lan", ""], "id": 1 }'

• List all Products with state for client

• List product properties for product

• change product properties

• update state for product

• install product for client

• reset product state

• show error for product if install failed

• list product dependencies

if all function working i think of a refactoring by a typescript async version

better hardware info method "getHardwareInformation_hash"

more infos for all client array

add parentGroupId to object you get an uncatched error. I think the error catch should be result.error.message

{
  "id": 1,
  "result": null,
  "error": {
    "message": "Not a <class 'OPSI.Object.Group'>: '{u'description': u'this is a test', u'notes': u'huhu', u'parentGroupId': u'', u'type': u'HostGroup', u'id': u'test'}': Bad object id: ''",
    "class": "ValueError"
  }
}

• Create interfaces

• add interfaces to functions (updateGroup, updateClient)

Client

{ ident: 'client01.opsi.lan',
description: 'Description',
created: '2019-02-19 18:11:10',
inventoryNumber: '',
ipAddress: null,
notes: '',
oneTimePassword: null,
lastSeen: '2019-02-19 18:11:10',
hardwareAddress: null,
opsiHostKey: 'c748d0b0d2015dfda0306dc0a862a612',
type: 'OpsiClient',
id: 'client01.opsi.lan' }

Group

{ ident: 'group01',
description: 'Group description',
notes: '',
parentGroupId: null,
type: 'HostGroup',
id: 'group01' }

Move with this tool https://www.npmjs.com/package/vuepress-jsdoc to Vuepress

some test functions are not called