diff options
| author | Andi Albrecht <albrecht.andi@gmail.com> | 2011-07-29 21:03:28 +0200 |
|---|---|---|
| committer | Andi Albrecht <albrecht.andi@gmail.com> | 2011-07-29 21:03:28 +0200 |
| commit | 92c142623d9b4ad806f51dd79e3842396ac464d8 (patch) | |
| tree | e56384484801edcd417901e485474914a98ea4a1 /extras/appengine/sqlformat/templates/api.html | |
| parent | c918cc9dc30b3a7684a96feae95fc5c05638360e (diff) | |
| download | sqlparse-92c142623d9b4ad806f51dd79e3842396ac464d8.tar.gz | |
Replace Django by Flask in App Engine frontend (fixes issue11).
--HG--
rename : extras/appengine/Makefile => extras/appengine-django/Makefile
rename : extras/appengine/README => extras/appengine-django/README
rename : extras/appengine/__init__.py => extras/appengine-django/__init__.py
rename : extras/appengine/app.yaml => extras/appengine-django/app.yaml
rename : extras/appengine/examples/customers.sql => extras/appengine-django/examples/customers.sql
rename : extras/appengine/examples/multiple_inserts.sql => extras/appengine-django/examples/multiple_inserts.sql
rename : extras/appengine/examples/pg_view.sql => extras/appengine-django/examples/pg_view.sql
rename : extras/appengine/examples/subquery.sql => extras/appengine-django/examples/subquery.sql
rename : extras/appengine/examples/subquery2.sql => extras/appengine-django/examples/subquery2.sql
rename : extras/appengine/index.yaml => extras/appengine-django/index.yaml
rename : extras/appengine/main.py => extras/appengine-django/main.py
rename : extras/appengine/settings.py => extras/appengine-django/settings.py
rename : extras/appengine/sqlformat/__init__.py => extras/appengine-django/sqlformat/__init__.py
rename : extras/appengine/sqlformat/urls.py => extras/appengine-django/sqlformat/urls.py
rename : extras/appengine/sqlformat/views.py => extras/appengine-django/sqlformat/views.py
rename : extras/appengine/static/bg_options.png => extras/appengine-django/static/bg_options.png
rename : extras/appengine/static/bgfieldset.png => extras/appengine-django/static/bgfieldset.png
rename : extras/appengine/static/bgfooter.png => extras/appengine-django/static/bgfooter.png
rename : extras/appengine/static/bgtop.png => extras/appengine-django/static/bgtop.png
rename : extras/appengine/static/blank.gif => extras/appengine-django/static/blank.gif
rename : extras/appengine/static/canvas.html => extras/appengine-django/static/canvas.html
rename : extras/appengine/static/hotkeys.js => extras/appengine-django/static/hotkeys.js
rename : extras/appengine/static/img_loading.gif => extras/appengine-django/static/img_loading.gif
rename : extras/appengine/static/jquery.textarearesizer.compressed.js => extras/appengine-django/static/jquery.textarearesizer.compressed.js
rename : extras/appengine/static/loading.gif => extras/appengine-django/static/loading.gif
rename : extras/appengine/static/lynx_screenshot.png => extras/appengine-django/static/lynx_screenshot.png
rename : extras/appengine/static/pygments.css => extras/appengine-django/static/pygments.css
rename : extras/appengine/static/resize-grip.png => extras/appengine-django/static/resize-grip.png
rename : extras/appengine/static/robots.txt => extras/appengine-django/static/robots.txt
rename : extras/appengine/static/rpc_relay.html => extras/appengine-django/static/rpc_relay.html
rename : extras/appengine/static/script.js => extras/appengine-django/static/script.js
rename : extras/appengine/static/sitemap.xml => extras/appengine-django/static/sitemap.xml
rename : extras/appengine/static/sqlformat_client_example.py => extras/appengine-django/static/sqlformat_client_example.py
rename : extras/appengine/static/styles.css => extras/appengine-django/static/styles.css
rename : extras/appengine/templates/404.html => extras/appengine-django/templates/404.html
rename : extras/appengine/templates/500.html => extras/appengine-django/templates/500.html
rename : extras/appengine/templates/about.html => extras/appengine-django/templates/about.html
rename : extras/appengine/templates/api.html => extras/appengine-django/templates/api.html
rename : extras/appengine/templates/index.html => extras/appengine-django/templates/index.html
rename : extras/appengine/templates/master.html => extras/appengine-django/templates/master.html
rename : extras/appengine/templates/python-client-example.html => extras/appengine-django/templates/python-client-example.html
rename : extras/appengine/templates/source.html => extras/appengine-django/templates/source.html
Diffstat (limited to 'extras/appengine/sqlformat/templates/api.html')
| -rw-r--r-- | extras/appengine/sqlformat/templates/api.html | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/extras/appengine/sqlformat/templates/api.html b/extras/appengine/sqlformat/templates/api.html new file mode 100644 index 0000000..79bf118 --- /dev/null +++ b/extras/appengine/sqlformat/templates/api.html @@ -0,0 +1,52 @@ +{% extends "master.html" %} + +{% block title %}API{% endblock %} + +{% block main %} +<h1>API Documentation</h1> + +<p> + Using the API for this application is pretty simple. Just send a + <code>POST</code> request to +</p> +<p> + <code>http://sqlformat.appspot.com/format/</code> +</p> + +<h2>Options</h2> +<p> + The <code>POST</code> request accepts various options to control + formatting. Only the <em>data</em> option is required. All others + are optional. +</p> + +<dl> + <dt>data</dt> + <dd>The SQL statement to format.</dd> + <dt>remove_comments</dt> + <dd>Set to 1 to remove comments.</dd> + <dt>keyword_case</dt> + <dd>How to convert keywords. Allowed values are 'lower', 'upper', + 'capitalize'.</dd> + <dt>identifier_case</dt> + <dd>How to convert identifiers. Allowed values are 'lower', 'upper', + 'capitalize'.</dd> + <dt>n_indents</dt> + <dd>An integer indicating the indendation depth.</dd> + <dt>right_margin</dt> + <dd>An integer indicating the maximum line length.</dd> + <dt>output_format</dt> + <dd>Transfer the statement into another programming language. + Allowed values are 'python', 'php'</dd> +</dl> + +<h2>Example</h2> +<p> + Here's a example in Python: +</p> +{% include "python-client-example.html" %} +<p> + <a href="/static/sqlformat_client_example.py">Download sqlformat_example_client.py</a> +</p> + +{% endblock %} |
