Detailed Documentation

[GoogleCodeExporter]

Could you please provide detailed documentation for newbies. 
Documentation should ease you into the project with a bit of background into 
what inspired it, and the advantages it provides. 

Thanks

Original issue reported on code.google.com by azat...@gmail.com on 24 Aug 2012 at 6:44

[GoogleCodeExporter]

Is there a particular point that is missing from the "Getting Started" page in 
the wiki (that isn't covered by existing online documentation for REST and 
Google App Engine)?

Original comment by jahlborn@gmail.com on 25 Aug 2012 at 2:05

• Added labels: Type-Enhancement, Priority-Low, Component-Docs
• Removed labels: Type-Defect, Priority-Medium

[GoogleCodeExporter]

Your documentation just starts by saying the library is easy, and then jumps 
into examples. It could start with a high level description of what the library 
provides:
1. REST API - Datastore
2. Authentication
3. Authorization
4. Namespaces Support
You know what problems you were trying to solve with each component of this 
library, but you just don't communicate that properly or in detail. 
You make a lot of assumptions about what the first time user already knows.

Original comment by azat...@gmail.com on 25 Aug 2012 at 8:38

[GoogleCodeExporter]

The front page answers 1-3 (in the info and the link to the Features page with 
a more complete list).  Each of the example code pages has documentation at the 
top indicating their purpose and use.

Original comment by jahlborn@gmail.com on 25 Aug 2012 at 12:39

[GoogleCodeExporter]

Thanks for all your quick responses, much appreciated. 
How would I go about creating a JSON schema for my Models, then posting model 
instances that adhere to that schema?

Original comment by azat...@gmail.com on 26 Aug 2012 at 8:48

[GoogleCodeExporter]

Also am I better off representing my Models as Python classes, or is it better 
to just use JSON for my Models? 
What do you think are the pros and cons?

Original comment by azat...@gmail.com on 27 Aug 2012 at 8:15

[GoogleCodeExporter]

I don't know what you mean by a "JSON schema"?  there is no such thing that i'm 
aware of.  

also, i don't understand what you mean about python classes vs. JSON for your 
models.  All python app engine models are backed by python classes.

Original comment by jahlborn@gmail.com on 28 Aug 2012 at 12:53

[GoogleCodeExporter]

A link to the JSON schema is available here: http://json-schema.org/
But I suppose using a JSOn schema could be overkill. 
With your REST API, will this 'POST http://<service>/rest/<typeName>' create a 
new database to which I can then add/remove instances which are in JSON format 
(without me touching Python code)? 
CouchDB works in this fashion.

Original comment by azat...@gmail.com on 28 Aug 2012 at 11:11

[GoogleCodeExporter]

I think you're misunderstanding the intent of this project.  This project is 
supposed to be a simple "add-on" for an existing python project which exposes 
the project Models via a RESTish API.  So yes, there is python coding required.

I think i see where you are going with your questions.  it seems like you want 
to use an app engine project purely as a database for some other system.  you 
could do that with minimal python coding.  you could implement your app engine 
project as just a collection of Models with no other code.  but you still need 
a minimal amount of python code.

Original comment by jahlborn@gmail.com on 29 Aug 2012 at 3:19

[GoogleCodeExporter]

You're correctly, I certainly misunderstood the scope of the project. 
Your answers have certainly put things into perspective for me, thanks again 
for your patience and time.

Original comment by azat...@gmail.com on 29 Aug 2012 at 7:09

[GoogleCodeExporter]

Original comment by jahlborn@gmail.com on 29 Aug 2012 at 6:15

• Changed state: WontFix
• Added labels: Type-Other
• Removed labels: Type-Enhancement