Skip to content

Instantly share code, notes, and snippets.

@julesfern
Created March 24, 2009 01:17
Show Gist options
  • Select an option

  • Save julesfern/83868 to your computer and use it in GitHub Desktop.

Select an option

Save julesfern/83868 to your computer and use it in GitHub Desktop.
title:
description: A title for the Movie. Will be displayed when the player is loading and when the movie is shared.
required: true
format: /\w+/
length:
maximum: 255
abstract:
description: A short description of the Movie
required: false
length: 0..255
document:
description: An optional SMIL document describing the presentation
required: false
specification: smil_document
privacy:
description: A string indicating the desired level of access given to others.
required: false
default: private
values:
private: The movie will be visible only to the authenticating user.
public: The movie will be visible to all users.
friends: The movie will be visible to people specified by the authenticating user.
Error in user YAML: (<unknown>): found character that cannot start any token while scanning for the next token at line 3 column 1
---
title: Content type specification
headers:
	content-accept:
		description: A MIME type indicating the desired response format.
		default: application/json
		values:
			application/json: The response will be returned as serialized JSON object.
			application/xml: The response will be returned as a serialized XML object.
			application/yaml: The response will be returned as a serialized YAML object.
---

Some text describing the content-accept specification.

#In order to generate a completely new test package:
tzatziki-gen api foldername/
#Generate a new header factory
tzatziki-gen headers shared/content-types
#Generate a new parameter factory
tzatziki-gen parameters shared/oauth
#Generate a new API call
tzatziki-gen method movies/new
#Run the suites against a domain (default is localhost)
tzatziki
tzatziki --domain=http://sandbox.videojuicer.com
tzatziki -d http://sandbox.videojuicer.com
Error in user YAML: (<unknown>): found character that cannot start any token while scanning for the next token at line 3 column 1
---
title: Global request specification
parameters:
	seed_key:
		description: The Seed Key for the Seed you wish to target with your API call.
---
Error in user YAML: (<unknown>): found character that cannot start any token while scanning for the next token at line 3 column 1
---
title: Creating a new Movie
request:
	uri: /movies/
	method: post
	headers:
		content-accept:
			specification: content-accept
			application/smil: The response will be returned as a fully-qualified SMIL presentation suitable for the Videojuicer Player SDK.
	parameters:
		attributes: true
		specifications: [sortable, oauth]
		some_other_parameter:
			description: Another parameter not included in the refactored listings.
			required: false
---

A description of the API call goes here. A description of the API call goes here. A description of the API call goes here. A description of the API call goes here.

Error in user YAML: (<unknown>): found character that cannot start any token while scanning for the next token at line 3 column 1
---
title: Sort specification
parameters:
	sort:
		description: A string matching the sort specification, describing the order in which matching results should be returned.
		required: false
		default: ID,ASC
---

Some text describing how to put together a sorting specification into a common string format, in markdown format.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment