Package apiclient :: Module schema |
[hide private]
[frames] | no frames]

# Module schema

source code

    Schema processing for discovery based APIs

    Schemas holds an APIs discovery schemas. It can return those schema as
    deserialized JSON objects, or pretty print them as prototype objects that
    conform to the schema.

    For example, given the schema:

     schema = """{
       "Foo": {
        "type": "object",
        "properties": {
         "etag": {
          "type": "string",
          "description": "ETag of the collection."
         },
         "kind": {
          "type": "string",
          "description": "Type of the collection ('calendar#acl').",
          "default": "calendar#acl"
         },
         "nextPageToken": {
          "type": "string",
          "description": "Token used to access the next
             page of this result. Omitted if no further results are available."
         }
        }
       }
     }"""

     s = Schemas(schema)
     print s.prettyPrintByName('Foo')

     Produces the following output:

      {
       "nextPageToken": "A String", # Token used to access the
           # next page of this result. Omitted if no further results are available.
       "kind": "A String", # Type of the collection ('calendar#acl').
       "etag": "A String", # ETag of the collection.
      },

    The constructor takes a discovery document in which to look up named schema.

Author: jcgregorio@google.com (Joe Gregorio)

Classes | [hide private]
| Schemas Schemas for an API.
| _SchemaToStruct Convert schema to a prototype object.