Model for the Image Style Rest Endpoint
Last modified by Admin on 2024/12/16 00:11
 | JAXB model for the image styles REST endpoints. |
| Type | JAR |
| Category | API |
| Developed by | |
| Active Installs | 95 |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Bundled With | XWiki Standard |
| Compatibility | 14.3RC1+ |
Table of contents
Description
Define the datastructures used by the Image Style REST Endpoints.
The model is defined in the form on the following xsd:
<schema xmlns="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.xwiki.org/imageStyle"
xmlns:imageStyle="http://www.xwiki.org/imageStyle" elementFormDefault="qualified">
<!--
*
* Types
*
-->
<complexType name="Style">
<annotation>
<documentation>Image Style metadata.</documentation>
</annotation>
<sequence>
<element name="identifier" type="string"/>
<element name="prettyName" type="string"/>
<element name="type" type="string"/>
<element name="adjustableSize" type="boolean" nillable="true"/>
<element name="defaultWidth" type="long" nillable="true"/>
<element name="defaultHeight" type="long" nillable="true"/>
<element name="adjustableBorder" type="boolean" nillable="true"/>
<element name="defaultBorder" type="boolean" nillable="true"/>
<element name="adjustableAlignment" type="boolean" nillable="true"/>
<element name="defaultAlignment" type="string"/>
<element name="adjustableTextWrap" type="boolean" nillable="true"/>
<element name="defaultTextWrap" type="boolean" nillable="true"/>
</sequence>
</complexType>
<complexType name="Styles">
<annotation>
<documentation>A collection of image styles.</documentation>
</annotation>
<sequence>
<!-- A collection of resolved translations. -->
<element name="imageStyle" type="imageStyle:Style" minOccurs="0" maxOccurs="unbounded"/>
<!-- <element name="default" type="string"/>-->
</sequence>
</complexType>
<!--
*
* Elements
*
-->
<element name="styles" type="imageStyle:Styles"/>
</schema>
xmlns:imageStyle="http://www.xwiki.org/imageStyle" elementFormDefault="qualified">
<!--
*
* Types
*
-->
<complexType name="Style">
<annotation>
<documentation>Image Style metadata.</documentation>
</annotation>
<sequence>
<element name="identifier" type="string"/>
<element name="prettyName" type="string"/>
<element name="type" type="string"/>
<element name="adjustableSize" type="boolean" nillable="true"/>
<element name="defaultWidth" type="long" nillable="true"/>
<element name="defaultHeight" type="long" nillable="true"/>
<element name="adjustableBorder" type="boolean" nillable="true"/>
<element name="defaultBorder" type="boolean" nillable="true"/>
<element name="adjustableAlignment" type="boolean" nillable="true"/>
<element name="defaultAlignment" type="string"/>
<element name="adjustableTextWrap" type="boolean" nillable="true"/>
<element name="defaultTextWrap" type="boolean" nillable="true"/>
</sequence>
</complexType>
<complexType name="Styles">
<annotation>
<documentation>A collection of image styles.</documentation>
</annotation>
<sequence>
<!-- A collection of resolved translations. -->
<element name="imageStyle" type="imageStyle:Style" minOccurs="0" maxOccurs="unbounded"/>
<!-- <element name="default" type="string"/>-->
</sequence>
</complexType>
<!--
*
* Elements
*
-->
<element name="styles" type="imageStyle:Styles"/>
</schema>
Prerequisites & Installation Instructions
We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager).
You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.
Dependencies
Dependencies for this extension (org.xwiki.platform:xwiki-platform-image-style-model 16.10.1):
- jakarta.xml.bind:jakarta.xml.bind-api 2.3.3
