Documentation of Conversion Properties

[raffazizzi]

I was looking for documentation about the conversion properties that can be sent to the /Conversions endpoint, but I can't find them. The API explorer at https://teigarage.tei-c.org/ege-webservice doesn't seem to cover them. Would it be possible to document them in full somewhere?

[anneferger]

Yes I'll add that, thanks!

[anneferger]

So currently the possible parameters for each conversion can be accessed via an GET request to the API, like URL for conversion https://teigarage.tei-c.org/ege-webservice/Conversions/ODD%3Atext%3Axml/ which shows the possible parameters and values like

<conversion id="I:Documents:Compiled TEI ODD:ODDC,text/xml/O:Documents:ODD documentation as TEI Lite:TEI,text/xml(TEI Converter)" index="1">
<property id="oxgarage.getImages">
<value>true,false</value>
<type>pathBoolean</type>
<property-name>Copy and rename all provided images</property-name>
</property>
<property id="oxgarage.getOnlineImages">
<value>true,false</value>
<type>pathBoolean</type>
<property-name>Download images located on the internet</property-name>
</property>
<property id="oxgarage.lang">
<value>en,de,es,fr,it,kr,ja,zh-tw</value>
<type>array</type>
<property-name>Language</property-name>
</property>
<property id="oxgarage.textOnly">
<value>true,false</value>
<type>pathBoolean</type>
<property-name>
Convert text only, don't include any images from the document
</property-name>
</property>
<property id="pl.psnc.dl.ege.tei.profileNames">
<value>default</value>
<type>array</type>
<property-name>Select conversion profile: </property-name>
</property>
</conversion>

but I'd like to first go over them if they are still up-to-date and then add them to the Swagger Documentation as this seems more convenient, right?

[raffazizzi]

That's very helpful, thanks @anneferger! Yes I still think it would be valuable to add them to the Swagger Documentation.