Doc composer REST Resource documentation


#1

Hi everyone

I try to generate my REST Resource documentation with doc composer but in the preview VP only writes the diagram. I create my own template as follows:

<?xml version="1.0" encoding="UTF-8"?>
<Inline template="General/Diagram Basic"/>

<Inline template="RestResource/Details" />

<Inline template="RestResource/Parameters" />

at this point, i don’t have idea what i do wrong, because this templates must show the data of each REST Resource that i configured.


#2

Hi, here is a sample for you case.

<?xml version="1.0" encoding="UTF-8"?>
<!-- 
<Inline template="General/Diagram Details"/>
-->

<!-- BASIC of this diagram -->
<Inline template="Basic"/>

<!-- for-each Rest Resource(s) from this diagram -->
<IterationBlock modelType="RestResource">
	<!-- inside this block, we are working on one RestResource element -->
	
	<!-- so, this is DETAILS of this RestResource -->
	<Inline template="Details"/>
	
	<!-- and, this is PARAMETERS of this RestResource -->
	<Inline template="Parameters"/>
	
</IterationBlock>

I think the name “General/Diagram Basic” mislead you that, it is “General”'s “Diagram Basic”,
so, you try to type “RestResource/Details” to generate Rest Resource’s Details

But it is wrong.

as screenshot, once the doc composer running in the <IterationBlock modelType="RestResource">, it becomes working on a RestResource. At that moment, “Basic” is talking about RestResource’s Basic.