META-INF.mule-schemadoc.xsd Maven / Gradle / Ivy
This schema provides a schema doc extentions that can be embedded in Mule schemas. These
elements will be used to render additional wiki content associated with the element being annotated.
Elements within this schema should be embedded under 'xsd:element/xsd:annotation/xsd:appinfo'.
To stick to convention and to ensure that XSLs will work this schema should be included in other mule
schemas using the 'schemadoc' prefix namespace.
SchemaDoc Reference
The snippet allows for code snippets to be associated with an element in a schema. This
is useful for surfacing documentation on the wiki. When the schema reference is generated for the wiki,
the code snippets will also be rendered when using the 'single-element-wike.xsl'.
The page title to use when rendering this schema.
The short name of the module or transport, i.e. 'xml' or 'tcp'.
Additional documentation that can be rendered with the schema. Note that this element can
only be used in {{/xsd:schema/xsd:annotation/xsd:appinfo}}, it will be ignorred if used anywhere else.
Enter
the documentation in the body of this element.
The point at which the documentation is rendered.
The documentation will appear after any title text but before any of the
common elements are rendered.
The documentation will appear right after common elements are rendered.
The documentation will appear right before the elements specific to the
schema are rendered.
The documentation will appear right after the elements specific to the
schema are rendered.
If a specific element was named, this documentation will appear directly
before the element. The mode is less useful but supported for completeness.
If a specific element was named, this documentation will appear directly
after the element. The mode is less useful but supported for completeness.
The ID of the snippet to embed in the wiki page. This ID is embedded in the source
file using a START SNIPPET xxx comment.
The language format to use when rendering the content of the snippet on the wiki.
This is the path to the source file. Note this should be relative to the project root
directory i.e. transport/jms/src/main/resources/etc...
Defines meta information about transports such as whether they can send or receive events
and if they supprt transactions.
The MEPs that are supported by this Transport. and the dafault MEP
Whether the transport can receive events and thus can be used for an inbound
endpoint.
Ehether the transport can be used to dispatch events and thus is supported as an
outbound endpoint.
Whether the transport can be used to request events directly from the source.
Whether transactions are supported by the transports. Transports that support (/)A
transactions can be configured in a distributed 2 Phase Commit (Distributed) transaction.
A comma separated list of transaction types, i.e. local, XA
Whether the transport supports streaming of the data is provides or publishes.
Whether the transport support retry policies. Note most transports can be configured with retry policies, but this flag marks the transports that MuleSoft explicitly test and support.