Miredot | Migrate from v1.x to v1.4

Reference Manual

Migrate from v1.x to v1.4

Miredot v1.4 introduces a major change in its (Maven) configuration structure (everything inside the <configuration> tag of the Miredot plugin). Please follow this guide if you're upgrading from a prior version.

For each part of the maven configuration, the before and after v1.4 are shown. The [..config..] marker indicates there are no changes in that area and you should just copy what you had.

In this migration guide, only changes to the Maven configuration are documented, since other buildsystems were not supported by Miredot versions prior to 1.4

Status Codes

<statusCodes>
    <statusCode>
        [..config..]
    </statusCode>
</statusCodes>

<restModel>
    <httpStatusCodes>
        <httpStatusCode>
            [..config..]
        </httpStatusCode>
    </httpStatusCodes>
</restModel>

Issue Handling

<issueHandling>
    [..config..]
</issueHandling>

<analysis>
    <checks>
        [..config..]
    </checks>
</analysis>

Field Visibility

<visibility>
    [..config..]
</visibility>

<restModel>
    <fieldVisibility>
        [..config..]
    </fieldVisibility>
</restModel>

Resource/Operation Title Naming

<title>
    [..config..]
</title>

<restModel>
    <titleNamingStrategies>
        [..config..]
    </titleNamingStrategies>
</restModel>

Output formats

<outputFormats>
    <outputFormat>Html</outputFormat>
    <outputFormat>Docx</outputFormat>
</outputFormats>

<output>
     <html />
     <docx />
</output>

Note: Several properties such as title, location can now be added to the general output section or to the specific html or docx sections.

<outputLocation>
    [..outputLocationConfig..]
</outputLocation>
<htmlIntro>
    [..htmlIntroConfig..]
</htmlIntro>
<baseUrl>
    [..baseUrlConfig..]
</baseUrl>

<output>
     <html>
        <location>[..outputLocationConfig..]</location>
        <intro>[..htmlIntroConfig..]</intro>
        <baseUrl>[..baseUrlConfig..]</baseUrl>
     </html>
     <docx>
        <location>[..outputLocationConfig..]</location>
     </docx>
</output>

Filter input files

<filter>
    [..config..]
</filter>

<restModel>
    <filter>
        [..config..]
    </filter>
</restModel>