I included the dev list to help document this conversation. 

Go ahead and add a parameter to the rest API for the source map. 

The documentation should be in two places. First let's keep the wiki up today 
with the changes you have made. Also the final user documentation should be on 
the VXQuery website. Under the VXQuery maven project, you will find a src/site 
folder where all the xml and apt files are stored to produce the website. I 
think we probably need a new page that defines and shows examples like the 
wiki. The site has documentation on how to build the site. 



Sent from my iPhone

> On Aug 13, 2017, at 8:13 PM, Erandi Ganepola <erandiganep...@gmail.com> wrote:
> 
> Hi  Ian and Preston,
> 
> Adding to the previous email, can you point me out where should I write 
> documentation?
> 
> Erandi Ganepola
> Undergraduate
> BSc. Management and Information Technology (IT Sp.)
> University of Kelaniya, Sri Lanka
> 
>    
> 
>> On Sun, Aug 13, 2017 at 5:11 PM, Erandi Ganepola <erandiganep...@gmail.com> 
>> wrote:
>> Hi Ian and Preston,
>> 
>> I started migrating XTests to use REST API as discussed [1]. But there is a 
>> small problem when using the REST API.
>> 
>> In XTests (at [2]), we have to pass a source file map which will be used by 
>> the CompilerControllerBlock to determine the collections mentioned in the 
>> queries. When we go through the REST API, currently there is no way to pass 
>> such a parameter (a map). Passing such a value at initialization time is not 
>> possible as far as I see.
>> 
>> As I understand, one solution will be to use POST requests in the REST API 
>> and allow the source file map to be sent as well. What do you suggest?
>> 
>> [1] 
>> https://github.com/erandiganepola/vxquery/commit/8f85db5f4c087f4fb414b42de5461bd48665d863
>> [2] 
>> https://github.com/apache/vxquery/blob/master/vxquery-xtest/src/main/java/org/apache/vxquery/xtest/TestRunner.java#L144
>> 
>> Thanks and Regards,
>> Erandi Ganepola
>> Undergraduate
>> BSc. Management and Information Technology (IT Sp.)
>> University of Kelaniya, Sri Lanka
>> 
>>    
> 

Reply via email to