Update data Schema
host_update.schema.json#/properties/update
All information related to the update process of a host (containing all authentication repositories linked to that host)
Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
---|---|---|---|---|---|---|---|
Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | host-update.schema.json* |
update Type
object
(Update data)
update Properties
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
changed | boolean |
Required | cannot be null | Host Handlers Input |
event | string |
Required | cannot be null | Host Handlers Input |
host_name | string |
Required | cannot be null | Host Handlers Input |
error_msg | string |
Required | cannot be null | Host Handlers Input |
auth_repos | array |
Required | cannot be null | Host Handlers Input |
custom | object |
Optional | cannot be null | Host Handlers Input |
changed
Indicates if at least one of the host's repositories was updated (will be false if pull was successful, but there were no new commits)
changed
-
is required
-
Type:
boolean
(Change Indicator) -
cannot be null
-
defined in: Host Handlers Input
changed Type
boolean
(Change Indicator)
event
Event type - succeeded, changed, unchanged, failed, completed
event
-
is required
-
Type:
string
(Update Event) -
cannot be null
-
defined in: Host Handlers Input
event Type
string
(Update Event)
host_name
Name of the host whose update was attempted
host_name
-
is required
-
Type:
string
(Name) -
cannot be null
-
defined in: Host Handlers Input
host_name Type
string
(Name)
error_msg
Error message that was raised while updating the host's repositories
error_msg
-
is required
-
Type:
string
(Error message) -
cannot be null
-
defined in: Host Handlers Input
error_msg Type
string
(Error message)
auth_repos
auth_repos
-
is required
-
Type:
object[]
(Repository Handlers Input) -
cannot be null
-
defined in: Host Handlers Input
auth_repos Type
object[]
(Repository Handlers Input)
custom
Additional host data. Not used by the framework
custom
-
is optional
-
Type:
object
(Custom) -
cannot be null
-
defined in: Host Handlers Input
custom Type
object
(Custom)