Liferay client-extension.yaml

Liferay Client Extension Definition File

Type object
File match client-extension.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/liferay-client-extension-yaml/latest.json
Source https://raw.githubusercontent.com/liferay/liferay-portal/master/modules/sdk/gradle-plugins-workspace/src/main/resources/schemas/client-extension.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

assemble gradleCopySchema[]

Declares one or more copy schema definitions for copying resources to the client extension payload. The keys are used to construct a Gradle Copy task. See https://docs.gradle.org/current/dsl/org.gradle.api.tasks.Copy.html.

Definitions

datatypes
uniqueStringArray string[]
uniqueItems=true
propertySets
batchJob object
1 nested properties
oAuthApplicationHeadlessServer string required
externalService object
3 nested properties
.serviceAddress string required
.serviceScheme string required
scopes string[] required
uniqueItems=true
url object
1 nested properties
url string required
webHook object
2 nested properties
oAuth2ApplicationExternalReferenceCode string required
resourcePath string required
schemas
gradleCopySchema object
4 nested properties
from string

The source directory to copy from. If none is provided, the yaml file's directory is used. Mutually exclusive with 'fromTask'.

fromTask string

The name of a Gradle task. The outputs of the declared task will be copied. Mutually exclusive with 'from'.

include string[]
uniqueItems=true
into string

The destination directory inside the project's build directory. If none is provided, it it will go to the build directory root.

types
batch

Description for batch

All of: batchJob object
customElement

Description for customElement

All of: object object
editorConfigContributor

Description for editorConfigContributor

All of: url object
fdsCellRenderer

Description for fdsCellRenderer

All of: url object
fdsFilter

Description for fdsFilter

All of: url object
globalCSS

Description for globalCSS

All of: url object, variant
globalJS

Description for globalJS

All of: url object, object object
iframe

Description for iframe

All of: url object, object object
instanceSettings Latest Client Extension Type Instance Settings.schema

Description for instanceSettings

jsImportMapsEntry

Description for jsImportMapsEntry

All of: url object, object object
notificationType

Description for notificationType

All of: webHook object
oAuthApplicationHeadlessServer

Description for oAuthApplicationHeadlessServer

All of: externalService object
oAuthApplicationUserAgent

Description for oAuthApplicationUserAgent

All of: externalService object
objectAction

Description for objectAction

All of: webHook object
objectEntryManager

Description for objectEntryManager

All of: webHook object
objectValidationRule

Description for objectValidationRule

All of: webHook object, object object
siteInitializer

Description for siteInitializer

All of: batchJob object, object object
staticContent

Description for staticContent

themeCSS

Description for themeCSS

All of: object object
themeFavicon

Description for themeFavicon

All of: url object
themeSpritemap

Description for themeSpritemap

All of: url object
workflowAction

Description for workflowAction

All of: webHook object