Permalink
Browse files

initial commit

  • Loading branch information...
0 parents commit be70b5d6643100013b7b9692e5cb276a06f50b69 @precision precision committed Jul 30, 2011
@@ -0,0 +1,4 @@
+.DS_Store
+config.json
+logs/*
+pids/*
@@ -0,0 +1,61 @@
+{
+ "endPoints": [
+ {
+ "path": "/word.{format}/{word}",
+ "description": "",
+ "operations": [
+ {
+ "category": "WordDetails", // Group using this or endpoint?
+ "summary": "Given a word as a string, returns the WordObject that represents it",
+ "suggestedName": "getWord",
+ "deprecated": false, // need to add
+ "open": false,
+ "httpMethod": "GET",
+ "parameters": [
+ {
+ "name": "word",
+ "description": "String value of WordObject to return",
+ "required": true,
+ "dataType": "string",
+ "paramType": "path" // Needed?
+ },
+ {
+ "name": "useCanonical",
+ "description": "If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested.",
+ "required": false,
+ "dataType": "string",
+ "paramType": "query"
+ },
+ {
+ "name": "includeSuggestions",
+ "description": "Return suggestions (for correct spelling, case variants, etc.)",
+ "required": false,
+ "dataType": "string",
+ "paramType": "query"
+ },
+ {
+ "name": "format",
+ "defaultValue": "json", // need to add
+ "description": "API response format",
+ "required": true,
+ "allowableValues": "json,xml", // Need to add
+ "paramType": "path"
+ }
+ ],
+ "response": [
+ {
+ "valueType": "wordObject",
+ "errorResponses": [ // Needed?
+ {
+ "reason": "Invalid word supplied.",
+ "code": 400
+ }
+ ],
+ "condition": "any"
+ }
+ ],
+ "examples": [ // Fill out
+ ]
+ }
+ ]
+ },
Oops, something went wrong.

0 comments on commit be70b5d

Please sign in to comment.