wordnik 4.06.05 → 4.06.06

data/spec/vcr/xml_response_request.yml

@@ -0,0 +1,25 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :get
+    uri: http://localhost:8001/admin/api/word.xml
+    body: 
+    headers: 
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      date: 
+      - Mon, 29 Aug 2011 16:28:44 GMT
+      wordnik-api-version: 
+      - 4.07.67
+      access-control-allow-origin: 
+      - "*"
+      content-type: 
+      - application/xml
+      transfer-encoding: 
+      - chunked
+    body: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><ApiDocumentation><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getEntries</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to return</description><name>word</name><paramType>path</paramType><required>true</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Return XML tags in response</description><name>tags</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.</description><name>sourceDictionary</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Maximum number of results to return</description><name>limit</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Return etymologies</description><name>etymologies</name><paramType>query</paramType><required>false</required></parameters><responseClass>List[entry]</responseClass><summary>Return entries for a word</summary></operations><path>/word.{format}/{word}/entries</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getExamples</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to return examples for</description><name>word</name><paramType>path</paramType><required>true</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Maximum number of results to return</description><name>limit</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>false</allowableValues><allowableValues>true</allowableValues><dataType>string</dataType><description>Show duplicate examples from different sources</description><name>includeDuplicates</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Return results from a specific ContentProvider</description><name>contentProvider</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>false</allowableValues><allowableValues>true</allowableValues><dataType>string</dataType><description>If true will try to return the correct word root ('cats' -&gt; 'cat'). If false returns exactly what was requested.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Specify the internal storage engine.</description><name>internalDataStore</name><paramAccess>internal</paramAccess><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Results to skip</description><name>skip</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Maximum number of results to return</description><name>limit</name><paramType>query</paramType><required>false</required></parameters><responseClass>exampleSearchResults</responseClass><summary>Returns examples for a word</summary></operations><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>POST</httpMethod><nickname>getExamplesPost</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to fetch examples for</description><name>word</name><paramType>path</paramType><required>true</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>ExampleSearchQuery</dataType><description>Search definition object</description><paramType>body</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Specify the internal storage engine.</description><name>internalDataStore</name><paramAccess>internal</paramAccess><paramType>query</paramType><required>false</required></parameters><responseClass>exampleSearchResults</responseClass><summary>Fetches examples for a word</summary></operations><path>/word.{format}/{word}/examples</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><errorResponses><code>404</code><reason>No results.</reason></errorResponses><httpMethod>POST</httpMethod><nickname>addWordForm</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to add forms for</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>suggestion</dataType><description>RelationshipMapWord to add</description><paramType>body</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Make this the Canonical form of the word.</description><name>canonical</name><paramType>query</paramType><required>false</required></parameters><responseClass>ok</responseClass><summary>Adds a Relationship Map to a word</summary></operations><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><errorResponses><code>404</code><reason>No results.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getWordForms</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to fetch forms for</description><name>word</name><paramType>path</paramType><required>true</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>If true will try to return a correct word root ('cats' -&gt; 'cat'). If false returns exactly what was requested.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><responseClass>relationshipMap</responseClass><summary>Returns other forms of a word</summary></operations><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><errorResponses><code>404</code><reason>No results.</reason></errorResponses><httpMethod>DELETE</httpMethod><nickname>deleteWordForm</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to delete forms from</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Relationship type to delete</description><name>type</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Target word to remove relationship from.</description><name>word</name><paramType>query</paramType><required>false</required></parameters><responseClass>ok</responseClass><summary>Deletes a relationship from a word</summary></operations><path>/word.{format}/{word}/wordForms</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getWord</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>String value of WordObject to return</description><name>word</name><paramType>path</paramType><required>true</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>false</allowableValues><allowableValues>true</allowableValues><dataType>string</dataType><description>If true will try to return the correct word root ('cats' -&gt; 'cat'). If false returns exactly what was requested.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>false</allowableValues><allowableValues>true</allowableValues><dataType>string</dataType><description>Return suggestions (for correct spelling, case variants, etc.)</description><name>includeSuggestions</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Create word if not existing</description><name>shouldCreate</name><paramAccess>internal</paramAccess><paramType>query</paramType><required>false</required></parameters><responseClass>wordObject</responseClass><summary>Given a word as a string, returns the WordObject that represents it</summary></operations><path>/word.{format}/{word}</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><errorResponses><code>404</code><reason>No definitions found.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getDefinitions</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to return definitions for</description><name>word</name><paramType>path</paramType><required>true</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Maximum number of results to return</description><name>limit</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>noun</allowableValues><allowableValues>adjective</allowableValues><allowableValues>verb</allowableValues><allowableValues>adverb</allowableValues><allowableValues>interjection</allowableValues><allowableValues>pronoun</allowableValues><allowableValues>preposition</allowableValues><allowableValues>abbreviation</allowableValues><allowableValues>affix</allowableValues><allowableValues>article</allowableValues><allowableValues>auxiliary-verb</allowableValues><allowableValues>conjunction</allowableValues><allowableValues>definite-article</allowableValues><allowableValues>family-name</allowableValues><allowableValues>given-name</allowableValues><allowableValues>idiom</allowableValues><allowableValues>imperative</allowableValues><allowableValues>noun-plural</allowableValues><allowableValues>noun-posessive</allowableValues><allowableValues>past-participle</allowableValues><allowableValues>phrasal-prefix</allowableValues><allowableValues>proper-noun</allowableValues><allowableValues>proper-noun-plural</allowableValues><allowableValues>proper-noun-posessive</allowableValues><allowableValues>suffix</allowableValues><allowableValues>verb-intransitive</allowableValues><allowableValues>verb-transitive</allowableValues><dataType>string</dataType><description>CSV list of part-of-speech types</description><name>partOfSpeech</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>true</allowableValues><allowableValues>false</allowableValues><dataType>string</dataType><description>Return related words with definitions</description><name>includeRelated</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>ahd</allowableValues><allowableValues> century</allowableValues><allowableValues> wiktionary</allowableValues><allowableValues> webster</allowableValues><allowableValues> wordnet</allowableValues><dataType>string</dataType><description>Gets from dictionaries in the supplied order of precedence</description><name>sourceDictionaries</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>false</allowableValues><allowableValues>true</allowableValues><dataType>string</dataType><description>If true will try to return the correct word root ('cats' -&gt; 'cat'). If false returns exactly what was requested.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>false</allowableValues><allowableValues>true</allowableValues><dataType>string</dataType><description>Return a closed set of XML tags in response</description><name>includeTags</name><paramType>query</paramType><required>false</required></parameters><responseClass>List[definition]</responseClass><summary>Return definitions for a word</summary></operations><path>/word.{format}/{word}/definitions</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><errorResponses><code>404</code><reason>No stats available.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getWordStats</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to return stats for</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>If true will try to return the correct word root ('cats' -&gt; 'cat'). If false returns exactly what was requested.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Return detailed usage info</description><name>detailed</name><paramType>query</paramType><required>false</required></parameters><responseClass>wordStats</responseClass><summary>Returns word statistics</summary></operations><path>/word.{format}/{word}/stats</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getTopExample</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to fetch examples for</description><name>word</name><paramType>path</paramType><required>true</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Return results from a specific ContentProvider</description><name>contentProvider</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>false</allowableValues><allowableValues>true</allowableValues><dataType>string</dataType><description>If true will try to return the correct word root ('cats' -&gt; 'cat'). If false returns exactly what was requested.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Specify the internal storage engine.</description><name>internalDataStore</name><paramAccess>internal</paramAccess><paramType>query</paramType><required>false</required></parameters><responseClass>example</responseClass><summary>Returns a top example for a word</summary></operations><path>/word.{format}/{word}/topExample</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><errorResponses><code>404</code><reason>No results.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getPunctuationFactor</nickname><notes>Deprecated</notes><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to return</description><name>word</name><paramType>path</paramType><required>true</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Input is case sensitive</description><name>caseSensitive</name><paramAccess>internal</paramAccess><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Use the canonical form of the word.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><responseClass>punctuationFactor</responseClass><summary>Fetches other forms of a word</summary></operations><path>/word.{format}/{word}/punctuationFactor</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>contextualLookup</nickname><notes>Use the offset parameter when the word occurs more than once in the sentence</notes><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to return definitions for</description><name>word</name><paramType>path</paramType><required>true</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>The sentence in which the word occurs</description><name>sentence</name><paramType>query</paramType><required>true</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>0 to 4096</allowableValues><dataType>int</dataType><defaultValue>-1</defaultValue><description>The start character offset of the word in the given sentence</description><name>offset</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>true</allowableValues><allowableValues>false</allowableValues><dataType>string</dataType><description>Expand context terms using related words</description><name>expandTerms</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>ahd</allowableValues><allowableValues> century</allowableValues><allowableValues> wiktionary</allowableValues><allowableValues> webster</allowableValues><allowableValues> wordnet</allowableValues><dataType>string</dataType><description>Only include these comma-delimited source dictionaries</description><name>includeSourceDictionaries</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>ahd</allowableValues><allowableValues> century</allowableValues><allowableValues> wiktionary</allowableValues><allowableValues> webster</allowableValues><allowableValues> wordnet</allowableValues><dataType>string</dataType><description>Exclude these comma-delimited source dictionaries</description><name>excludeSourceDictionaries</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>0 to 1000</allowableValues><dataType>string</dataType><defaultValue>0</defaultValue><description>Results to skip</description><name>skip</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>1 to 1000</allowableValues><dataType>string</dataType><defaultValue>10</defaultValue><description>Maximum number of results to return</description><name>limit</name><paramType>query</paramType><required>false</required></parameters><responseClass>DefinitionSearchResults</responseClass><summary>Returns definitions for a word based on the sentence in which it is found</summary></operations><operations><errorResponses><code>400</code><reason>Invalid term supplied.</reason></errorResponses><httpMethod>POST</httpMethod><nickname>contextualLookupPost</nickname><notes>Use the offset parameter when the word occurs more than once in the sentence</notes><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to return definitions for</description><name>word</name><paramType>path</paramType><required>true</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>The sentence in which the word occurs</description><paramType>body</paramType><required>true</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>0 to 4096</allowableValues><dataType>int</dataType><defaultValue>-1</defaultValue><description>The start character offset of the word in the given sentence</description><name>offset</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>true</allowableValues><allowableValues>false</allowableValues><dataType>string</dataType><description>Expand context terms using related words</description><name>expandTerms</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>ahd</allowableValues><allowableValues> century</allowableValues><allowableValues> wiktionary</allowableValues><allowableValues> webster</allowableValues><allowableValues> wordnet</allowableValues><dataType>string</dataType><description>Only include these comma-delimited source dictionaries</description><name>includeSourceDictionaries</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>ahd</allowableValues><allowableValues> century</allowableValues><allowableValues> wiktionary</allowableValues><allowableValues> webster</allowableValues><allowableValues> wordnet</allowableValues><dataType>string</dataType><description>Exclude these comma-delimited source dictionaries</description><name>excludeSourceDictionaries</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>0 to 1000</allowableValues><dataType>string</dataType><defaultValue>0</defaultValue><description>Results to skip</description><name>skip</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>1 to 1000</allowableValues><dataType>string</dataType><defaultValue>10</defaultValue><description>Maximum number of results to return</description><name>limit</name><paramType>query</paramType><required>false</required></parameters><responseClass>DefinitionSearchResults</responseClass><summary>Returns definitions for a word based on the sentence in which it is found</summary></operations><path>/word.{format}/{word}/contextualLookup</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><errorResponses><code>404</code><reason>Word not found.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getCommentCount</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to get comment count for.</description><name>word</name><paramType>path</paramType><required>false</required></parameters><responseClass>long</responseClass><summary>Returns the number of comments on a word</summary></operations><path>/word.{format}/{word}/commentCount</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getCitations</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to get citations for.</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>false</allowableValues><allowableValues>true</allowableValues><dataType>string</dataType><description>If true will try to return a correct word root ('cats' -&gt; 'cat'). If false returns exactly what was requested.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.</description><name>sourceDictionary</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Maximum number of results to return</description><name>limit</name><paramType>query</paramType><required>false</required></parameters><responseClass>List[citation]</responseClass><summary>Returns citations for a word</summary></operations><path>/word.{format}/{word}/citations</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><errorResponses><code>404</code><reason>No definitions found.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getRelatedWords</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word for which to return related words</description><name>word</name><paramType>path</paramType><required>true</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>noun</allowableValues><allowableValues>adjective</allowableValues><allowableValues>verb</allowableValues><allowableValues>adverb</allowableValues><allowableValues>interjection</allowableValues><allowableValues>pronoun</allowableValues><allowableValues>preposition</allowableValues><allowableValues>abbreviation</allowableValues><allowableValues>affix</allowableValues><allowableValues>article</allowableValues><allowableValues>auxiliary-verb</allowableValues><allowableValues>conjunction</allowableValues><allowableValues>definite-article</allowableValues><allowableValues>family-name</allowableValues><allowableValues>given-name</allowableValues><allowableValues>idiom</allowableValues><allowableValues>imperative</allowableValues><allowableValues>noun-plural</allowableValues><allowableValues>noun-posessive</allowableValues><allowableValues>past-participle</allowableValues><allowableValues>phrasal-prefix</allowableValues><allowableValues>proper-noun</allowableValues><allowableValues>proper-noun-plural</allowableValues><allowableValues>proper-noun-posessive</allowableValues><allowableValues>suffix</allowableValues><allowableValues>verb-intransitive</allowableValues><allowableValues>verb-transitive</allowableValues><dataType>string</dataType><description>CSV list of part-of-speech types</description><name>partOfSpeech</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>ahd</allowableValues><allowableValues> century</allowableValues><allowableValues> wiktionary</allowableValues><allowableValues> webster</allowableValues><allowableValues> wordnet</allowableValues><dataType>string</dataType><description>Get data from a single dictionary</description><name>sourceDictionary</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Maximum number of results to return</description><name>limit</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>false</allowableValues><allowableValues>true</allowableValues><dataType>string</dataType><description>If true will try to return the correct word root ('cats' -&gt; 'cat'). If false returns exactly what was requested.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>synonym</allowableValues><allowableValues>antonym</allowableValues><allowableValues>variant</allowableValues><allowableValues>equivalent</allowableValues><allowableValues>cross-reference</allowableValues><allowableValues>related-word</allowableValues><allowableValues>rhyme</allowableValues><allowableValues>form</allowableValues><allowableValues>etymologically-related-term</allowableValues><allowableValues>hypernym</allowableValues><allowableValues>hyponym</allowableValues><allowableValues>inflected-form</allowableValues><allowableValues>primary</allowableValues><allowableValues>same-context</allowableValues><allowableValues>verb-form</allowableValues><allowableValues>verb-stem</allowableValues><allowableValues>unknown</allowableValues><dataType>string</dataType><description>Relationship type</description><name>type</name><paramType>query</paramType><required>false</required></parameters><responseClass>List[related]</responseClass><summary>Return related words (thesaurus data) for a word</summary></operations><path>/word.{format}/{word}/related</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied</reason></errorResponses><errorResponses><code>404</code><reason>Supplied user does not exist</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getListedIn</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to fetch WordLists for</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>rating</allowableValues><dataType>string</dataType><description>Specifies a sort parameter</description><name>sortBy</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Maximum number of results to return</description><name>limit</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>User to scope the request to</description><name>username</name><paramType>query</paramType><required>false</required></parameters><responseClass>List[wordList]</responseClass><summary>Returns WordLists containing a word</summary></operations><path>/word.{format}/{word}/listedIn</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><errorResponses><code>404</code><reason>Word not found.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getListedInCount</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to fetch count for</description><name>word</name><paramType>path</paramType><required>false</required></parameters><responseClass>long</responseClass><summary>Returns a count of lists a word appears in</summary></operations><path>/word.{format}/{word}/listedInCount</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><errorResponses><code>404</code><reason>Word not found.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getFirstListedIn</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to fetch a WordList for</description><name>word</name><paramType>path</paramType><required>false</required></parameters><responseClass>wordList</responseClass><summary>Returns the first WordList a word appeared in</summary></operations><path>/word.{format}/{word}/firstListedIn</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><errorResponses><code>404</code><reason>Word not found.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getFirstListedBy</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to fetch a User for</description><name>word</name><paramType>path</paramType><required>false</required></parameters><responseClass>user</responseClass><summary>Returns the first User to list a particular word</summary></operations><path>/word.{format}/{word}/firstListedBy</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getTextPronunciations</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to get pronunciations for</description><name>word</name><paramType>path</paramType><required>true</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>false</allowableValues><allowableValues>true</allowableValues><dataType>string</dataType><description>If true will try to return a correct word root ('cats' -&gt; 'cat'). If false returns exactly what was requested.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>ahd</allowableValues><allowableValues>century</allowableValues><allowableValues>cmu</allowableValues><allowableValues>macmillan</allowableValues><allowableValues>wiktionary</allowableValues><allowableValues>webster</allowableValues><allowableValues>wordnet</allowableValues><dataType>string</dataType><description>Get from a single dictionary.</description><name>sourceDictionary</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>ahd</allowableValues><allowableValues>arpabet</allowableValues><allowableValues>gcide-diacritical</allowableValues><allowableValues>IPA</allowableValues><dataType>string</dataType><description>Text pronunciation type</description><name>typeFormat</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Maximum number of results to return</description><name>limit</name><paramType>query</paramType><required>false</required></parameters><responseClass>List[textPron]</responseClass><summary>Returns text pronunciations for a given word</summary></operations><path>/word.{format}/{word}/pronunciations</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getFlickrImages</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to get flickr images for.</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>thumb</allowableValues><allowableValues>small</allowableValues><allowableValues>med</allowableValues><allowableValues>lg</allowableValues><allowableValues>orig</allowableValues><dataType>string</dataType><description>Image size</description><name>size</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Maximum number of results to return</description><name>limit</name><paramType>query</paramType><required>false</required></parameters><responseClass>List[photo]</responseClass><summary>Returns Flickr images for a word</summary></operations><path>/word.{format}/{word}/images/flickr</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><errorResponses><code>404</code><reason>No scrabble score found.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getScrabbleScore</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to get scrabble score for.</description><name>word</name><paramType>path</paramType><required>false</required></parameters><responseClass>long</responseClass><summary>Returns the Scrabble score for a word</summary></operations><path>/word.{format}/{word}/scrabbleScore</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getHyphenation</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to get syllables for</description><name>word</name><paramType>path</paramType><required>true</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>If true will try to return a correct word root ('cats' -&gt; 'cat'). If false returns exactly what was requested.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.</description><name>sourceDictionary</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Maximum number of results to return</description><name>limit</name><paramType>query</paramType><required>false</required></parameters><responseClass>List[syllable]</responseClass><summary>Returns syllable information for a word</summary></operations><path>/word.{format}/{word}/hyphenation</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getUnigramCountInternal</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to get unigram count for.</description><name>word</name><paramType>path</paramType><required>false</required></parameters><responseClass>long</responseClass><summary>Returns syllable information for a word</summary></operations><path>/word.{format}/{word}/unigramCountInternal</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getBigramsInternal</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to get bigrams for.</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Gamma filter</description><name>gamma</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>WLMI Limit</description><name>minWlmi</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Maximum number of results to return</description><name>limit</name><paramType>query</paramType><required>false</required></parameters><responseClass>List[bigram]</responseClass><summary>Returns Bigrams for the given word</summary></operations><path>/word.{format}/{word}/phrasesInternal</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><errorResponses><code>404</code><reason>Word not found.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getLookupCount</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to get Bigrams for</description><name>word</name><paramType>path</paramType><required>false</required></parameters><responseClass>long</responseClass><summary>Returns the number of times a word has been viewed</summary></operations><path>/word.{format}/{word}/lookupCount</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getTagsOnWord</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to fetch Tags on</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Use the canonical form of the word.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Restrict to a particular user</description><name>username</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Maximum number of results to return</description><name>limit</name><paramType>query</paramType><required>false</required></parameters><responseClass>List[tag]</responseClass><summary>Fetches tags for a word</summary></operations><path>/word.{format}/{word}/tags</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getTagCountOnWord</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to fetch Tag count on</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Use the canonical form of the word.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Restrict to a particular user</description><name>username</name><paramType>query</paramType><required>false</required></parameters><responseClass>long</responseClass><summary>Fetches tag count for a word</summary></operations><path>/word.{format}/{word}/tagCount</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>POST</httpMethod><nickname>addTagToWord</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to add a Tag to</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>CSV list of tags to add.</description><name>tags</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Add tag on behalf of a particular user</description><name>username</name><paramAccess>internal</paramAccess><paramType>query</paramType><required>false</required></parameters><responseClass>ok</responseClass><summary>Adds a tag to a word</summary></operations><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>DELETE</httpMethod><nickname>deleteTagFromWord</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to add a Tag to</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>CSV list of tags to remove.</description><name>tags</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Remove tag on behalf of a particular user</description><name>username</name><paramAccess>internal</paramAccess><paramType>query</paramType><required>false</required></parameters><responseClass>ok</responseClass><summary>Removes a tag from a word</summary></operations><path>/word.{format}/{word}/tag</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><errorResponses><code>404</code><reason>No results.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getWordFrequency</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to return</description><name>word</name><paramType>path</paramType><required>true</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Input is case sensitive</description><name>caseSensitive</name><paramAccess>internal</paramAccess><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>If true will try to return the correct word root ('cats' -&gt; 'cat'). If false returns exactly what was requested.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Starting Year</description><name>startYear</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Ending Year</description><name>endYear</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Get error bar data</description><name>includeErrorBars</name><paramAccess>internal</paramAccess><paramType>query</paramType><required>false</required></parameters><responseClass>frequencySummary</responseClass><summary>Returns word usage over time</summary></operations><path>/word.{format}/{word}/frequency</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getFirstUsageOfWord</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to return first usage for</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Use the canonical form of the word.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Return detailed usage info</description><name>detailed</name><paramType>query</paramType><required>false</required></parameters><responseClass>detailedWordUsage</responseClass><summary>Returns first usage of a word</summary></operations><path>/word.{format}/{word}/firstUsed</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>POST</httpMethod><nickname>addWordView</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to record a word view for</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>ID of the user viewing the word</description><name>userId</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Tracking ID for the user</description><name>userGuid</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Session ID for the user</description><name>userSessionId</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Internal IP address of the web server</description><name>serverIp</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Page being viewed</description><name>pageName</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Method of the word view</description><name>method</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Browser user agent</description><name>userAgent</name><paramType>query</paramType><required>false</required></parameters><responseClass>ok</responseClass><summary>Records a word view from the website</summary></operations><path>/word.{format}/{word}/wordView</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied</reason></errorResponses><errorResponses><code>404</code><reason>No user found</reason></errorResponses><httpMethod>GET</httpMethod><nickname>isFavorite</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to check</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Use the canonical form of the word.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Check for a particular user</description><name>userName</name><paramAccess>internal</paramAccess><paramType>query</paramType><required>true</required></parameters><responseClass>BooleanValue</responseClass><summary>Checks to see if a word is a user's favorite</summary></operations><path>/word.{format}/{word}/isFavorite</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied</reason></errorResponses><errorResponses><code>404</code><reason>No user found</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getFavoriteCount</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to check</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Use the canonical form of the word.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Check for a particular user</description><name>userName</name><paramAccess>internal</paramAccess><paramType>query</paramType><required>false</required></parameters><responseClass>long</responseClass><summary>Returns the number of times a word has been Favorited</summary></operations><path>/word.{format}/{word}/favoriteCount</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><errorResponses><code>404</code><reason>No user found</reason></errorResponses><httpMethod>POST</httpMethod><nickname>addWordToFavorites</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to favorite</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Add as favorite on behalf of a particular user</description><name>userName</name><paramAccess>internal</paramAccess><paramType>query</paramType><required>false</required></parameters><responseClass>ok</responseClass><summary>Favorites a Word for a user</summary></operations><operations><errorResponses><code>400</code><reason>Invalid word supplied or no user found.</reason></errorResponses><httpMethod>DELETE</httpMethod><nickname>deleteFromFavorites</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to remove</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Remove on behalf of a particular user</description><name>userName</name><paramAccess>internal</paramAccess><paramType>query</paramType><required>false</required></parameters><responseClass>ok</responseClass><summary>Removes a Word from a user's Favorites</summary></operations><path>/word.{format}/{word}/favorite</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getPhrases</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to fetch phrases for</description><name>word</name><paramType>path</paramType><required>true</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Maximum number of results to return</description><name>limit</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Minimum WLMI for the phrase</description><name>wlmi</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>false</allowableValues><allowableValues>true</allowableValues><dataType>string</dataType><description>If true will try to return the correct word root ('cats' -&gt; 'cat'). If false returns exactly what was requested.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><responseClass>List[bigram]</responseClass><summary>Fetches bi-gram phrases for a word</summary></operations><path>/word.{format}/{word}/phrases</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><errorResponses><code>404</code><reason>No definitions found.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getEtymologies</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to return</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>ahd</allowableValues><allowableValues>webster</allowableValues><allowableValues>wiktionary</allowableValues><dataType>string</dataType><description>Get etymologies from a single dictionary. Options are ahd or century.</description><name>sourceDictionary</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>false</allowableValues><allowableValues>true</allowableValues><dataType>string</dataType><description>If true will try to return the correct word root ('cats' -&gt; 'cat'). If false returns exactly what was requested.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>ahd</allowableValues><allowableValues>webster</allowableValues><allowableValues>wiktionary</allowableValues><dataType>string</dataType><description>Etymology type</description><name>type</name><paramType>query</paramType><required>false</required></parameters><responseClass>String</responseClass><summary>Fetches etymology data</summary></operations><path>/word.{format}/{word}/etymologies</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getOtherFormsInternal</nickname><notes>Deprecated</notes><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to return</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Maximum number of results to return</description><name>limit</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Minimum corpus frequency</description><name>minFrequency</name><paramType>query</paramType><required>false</required></parameters><responseClass>List[otherForms]</responseClass><summary>Fetches other forms of a word</summary></operations><path>/word.{format}/{word}/otherFormsInternal</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><errorResponses><code>404</code><reason>No results.</reason></errorResponses><httpMethod>POST</httpMethod><nickname>addWordRelationshipInternal</nickname><notes>Deprecated</notes><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to return</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>relatedData</dataType><description>Relationship to add</description><paramType>body</paramType><required>false</required></parameters><responseClass>ok</responseClass><summary>Adds a word relationship</summary></operations><path>/word.{format}/{word}/wordRelationshipInternal</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getCommentsOnWord</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to return Comments for</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><allowableValues>ascending</allowableValues><allowableValues>descending</allowableValues><dataType>string</dataType><defaultValue>descending</defaultValue><description>Direction to sort by</description><name>sortOrder</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Results to skip</description><name>skip</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Maximum number of results to return</description><name>limit</name><paramType>query</paramType><required>false</required></parameters><responseClass>List[comment]</responseClass><summary>Fetches comments on a Word</summary></operations><path>/word.{format}/{word}/comments</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word or Comment supplied.</reason></errorResponses><errorResponses><code>404</code><reason>Word or commentor not found.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getCommentOnWord</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to fetch Comment for.</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>ID of Comment to fetch.</description><name>commentId</name><paramType>path</paramType><required>false</required></parameters><responseClass>comment</responseClass><summary>Fetches a Comment by ID</summary></operations><operations><errorResponses><code>400</code><reason>Invalid word or Comment supplied.</reason></errorResponses><errorResponses><code>404</code><reason>Word or commentor not found.</reason></errorResponses><httpMethod>DELETE</httpMethod><nickname>deleteCommentByIdOnWord</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to update Comment on.</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Updated Comment.</description><name>commentId</name><paramType>path</paramType><required>false</required></parameters><responseClass>ok</responseClass><summary>Deletes an existing word comment</summary></operations><path>/word.{format}/{word}/comment/{commentId}</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word or Comment supplied.</reason></errorResponses><errorResponses><code>404</code><reason>Word or commentor not found.</reason></errorResponses><httpMethod>POST</httpMethod><nickname>commentOnWord</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to add Comment to.</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>comment</dataType><description>Comment to add.</description><paramType>body</paramType><required>false</required></parameters><responseClass>comment</responseClass><summary>Adds a comment to a word</summary></operations><operations><errorResponses><code>400</code><reason>Invalid word or Comment supplied.</reason></errorResponses><errorResponses><code>404</code><reason>Word or commentor not found.</reason></errorResponses><httpMethod>PUT</httpMethod><nickname>updateCommentOnWord</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to update Comment on.</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>comment</dataType><description>Updated Comment.</description><paramType>body</paramType><required>false</required></parameters><responseClass>comment</responseClass><summary>Updates an existing word comment</summary></operations><path>/word.{format}/{word}/comment</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getAudio</nickname><notes>The metadata includes a time-expiring fileUrl which allows reading the audio file directly from the API.  Currently only audio pronunciations from the American Heritage Dictionary in mp3 format are supported.</notes><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to get audio for.</description><name>word</name><paramType>path</paramType><required>true</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Use the canonical form of the word.</description><name>useCanonical</name><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Use the V3 api.</description><name>v3Format</name><paramAccess>internal</paramAccess><paramType>query</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Maximum number of results to return</description><name>limit</name><paramType>query</paramType><required>false</required></parameters><responseClass>List[audioFile]</responseClass><summary>Fetches audio metadata for a word.</summary></operations><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>POST</httpMethod><nickname>addAudio</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to add audio to.</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>audioObject</dataType><description>AudioPon metadata to add.</description><paramType>body</paramType><required>false</required></parameters><responseClass>ok</responseClass><summary>Creates AudioPron metadata</summary></operations><path>/word.{format}/{word}/audio</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid pron id supplied.</reason></errorResponses><httpMethod>GET</httpMethod><nickname>getPronunciation</nickname><notes>The metadata includes a time-expiring fileUrl which allows reading the audio file directly from the API.  Currently only audio pronunciations from the American Heritage Dictionary in mp3 format are supported.</notes><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to get audio for.</description><name>word</name><paramType>path</paramType><required>true</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Id to get audio for.</description><name>pronId</name><paramType>path</paramType><required>true</required></parameters><responseClass>audioFile</responseClass><summary>Fetches single audio pronunciation.</summary></operations><path>/word.{format}/{word}/pronunciation/{pronId}</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><httpMethod>PUT</httpMethod><nickname>updateAudioInternal</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>audio object to update</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>audioObject</dataType><description>Updated metadata.</description><paramType>body</paramType><required>false</required></parameters><responseClass>ok</responseClass><summary>Internal method to update an audio object</summary></operations><path>/word.{format}/{word}/audioInternal</path></apis><apis><description></description><operations><errorResponses><code>400</code><reason>Invalid word supplied.</reason></errorResponses><errorResponses><code>401</code><reason>Unauthorized.</reason></errorResponses><httpMethod>DELETE</httpMethod><nickname>deleteAudio</nickname><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>Word to delete audio from.</description><name>word</name><paramType>path</paramType><required>false</required></parameters><parameters><allowMultiple>false</allowMultiple><dataType>string</dataType><description>AudioPon metadata to add.</description><name>audio_id</name><paramType>path</paramType><required>false</required></parameters><responseClass>ok</responseClass><summary>Deletes an AudioPron</summary></operations><path>/word.{format}/{word}/audio/{audio_id}</path></apis><basePath>url</basePath><resourcePath>/word</resourcePath><models/><swaggerVersion>1.0</swaggerVersion></ApiDocumentation>"
+    http_version: "1.1"
+  :@ignored: false

data/spec/wordnik_spec.rb

@@ -10,72 +10,123 @@ describe Wordnik do
   after(:each) do
   end
 
-  context "initialization" do
+  context 'initialization' do
+    
+    context 'URL stuff' do
+
+      context 'host' do
+        it 'removes http from host' do
+          Wordnik.configure {|c| c.host = 'http://example.com' } 
+          Wordnik.configuration.host.should == 'example.com'
+        end
+
+        it 'removes https from host' do
+          Wordnik.configure {|c| c.host = 'https://wookiee.com' } 
+          Wordnik.configuration.host.should == 'wookiee.com'
+        end
 
-    context "resources" do
-      it "instantiates resources from cached JSON" do
+        it 'removes trailing path from host' do
+          Wordnik.configure {|c| c.host = 'hobo.com/v4' } 
+          Wordnik.configuration.host.should == 'hobo.com'
+        end
+      end
+      
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          Wordnik.configure {|c| c.base_path = 'v4/dog' } 
+          Wordnik.configuration.base_path.should == '/v4/dog'
+        end
+        
+        it "doesn't prepend a slash if one is already there" do
+          Wordnik.configure {|c| c.base_path = '/v4/dog' }
+          Wordnik.configuration.base_path.should == '/v4/dog'
+        end
+        
+        it "ends up as a blank string if nil" do
+          Wordnik.configure {|c| c.base_path = nil }
+          Wordnik.configuration.base_path.should == ''
+        end
+        
+      end
+
+    end
+
+    context 'resources' do
+      it 'instantiates resources from cached JSON' do
         Wordnik.resources.class.should == Hash
         Wordnik.resources[:word].class.should == Wordnik::Resource
       end
       
-      it "has as many resources as there are resource names" do
+      it 'has as many resources as there are resource names' do
         Wordnik.resources.size.should == Wordnik.configuration.resource_names.size
       end
 
-      it "assigns resource keys that match the resource names" do
+      it 'assigns resource keys that match the resource names' do
         Wordnik.resources[:word].name.should == :word 
       end
 
     end
     
-    context "authentication" do
+    context 'authentication' do
       
       before(:each) do
       end
       
-      it "auto-authenticates at load time if username and password are present"
+      it 'auto-authenticates at load time if username and password are present'
       
-      it "succeeds if a username and password are present in the configuration" do
-        Wordnik.authenticate
+      it 'succeeds if a username and password are present in the configuration' do
+        VCR.use_cassette('wordnik_authenticate', :record => :new_episodes) do
+          Wordnik.authenticate
+        end
         Wordnik.authenticated?.should == true
       end
       
-      it "de_authenticates" do
-        Wordnik.authenticate
+      it 'de_authenticates' do
+        VCR.use_cassette('wordnik_authenticate', :record => :new_episodes) do
+          Wordnik.authenticate
+        end
         Wordnik.authenticated?.should == true
         Wordnik.de_authenticate
         Wordnik.authenticated?.should == false
       end
       
-      it "fails if credentials are invalid" do
+      it 'fails if credentials are invalid' do
         Wordnik.de_authenticate
         Wordnik.configure do |config|
           config.api_key = CREDENTIALS[:api_key]
           config.username = CREDENTIALS[:username]
           config.password = 'wrong!'
-          config.base_uri = "beta.wordnik.com/v4"
+          config.host = 'beta.wordnik.com'
+          config.base_path = '/v4'
+        end
+
+        VCR.use_cassette('wordnik_authenticate_fail', :record => :new_episodes) do
+          expect { Wordnik.authenticate }.to raise_error(ClientError)
         end
-        expect { Wordnik.authenticate }.to raise_error(ClientError)
+        
         Wordnik.authenticated?.should == false
+        configure_wordnik
       end
       
-      it "fails if username and/or password are absent" do
+      it 'fails if username and/or password are absent' do
         Wordnik.de_authenticate
         Wordnik.configure do |config|
           config.api_key = CREDENTIALS[:api_key]
           config.username = nil
           config.password = nil
-          config.base_uri = "beta.wordnik.com/v4"
+          config.host = 'beta.wordnik.com'
+          config.base_path = '/v4'
         end
         expect { Wordnik.authenticate }.to raise_error(ClientError, /username and password are required/i)
         Wordnik.authenticated?.should == false
+        configure_wordnik
       end
       
     end
     
   end
   
-  it "maps shorthand Wordnik.resource calls to their resources" do
+  it 'maps shorthand Wordnik.resource calls to their resources' do
     Wordnik.word.class.should == Wordnik::Resource
     Wordnik.word.name.should == :word
   end  

data/wordnik.gemspec

@@ -24,6 +24,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '>=2.5.0'
   s.add_development_dependency 'vcr', '>=1.5.1'
   s.add_development_dependency 'webmock', '>=1.6.2'
+  s.add_development_dependency 'autotest'  
+  s.add_development_dependency 'autotest-rails-pure'
 
   s.files         = [
     `git ls-files`,

metadata

@@ -2,7 +2,7 @@
 name: wordnik
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 4.06.05
+  version: 4.06.06
 platform: ruby
 authors: 
 - Zeke Sikelianos
@@ -11,8 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-15 00:00:00 -07:00
-default_executable: 
+date: 2011-08-29 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: typhoeus
@@ -113,6 +112,28 @@ dependencies:
         version: 1.6.2
   type: :development
   version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: autotest
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: autotest-rails-pure
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id011
 description: This gem provides a simple interface to the entire Wordnik API. Its methods are defined by the documentation that comes from the API itself, so it's guaranteed to be up to date.
 email: 
 - zeke@wordnik.com
@@ -125,6 +146,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
 - .rspec-tm
 - Gemfile
 - Gemfile.lock
@@ -132,9 +154,13 @@ files:
 - Rakefile
 - api_docs/.gitkeep
 - api_docs/account.json
+- api_docs/analytics.json
 - api_docs/corpus.json
 - api_docs/document.json
+- api_docs/partner.json
 - api_docs/partners.json
+- api_docs/suggest.json
+- api_docs/system.json
 - api_docs/tag.json
 - api_docs/user.json
 - api_docs/users.json
@@ -152,9 +178,13 @@ files:
 - lib/wordnik/resource.rb
 - lib/wordnik/resource_modules/.gitkeep
 - lib/wordnik/resource_modules/account.rb
+- lib/wordnik/resource_modules/analytics.rb
 - lib/wordnik/resource_modules/corpus.rb
 - lib/wordnik/resource_modules/document.rb
+- lib/wordnik/resource_modules/partner.rb
 - lib/wordnik/resource_modules/partners.rb
+- lib/wordnik/resource_modules/suggest.rb
+- lib/wordnik/resource_modules/system.rb
 - lib/wordnik/resource_modules/tag.rb
 - lib/wordnik/resource_modules/user.rb
 - lib/wordnik/resource_modules/users.rb
@@ -173,9 +203,15 @@ files:
 - spec/response_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/vcr/crazier_json_request.yml
+- spec/vcr/default_response.yml
+- spec/vcr/get_word_dynamo.yml
+- spec/vcr/unauthorized_response.yml
+- spec/vcr/wordnik_authenticate.yml
+- spec/vcr/wordnik_authenticate_fail.yml
+- spec/vcr/xml_response_request.yml
 - spec/wordnik_spec.rb
 - wordnik.gemspec
-has_rdoc: true
 homepage: http://developer.wordnik.com
 licenses: []
 
@@ -199,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: wordnik
-rubygems_version: 1.5.1
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A ruby wrapper for the Wordnik API
@@ -213,4 +249,11 @@ test_files:
 - spec/response_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/vcr/crazier_json_request.yml
+- spec/vcr/default_response.yml
+- spec/vcr/get_word_dynamo.yml
+- spec/vcr/unauthorized_response.yml
+- spec/vcr/wordnik_authenticate.yml
+- spec/vcr/wordnik_authenticate_fail.yml
+- spec/vcr/xml_response_request.yml
 - spec/wordnik_spec.rb