[Developers] Self-documenting web services (was New user with MQL question)

[Shawn Simister]

Andi Vajda wrote:
>
> On Apr 17, 2009, at 12:21, Shawn Simister <narphorium at gmail.com 
> <mailto:narphorium at gmail.com>> wrote:
>
>> The URL to look up "The Police" using the Search API would be:
>>
>> http://www.freebase.com/api/service/search?query=The%20Police
>>
>> There are additional parameters for mql_filter and mql_output if you 
>> want to further customize the output. Just click the more link at the 
>> end of the description on the Search API 
>> <http://www.freebase.com/view/en/api_service_search> page to get a 
>> description of the different parameters.
>
> Sadly, this doc is a little too succinct and incomplete. 
> http://www.freebase.com/api/service/search?help
> is the more complete and authoritative documentation
> for this API. 
>
> Andi..
>
That's an interesting way of letting the API web services provide their 
own documentation. Are there plans to have all the web services respond 
to "?help" requests? If so, it would be nice to have somewhere in the 
Help section that links to these pages.

Shawn
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.freebase.com/pipermail/developers/attachments/20090417/411665f1/attachment.htm