[zanata-users] Rest API Documentation down?

[Sean Flanigan]

Hi Nghia

The latest nightly version of the REST API is now documented here:

https://zanata.ci.cloudbees.com/job/zanata-api-site/site/zanata-common-api/rest-api-docs/index.html

Note that some of the generated links to data type definitions are wrong
(404), but if you look up the data type from the home page above, I
think it's all there.


Also note that new features (eg translation memory import/export) won't
be available when running against older servers, and will return 404
responses.


Regards

Sean.

On 2013-09-06 17:24, Nghia Duong wrote:
> Thanks for the quick answer Sean,
> 
> I am coding against Zanata's REST API with PHP (creating cURL requests
> with the right infos depending on the actions I want to perform). While
> re-reading the error log I saw a MySQL insufficient thread stack size
> problem, I will try to increase that and see where it leads me.
> 
> If other people want to use PHP to interact with the API, here's what I
> have: https://github.com/adlq/zanata-php-toolkit. It is under-documented
> and under development but it does the job of uploading POT source
> documents and translations (which is what I need).
> 
> Regards,
> 
> Nghia
> 
> 
> 2013/9/6 Sean Flanigan <sflaniga at redhat.com <mailto:sflaniga at redhat.com>>
> 
>     Hi Nghia
> 
>     Are you writing code against the REST API?  Which language are you
>     using?
> 
> 
>     If you are, a very old version of the REST docs can be found here:
> 
>     https://zanata.ci.cloudbees.com/view/All/job/zanata-server-site/site/zanata-war/apidocs/index.html
> 
>     but that URL will change if we get the cloudbees build to work again.
> 
> 
>     At present, I'm afraid the only place to get up to date info about the
>     REST API (including async push) is the source code:
> 
>     https://github.com/zanata/zanata-api/tree/master/zanata-common-api/src/main/java/org/zanata
> 
>     But if you are coding against the REST API, do let us know, and we'll
>     try to do something about improving the situation.
> 
> 
>     (If you are writing Java code, you can use the Java classes directly, as
>     we do in the Java clients for Zanata.)
> 
> 
> 
>     On the other hand, if you are trying to use a command-line Zanata
>     client, we have some new documentation under development.  It has been
>     moving around, but right now it can be found here:
>       http://zanata.org/new/help/
> 
> 
>     If you are using the Python client, it doesn't support the async push
>     API, which is needed for larger source documents (eg POT).
> 
>     The Java client does support async push.  If you want to use it, see the
>     help URL above.
> 
> 
>     Regards
> 
>     Sean.
> 
>     On 2013-09-06 01:11, Nghia Duong wrote:
>     > Hi all,
>     >
>     > I just wanted to point out that the REST API Documentation
>     >
>     (https://zanata.ci.cloudbees.com/job/zanata-site/site/zanata-war/apidocs/index.html)
>     > has been down since quite some time.
>     >
>     > I'm using that API on Zanta 3.0.2 and would like to know whether there
>     > has been any changes to it, especially around regarding timeouts (I'm
>     > trying to upload a POT file a a source document and I always get a 500
>     > internal error).
>     >
>     > Has the documentation been moved to somewhere else?
>     >
>     >
>     > Thanks,
>     >
>     > Nghia
>     >
>     >
>     > _______________________________________________
>     > zanata-users mailing list
>     > zanata-users at redhat.com <mailto:zanata-users at redhat.com>
>     > https://www.redhat.com/mailman/listinfo/zanata-users
>     >
> 
> 
>     --
>     Sean Flanigan
> 
>     Senior Software Engineer
>     Engineering - Internationalisation
>     Red Hat
> 
> 


-- 
Sean Flanigan

Senior Software Engineer
Engineering - Internationalisation
Red Hat

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 295 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/zanata-users/attachments/20130911/ea4a585b/attachment.sig>