GF Cloud Service API (preliminary)

The GF cloud service API provides the following functionality:

The functionalty available in via the PGF service API,
The functionality provided by the commands in GF shell,
some additional services for grammar compilation and persistent storage of files in the cloud.

The service is available from http://cloud.grammaticalframework.org. Users that have GF installed on their own computer can also run the service locally by starting GF with the command gf -server.

This is preliminary and subject to change!

PGF Service

The GF Cloud Service supports the same set of PGF service requests as the already available PGF web service. For example, a request like

http://cloud.grammaticalframework.org/grammars/Foods.pgf?command=random

might return a result like

[{"tree":"Pred (That Pizza) (Very Boring)"}]

For more info, see:

GF Shell Service

This service lets you execute arbitrary GF shell commands. Before you can do this, you need to use the /new command to obtain a working directory (which also servces as a session identifier) on the server, see below.

/gfshell&dir=...&command=i+Foods.pgf
/gfshell&dir=...&command=gr: Pred (That Pizza) (Very Boring)

For documentation of GF shell commands, see:

GF Shell Reference

Additional cloud service

/new: This generates a new working directory on the server, e.g. /tmp/gfse.123456. Most of the clouds service commands require that a working directory is specified in the dir parameter. The working directory is persistent, so clients are expected to remember and reuse it. Access to previously uploaded files requires that the same working directory is used.
/parse?path=source: This command can be used to check GF source code for syntax errors. It also converts GF source code to the JSON representation used in GFSE (the cloud-based GF grammar editor).
/cloud?&dir=...&command=upload&path₁=source₁&path₂=source₂&...: Upload files to be stored in the cloud.
/cloud?&dir=...&command=make&path₁=source₁&path₂=source₂&...: Upload grammar files and compile them into a PGF file.
/cloud?&dir=...&command=download&file=path: Download the specified file.
/cloud?&dir=...&command=ls&ext=.pgf: ["Foods.pgf","Letter.pgf"] (list files with the specified extension)
/cloud?&dir=...&command=rm&file=path: Remove the specified file.
/cloud?&dir=...&command=link_directories&newdir=...: Combine server directores. This is used by GFSE to share grammars between multiple devices.

Last modified: Mon Jun 18 15:03:02 CEST 2012