Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Extension schema updates for HookContainer

Browse source 
* Updated the extension schema for the new hook system
* Fixed the lack of "services" from RestRoutes ObjectFactory specs,
  since RestRoutes and HookHandlers is supposed to be the same.

Bug: T240307
Change-Id: I1a8657ff9fd14618c6709dbab62c3b4ee9f659a5
This commit is contained in:
Tim Starling 2020-05-18 14:18:14 +10:00
parent 89ab2a1452
commit 7abd828ea3
1 changed files with 105 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

107
docs/extension.schema.v2.json
View file

@ -788,8 +788,107 @@
"type": "object"
},
"Hooks": {
"type": [ "string", "object" ],
"description": "Hooks this extension uses (mapping of hook name to callback)"
"type": "object",
"description": "Hooks this extension uses (mapping of hook name to callback)",
"additionalProperties": {
"oneOf": [
{
"type": "string",
"description": "A global function name, static function name, or the name of a property in HookHandlers"
},
{
"type": "object",
"description": "A handler specification",
"properties": {
"handler": {
"type": "string",
"description": "The name of a property in HookHandlers"
},
"deprecated": {
"type": "boolean",
"description": "The deprecation acknowledgement flag for the handler. If this is true, calls will be filtered if the relevant hook is deprecated."
}
},
"required": [
"handler"
]
},
{
"type": "array",
"description": "An ordered array of handlers",
"items": {
"oneOf": [
{
"type": "string",
"description": "A global function name, static function name, or the name of a property in HookHandlers"
},
{
"type": "object",
"description": "A handler specification",
"properties": {
"handler": {
"type": "string",
"description": "The name of a property in HookHandlers"
},
"deprecated": {
"type": "boolean",
"description": "The deprecation acknowledgement flag for the handler. If this is true, calls will be filtered if the relevant hook is deprecated."
}
},
"required": [
"handler"
]
}
]
}
}
]
}
},
"HookHandlers": {
"type": "object",
"description": "ObjectFactory specifications for new-style hook handlers",
"additionalProperties": {
"type": "object",
"properties": {
"factory": {
"type": ["string", "array"],
"description": "A factory function to be called to create the handler for this hook"
},
"class": {
"type": "string",
"description": "The fully-qualified class name of the handler. This should be omitted if a factory is specified."
},
"args": {
"type": "array",
"description": "The arguments passed to the handler constructor or factory"
},
"services": {
"type": "array",
"description": "If supplied and non-empty, the named services are requested from the service container and prepended before 'args'."
}
}
}
},
"DeprecatedHooks": {
"type": "object",
"description": "Hooks which are defined and deprecated by the extension",
"additionalProperties": {
"type": "object",
"properties": {
"deprecatedVersion": {
"type": "string",
"description": "The version in which the hook was deprecated"
},
"component": {
"type": "string",
"description" : "The component to which the deprecated version relates. If omitted, the extension name will be used."
}
},
"required": [
"deprecatedVersion"
]
}
},
"JobClasses": {
"type": "object",
@ -1017,6 +1116,10 @@
"args": {
"type": "array",
"description": "The arguments passed to the handler constructor or factory"
},
"services": {
"type": "array",
"description": "If supplied and non-empty, the named services are requested from the service container and prepended before 'args'."
}
}
}