gistfile1.txt

config.yml
==========

api_key: api_key_used_for_calls


_types/timestamp.markdown
===========================

---
title: Timestamp
format: /^\d+$/
example: {{util.time | since_epoch}}
---

Timestamps in the API are expected to be unix-style epoch-based integers.


_types/nonce.markdown
=====================

---
title: Nonce value
format: /.*/
length: 
	maximum: 255
example: ABCDEFGHIJKL
---

Nonce values are randomly-generated strings that must be unique relative to the timestamp given elsewhere in the request.


_specifications/successful.markdown
===================================

---
title: Successful request schema
request:
	protocol: http
	uri: /
	post_body:
		nonce:
			type: nonce
		nonce_two:
			type: nonce
		ts:
			type: timestamp
	query_string: 
		api_key: 
			description: The API key for the account you are accessing.
			example: {{config.api_key}}
response:
	status: 20X
	content-type: application/html
---

Successful responses from the API return a 200, or a 201 if an object was successfully created. In the event that a 201 status is returned, the resource URL of the created object will be returned in the response's *location* header.
	
_apis/the_google/search.markdown
================================

---
title: Submitting a search query to Google
specifications:
	successful: true # The api_key from the config will be included needlessly since The Google doesn't need it, but we'll include it to show it works.
request:
	query_string:
		q:
			description: The search string you wish to submit to The Google
			format: /.*/
			example: Now you're thinking with portals
---

To submit a query to The Google, use the Q parameter.





Facets missing:
- A data type
- An example set