OptionaldescriptionA short description to explain the capability.
OptionalinactiveControls whether this capability is inactive. Defaults to false.
Capabilities can be marked as inactive in a capability interceptor, for example, based on user permissions. Inactive capabilities are unavailable to applications but still visible in the SCION DevTools for discovery.
Note: Applications configured with capabilityActiveCheckDisabled can still access inactive capabilities (discouraged).
OptionalparamsSpecifies parameters which the intent issuer can/must pass along with the intent.
Parameters are part of the contract between the intent publisher and the capability provider. They do not affect the intent routing, unlike the qualifier.
OptionalprivateControls whether this capability is private. Defaults to true.
If private, the capability is not visible to other applications and can only be accessed by the providing application.
Note: Applications configured with scopeCheckDisabled can still access private capabilities (discouraged).
Arbitrary metadata to be associated with the capability.
Arbitrary metadata to be associated with the capability.
Optionaloutlet?: stringSpecifies the preferred outlet to load this microfrontend into. Note that this preference is only a hint that will be ignored if the navigator specifies an outlet for navigation.
The precedence is as follows:
Specifies the path of the microfrontend.
The path is relative to the base URL, as specified in the application manifest. If the application does not declare a base URL, it is relative to the origin of the manifest file.
The path allows the use of navigational symbols and named parameters to reference qualifier and parameter values.
A named parameter begins with a colon (:) followed by the qualifier or parameter name, and is allowed in path segments,
query parameters, matrix parameters and the fragment part. Named query and matrix parameters without a replacement are removed,
e.g., if referencing an optional parameter.
{
"type": "microfrontend",
"qualifier": {
"entity": "product"
},
"params": [
{"name": "id", "required": true}
]
"properties": {
"path": "product/:id",
}
}
segment/:param1/segment/:param2
segment/segment;matrixParam1=:param1;matrixParam2=:param2
segment/segment?queryParam1=:param1&queryParam2=:param2
OptionalshowSplash?: booleanInstructs the router outlet to show a splash, such as a skeleton or loading indicator, until the microfrontend signals readiness. The splash is the markup between the opening and closing tags of the router outlet element.
OptionalqualifierThe qualifier is a dictionary of arbitrary key-value pairs to differentiate capabilities of the same type and is like
an abstract description of the capability. It should include enough information to uniquely identify the capability.
Intents must exactly match the qualifier of the capability, if any.
Categorizes the capability in terms of its functional semantics (e.g., microfrontend if providing a microfrontend).
It can be an arbitrary string literal and has no meaning to the platform.
Represents a microfrontend that can be loaded into a using the OutletRouter.