wordnik 4.06.08 → 4.06.10

Sign up to get free protection for your applications and to get access to all the features.
Files changed (27) hide show
  1. data/Rakefile +3 -3
  2. data/api_docs/account.json +1 -1
  3. data/api_docs/analytics.json +1 -1
  4. data/api_docs/corpus.json +1 -1
  5. data/api_docs/document.json +1 -1
  6. data/api_docs/glossary.json +1 -0
  7. data/api_docs/suggest.json +1 -1
  8. data/api_docs/system.json +1 -1
  9. data/api_docs/tag.json +1 -1
  10. data/api_docs/user.json +1 -1
  11. data/api_docs/users.json +1 -1
  12. data/api_docs/word.json +1 -1
  13. data/api_docs/wordList.json +1 -1
  14. data/api_docs/wordLists.json +1 -1
  15. data/api_docs/words.json +1 -1
  16. data/lib/wordnik/resource_modules/account.rb +0 -26
  17. data/lib/wordnik/resource_modules/corpus.rb +0 -53
  18. data/lib/wordnik/resource_modules/{partners.rb → glossary.rb} +43 -76
  19. data/lib/wordnik/resource_modules/system.rb +22 -22
  20. data/lib/wordnik/resource_modules/user.rb +1 -1
  21. data/lib/wordnik/resource_modules/word.rb +30 -3
  22. data/lib/wordnik/resource_modules/words.rb +3 -57
  23. data/lib/wordnik/version.rb +1 -1
  24. metadata +4 -6
  25. data/api_docs/partner.json +0 -1
  26. data/api_docs/partners.json +0 -1
  27. data/lib/wordnik/resource_modules/partner.rb +0 -140
data/Rakefile CHANGED
@@ -15,9 +15,9 @@ task :swagger do
15
15
  # Configure default input values..
16
16
  settings = {
17
17
  :scheme => 'http',
18
- :host => 'localhost:8001',
19
- :base_path => "/admin/api",
20
- :api_key => 'b39ee8d5f05d0f566a0080b4c310ceddf5dc5f7606a616f53',
18
+ :host => 'beta.wordnik.com',
19
+ :base_path => "/v4",
20
+ :api_key => '',
21
21
  }
22
22
 
23
23
  # Ask user for each setting, using the defaults where user input is blank
data/api_docs/account.json CHANGED
@@ -1 +1 @@
1
- {"resourcePath":"/account","models":{"ApiTokenStatus":{"properties":{"token":{"type":"string","required":false,"uniqueItems":false},"resetsInMillis":{"type":"long","required":false,"uniqueItems":false},"remainingCalls":{"type":"long","required":false,"uniqueItems":false},"expiresInMillis":{"type":"long","required":false,"uniqueItems":false},"totalRequests":{"type":"long","required":false,"uniqueItems":false}},"id":"ApiTokenStatus","type":"any","required":false,"uniqueItems":false},"AuthenticationToken":{"properties":{"token":{"type":"string","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"userSignature":{"type":"string","required":false,"uniqueItems":false}},"id":"AuthenticationToken","type":"any","required":false,"uniqueItems":false},"ApiResponse":{"properties":{"message":{"type":"string","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false}},"id":"ApiResponse","type":"any","required":false,"uniqueItems":false},"UserHandle":{"properties":{"webService":{"type":"int","required":false,"uniqueItems":false},"handle":{"type":"string","required":false,"uniqueItems":false}},"id":"UserHandle","type":"any","required":false,"uniqueItems":false},"UserSettings":{"properties":{"bossURL":{"type":"string","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false}},"id":"UserSettings","type":"any","required":false,"uniqueItems":false},"UserTrackingInfo":{"properties":{"signupDate":{"type":"Date","required":false,"uniqueItems":false},"lastLoginDate":{"type":"Date","required":false,"uniqueItems":false},"noOfLogins":{"type":"int","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"lastUpdatedDate":{"type":"Date","required":false,"uniqueItems":false},"signupIPAddress":{"type":"string","required":false,"uniqueItems":false}},"id":"UserTrackingInfo","type":"any","required":false,"uniqueItems":false},"UserProfile":{"properties":{"lastName":{"type":"string","required":false,"uniqueItems":false},"mostFavoriteWord":{"type":"string","required":false,"uniqueItems":false},"location":{"type":"string","required":false,"uniqueItems":false},"seekingWord":{"type":"string","required":false,"uniqueItems":false},"leastFavoriteWord":{"type":"string","required":false,"uniqueItems":false},"onomaTopoeiaWord":{"type":"string","required":false,"uniqueItems":false},"siteUrl":{"type":"string","required":false,"uniqueItems":false},"bio":{"type":"string","required":false,"uniqueItems":false},"userHandles":{"type":"array","required":false,"items":{"$ref":"UserHandle","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"youWord":{"type":"string","required":false,"uniqueItems":false},"firstName":{"type":"string","required":false,"uniqueItems":false},"siteName":{"type":"string","required":false,"uniqueItems":false}},"id":"UserProfile","type":"any","required":false,"uniqueItems":false},"apiApplication":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"userName":{"type":"string","required":false,"uniqueItems":false},"approvalState":{"type":"ApiApprovalState","required":false,"uniqueItems":false},"comment":{"type":"string","required":false,"uniqueItems":false}},"id":"apiApplication","type":"any","required":false,"uniqueItems":false},"ApiApprovalState":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"ApiApprovalState","type":"any","required":false,"uniqueItems":false},"user":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"email":{"type":"string","required":false,"uniqueItems":false},"status":{"type":"int","required":false,"uniqueItems":false},"faceBookId":{"type":"string","required":false,"uniqueItems":false},"userName":{"type":"string","required":false,"uniqueItems":false},"displayName":{"type":"string","required":false,"uniqueItems":false},"password":{"type":"string","required":false,"uniqueItems":false}},"id":"user","type":"any","required":false,"uniqueItems":false},"wordList":{"properties":{"updatedAt":{"type":"Date","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"username":{"type":"string","required":false,"uniqueItems":false},"permalink":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"numberWordsInList":{"type":"long","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false}},"id":"wordList","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/account.{format}/authenticate/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"A confirmed Wordnik username","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"password","description":"The user's password","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Authenticates a User","httpMethod":"GET","errorResponses":[{"reason":"Account not available.","code":403},{"reason":"User not found.","code":404}],"nickname":"authenticate","responseClass":"AuthenticationToken"},{"parameters":[{"name":"username","description":"A confirmed Wordnik username","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"The user's password","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Authenticates a user","httpMethod":"POST","errorResponses":[{"reason":"Account not available.","code":403},{"reason":"User not found.","code":404}],"nickname":"authenticatePost","responseClass":"AuthenticationToken"}]},{"path":"/account.{format}/logout","description":"","operations":[{"parameters":[{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Logs out a user","httpMethod":"GET","nickname":"logout","responseClass":"ok"}]},{"path":"/account.{format}/wordLists","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches WordList objects for the logged-in user.","httpMethod":"GET","errorResponses":[{"reason":"Not authenticated.","code":403},{"reason":"User account not found.","code":404}],"nickname":"getWordListsForCurrentUser","responseClass":"List[wordList]"}]},{"path":"/account.{format}/forgotPassword/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Authenticates a User","httpMethod":"GET","errorResponses":[{"reason":"User is Facebook Connected","code":400},{"reason":"User not found","code":404}],"nickname":"getForgotPassword","responseClass":"String"}]},{"path":"/account.{format}/resetPassword/{hashcode}","description":"","operations":[{"parameters":[{"name":"hashcode","description":"Password reset code","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches a User by code","httpMethod":"GET","errorResponses":[{"reason":"Invalid code supplied","code":400},{"reason":"User not found or code invalid.","code":404}],"nickname":"resetPassword","responseClass":"user"}]},{"path":"/account.{format}/apiAccountApplication","description":"","operations":[{"parameters":[{"description":"API Application Info","required":true,"dataType":"apiApplication","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Creates an API account application.","httpMethod":"POST","errorResponses":[{"reason":"Account not available.","code":403},{"reason":"User not found.","code":404}],"nickname":"createApiAccount","responseClass":"ApiResponse"}]},{"path":"/account.{format}/regenerateApiToken","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Regenerates an API Token. Currently not supported or tested.","httpMethod":"GET","errorResponses":[{"reason":"Invalid token supplied.","code":400}],"nickname":"createApiAccount","responseClass":"ok"}]},{"path":"/account.{format}/apiTokenStatus","description":"","operations":[{"parameters":[{"name":"api_key","description":"Wordnik authentication token","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"api_key","description":"Wordnik authentication token","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns usage statistics for the API account.","httpMethod":"GET","errorResponses":[{"reason":"No token supplied.","code":400},{"reason":"No API account with supplied token.","code":404}],"nickname":"getApiTokenStatus","responseClass":"ApiTokenStatus"}]},{"path":"/account.{format}/logVisit","description":"","operations":[{"parameters":[{"name":"userId","description":"User ID to track data for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"userGuid","description":"User's persistent GUID","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"userSessionId","description":"User's session ID","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"userIpAddress","description":"User IP address","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"serverIp","description":"Server IP address","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Logs a VisitAction for the user","httpMethod":"POST","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"logVisitForUser","responseClass":"Stirng","notes":"Requires a valid auth_token to be set."}]},{"path":"/account.{format}/activationCode/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns an activation code given a username","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"getActivationCodeForUser","responseClass":"String","notes":"If an activation code is not available, will return null."}]},{"path":"/account.{format}/activate","description":"","operations":[{"parameters":[{"description":"Activation Code","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Activates an account.","httpMethod":"POST","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"No activation code found.","code":404}],"nickname":"activateUser","responseClass":"user"}]},{"path":"/account.{format}/usernameAvailable/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns an ApiResponse indicating whether or not a username is available","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"getUsernameAvailable","responseClass":"ApiResponse"}]},{"path":"/account.{format}/user","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Returns the logged-in User","httpMethod":"GET","errorResponses":[{"reason":"Not logged in.","code":403},{"reason":"User not found.","code":404}],"nickname":"getLoggedInUser","responseClass":"user","notes":"Requires a valid auth_token to be set."}]},{"path":"/account.{format}/profile","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Returns profile info for the logged-in user","httpMethod":"GET","errorResponses":[{"reason":"Not logged in.","code":403},{"reason":"User not found.","code":404}],"nickname":"getLoggedInUserProfile","responseClass":"UserProfile","notes":"Requires a valid auth_token to be set."}]},{"path":"/account.{format}/settings","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Returns logged-in User Settings","httpMethod":"GET","errorResponses":[{"reason":"Not logged in.","code":403},{"reason":"User not found.","code":404}],"nickname":"getLoggedInUserSettings","responseClass":"UserSettings","notes":"Requires a valid auth_token to be set."}]},{"path":"/account.{format}/trackingInfo","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Returns logged-in User TrackingInfo.","httpMethod":"GET","errorResponses":[{"reason":"Not logged in.","code":403},{"reason":"User not found.","code":404}],"nickname":"getLoggedInUserTrackingInfo","responseClass":"UserTrackingInfo","notes":"Requires a valid auth_token to be set."}]}],"models1":[{"name":"ApiResponse","fields":[{"name":"message","required":false,"allowMultiple":false,"paramType":"string"},{"name":"type","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"UserProfile","fields":[{"name":"location","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"firstName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"lastName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"bio","required":false,"allowMultiple":false,"paramType":"string"},{"name":"siteUrl","required":false,"allowMultiple":false,"paramType":"string"},{"name":"leastFavoriteWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"mostFavoriteWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"onomaTopoeiaWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"seekingWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"youWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userHandles","required":false,"allowMultiple":false,"paramType":"List[UserHandle]"},{"name":"siteName","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"ApiApprovalState","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"wordList","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"type","required":false,"allowMultiple":false,"paramType":"string"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"permalink","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"username","required":false,"allowMultiple":false,"paramType":"string"},{"name":"updatedAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"numberWordsInList","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"UserHandle","fields":[{"name":"webService","required":false,"allowMultiple":false,"paramType":"int"},{"name":"handle","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"UserSettings","fields":[{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"bossURL","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"ApiTokenStatus","fields":[{"name":"token","required":false,"allowMultiple":false,"paramType":"string"},{"name":"expiresInMillis","required":false,"allowMultiple":false,"paramType":"long"},{"name":"totalRequests","required":false,"allowMultiple":false,"paramType":"long"},{"name":"remainingCalls","required":false,"allowMultiple":false,"paramType":"long"},{"name":"resetsInMillis","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"UserTrackingInfo","fields":[{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"noOfLogins","required":false,"allowMultiple":false,"paramType":"int"},{"name":"signupDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"signupIPAddress","required":false,"allowMultiple":false,"paramType":"string"},{"name":"lastUpdatedDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"lastLoginDate","required":false,"allowMultiple":false,"paramType":"Date"}]},{"name":"apiApplication","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"comment","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"userName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"approvalState","required":false,"allowMultiple":false,"paramType":"ApiApprovalState"}]},{"name":"AuthenticationToken","fields":[{"name":"token","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"userSignature","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"user","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"displayName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"status","required":false,"allowMultiple":false,"paramType":"int"},{"name":"password","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"email","required":false,"allowMultiple":false,"paramType":"string"},{"name":"faceBookId","required":false,"allowMultiple":false,"paramType":"string"}]}],"basePath":"url","swaggerVersion":"1.0"}
1
+ {"resourcePath":"/account","models":{"User":{"properties":{"id":{"type":"long"},"username":{"type":"string"},"email":{"type":"string"},"status":{"type":"int"},"faceBookId":{"type":"string"},"userName":{"type":"string"},"displayName":{"type":"string"},"password":{"type":"string"}},"id":"user"},"ApiTokenStatus":{"properties":{"valid":{"type":"boolean"},"token":{"type":"string"},"resetsInMillis":{"type":"long"},"remainingCalls":{"type":"long"},"expiresInMillis":{"type":"long"},"totalRequests":{"type":"long"}},"id":"ApiTokenStatus"},"AuthenticationToken":{"properties":{"token":{"type":"string"},"userId":{"type":"long"},"userSignature":{"type":"string"}},"id":"AuthenticationToken"},"WordList":{"properties":{"updatedAt":{"type":"Date"},"id":{"type":"long"},"username":{"type":"string"},"permalink":{"type":"string"},"createdAt":{"type":"Date"},"description":{"type":"string"},"userId":{"type":"long"},"name":{"type":"string"},"numberWordsInList":{"type":"long"},"type":{"type":"string"}},"id":"wordList"},"ApiResponse":{"properties":{"message":{"type":"string"},"type":{"type":"string"}},"id":"ApiResponse"},"UserHandle":{"properties":{"webService":{"type":"int"},"handle":{"type":"string"}},"id":"UserHandle"},"UserSettings":{"properties":{"notifyComments":{"type":"boolean"},"bossURL":{"type":"string"},"enableActivityFeed":{"type":"boolean"},"userId":{"type":"long"},"publicLookupHistory":{"type":"boolean"},"showImages":{"type":"boolean"},"notifyGeneralNews":{"type":"boolean"},"notifyWordOfTheDay":{"type":"boolean"},"showLookupHistory":{"type":"boolean"}},"id":"UserSettings"},"ApiApplication":{"properties":{"id":{"type":"long"},"createdAt":{"type":"Date"},"userId":{"type":"long"},"userName":{"type":"string"},"approvalState":{"type":"ApiApprovalState"},"comment":{"type":"string"}},"id":"apiApplication"},"UserTrackingInfo":{"properties":{"signupDate":{"type":"Date"},"lastLoginDate":{"type":"Date"},"noOfLogins":{"type":"int"},"userId":{"type":"long"},"lastUpdatedDate":{"type":"Date"},"signupIPAddress":{"type":"string"}},"id":"UserTrackingInfo"},"UserProfile":{"properties":{"publicProfile":{"type":"boolean"},"lastName":{"type":"string"},"mostFavoriteWord":{"type":"string"},"location":{"type":"string"},"seekingWord":{"type":"string"},"leastFavoriteWord":{"type":"string"},"onomaTopoeiaWord":{"type":"string"},"siteUrl":{"type":"string"},"bio":{"type":"string"},"userHandles":{"type":"array","items":{"$ref":"UserHandle"}},"userId":{"type":"long"},"youWord":{"type":"string"},"firstName":{"type":"string"},"siteName":{"type":"string"}},"id":"UserProfile"},"ApiApprovalState":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"ApiApprovalState"}},"apis":[{"path":"/account.{format}/authenticate/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"A confirmed Wordnik username","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"password","description":"The user's password","required":true,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Authenticates a User","responseTypeInternal":"com.wordnik.security.model.AuthenticationToken","errorResponses":[{"reason":"Account not available.","code":403},{"reason":"User not found.","code":404}],"nickname":"authenticate","responseClass":"AuthenticationToken","httpMethod":"GET"},{"parameters":[{"name":"username","description":"A confirmed Wordnik username","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"The user's password","required":true,"dataType":"string","allowMultiple":false,"paramType":"body"}],"summary":"Authenticates a user","responseTypeInternal":"com.wordnik.security.model.AuthenticationToken","errorResponses":[{"reason":"Account not available.","code":403},{"reason":"User not found.","code":404}],"nickname":"authenticatePost","responseClass":"AuthenticationToken","httpMethod":"POST"}]},{"path":"/account.{format}/wordLists","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"},{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches WordList objects for the logged-in user.","responseTypeInternal":"com.wordnik.community.entity.WordList","errorResponses":[{"reason":"Not authenticated.","code":403},{"reason":"User account not found.","code":404}],"nickname":"getWordListsForCurrentUser","responseClass":"List[wordList]","httpMethod":"GET"}]},{"path":"/account.{format}/forgotPassword/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Authenticates a User","responseTypeInternal":"String","errorResponses":[{"reason":"User is Facebook Connected","code":400},{"reason":"User not found","code":404}],"nickname":"getForgotPassword","responseClass":"String","httpMethod":"GET"}]},{"path":"/account.{format}/resetPassword/{hashcode}","description":"","operations":[{"parameters":[{"name":"hashcode","description":"Password reset code","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches a User by code","responseTypeInternal":"com.wordnik.system.user.entity.User","errorResponses":[{"reason":"Invalid code supplied","code":400},{"reason":"User not found or code invalid.","code":404}],"nickname":"resetPassword","responseClass":"user","httpMethod":"GET"}]},{"path":"/account.{format}/apiAccountApplication","description":"","operations":[{"parameters":[{"description":"API Application Info","required":true,"dataType":"apiApplication","valueTypeInternal":"com.wordnik.security.entity.ApiApplication","allowMultiple":false,"paramType":"body"}],"summary":"Creates an API account application.","responseTypeInternal":"com.wordnik.resource.ApiResponse","errorResponses":[{"reason":"Account not available.","code":403},{"reason":"User not found.","code":404}],"nickname":"createApiAccount","responseClass":"ApiResponse","httpMethod":"POST"}]},{"path":"/account.{format}/regenerateApiToken","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Regenerates an API Token. Currently not supported or tested.","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid token supplied.","code":400}],"nickname":"createApiAccount","responseClass":"ok","httpMethod":"GET"}]},{"path":"/account.{format}/apiTokenStatus","description":"","operations":[{"parameters":[{"name":"api_key","description":"Wordnik authentication token","required":false,"dataType":"string","allowMultiple":false,"paramType":"header"},{"name":"api_key","description":"Wordnik authentication token","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns usage statistics for the API account.","responseTypeInternal":"com.wordnik.security.model.ApiTokenStatus","errorResponses":[{"reason":"No token supplied.","code":400},{"reason":"No API account with supplied token.","code":404}],"nickname":"getApiTokenStatus","responseClass":"ApiTokenStatus","httpMethod":"GET"}]},{"path":"/account.{format}/logVisit","description":"","operations":[{"parameters":[{"name":"userId","description":"User ID to track data for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userGuid","description":"User's persistent GUID","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userSessionId","description":"User's session ID","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userIpAddress","description":"User IP address","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"serverIp","description":"Server IP address","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Logs a VisitAction for the user","responseTypeInternal":"String","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"logVisitForUser","responseClass":"String","notes":"Requires a valid auth_token to be set.","httpMethod":"POST"}]},{"path":"/account.{format}/activationCode/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns an activation code given a username","responseTypeInternal":"String","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"getActivationCodeForUser","responseClass":"String","notes":"If an activation code is not available, will return null.","httpMethod":"GET"}]},{"path":"/account.{format}/activate","description":"","operations":[{"parameters":[{"description":"Activation Code","required":true,"dataType":"string","allowMultiple":false,"paramType":"body"}],"summary":"Activates an account.","responseTypeInternal":"com.wordnik.system.user.entity.User","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"No activation code found.","code":404}],"nickname":"activateUser","responseClass":"user","httpMethod":"POST"}]},{"path":"/account.{format}/usernameAvailable/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns an ApiResponse indicating whether or not a username is available","responseTypeInternal":"com.wordnik.resource.ApiResponse","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"getUsernameAvailable","responseClass":"ApiResponse","httpMethod":"GET"}]},{"path":"/account.{format}/user","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Returns the logged-in User","responseTypeInternal":"com.wordnik.system.user.entity.User","errorResponses":[{"reason":"Not logged in.","code":403},{"reason":"User not found.","code":404}],"nickname":"getLoggedInUser","responseClass":"user","notes":"Requires a valid auth_token to be set.","httpMethod":"GET"}]},{"path":"/account.{format}/profile","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"},{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Returns profile info for the logged-in user","responseTypeInternal":"com.wordnik.system.user.entity.UserProfile","errorResponses":[{"reason":"Not logged in.","code":403},{"reason":"User not found.","code":404}],"nickname":"getLoggedInUserProfile","responseClass":"UserProfile","notes":"Requires a valid auth_token to be set.","httpMethod":"GET"}]},{"path":"/account.{format}/settings","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"},{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Returns logged-in User Settings","responseTypeInternal":"com.wordnik.system.user.entity.UserSettings","errorResponses":[{"reason":"Not logged in.","code":403},{"reason":"User not found.","code":404}],"nickname":"getLoggedInUserSettings","responseClass":"UserSettings","notes":"Requires a valid auth_token to be set.","httpMethod":"GET"}]},{"path":"/account.{format}/trackingInfo","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"},{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Returns logged-in User TrackingInfo.","responseTypeInternal":"com.wordnik.system.user.entity.UserTrackingInfo","errorResponses":[{"reason":"Not logged in.","code":403},{"reason":"User not found.","code":404}],"nickname":"getLoggedInUserTrackingInfo","responseClass":"UserTrackingInfo","notes":"Requires a valid auth_token to be set.","httpMethod":"GET"}]}],"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1","apiVersion":"4.0"}
data/api_docs/analytics.json CHANGED
@@ -1 +1 @@
1
- {"resourcePath":"/analytics","models":{"wordHitsCollection":{"properties":{"wordHitsList":{"type":"array","required":false,"items":{"$ref":"wordHits","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"wordHitsCollection","type":"any","required":false,"uniqueItems":false},"wordHits":{"properties":{"timeMillis":{"type":"long","required":false,"uniqueItems":false}},"id":"wordHits","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/analytics.{format}/top","description":"","operations":[{"parameters":[{"name":"namespace","defaultValue":"site.word","description":"The namespace for which to return hits","required":false,"dataType":"string","allowableValues":["site.word"],"allowMultiple":false,"paramType":"query"},{"name":"year","description":"Year","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"month","description":"Month","required":false,"dataType":"string","allowableValues":["1","2","3","4","5","6","7","8","9","10","11","12"],"allowMultiple":false,"paramType":"query"},{"name":"week","description":"Week","required":false,"dataType":"string","allowableValues":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31","32","33","34","35","36","37","38","39","40","41","42","43","44","45","46","47","48","49","50","51","52"],"allowMultiple":false,"paramType":"query"},{"name":"day","description":"Day","required":false,"dataType":"string","allowableValues":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31"],"allowMultiple":false,"paramType":"query"},{"name":"hour","description":"Hour","required":false,"dataType":"string","allowableValues":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24"],"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Number of results to skip by","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"50","description":"Number of results to fetch","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns top hits over a year, month, week, day or hour","httpMethod":"GET","errorResponses":[{"reason":"Invalid time resolution specified","code":400}],"nickname":"getTopHits","responseClass":"wordHitsCollection","notes":"If no time resolution parameters are passed, it returns top hits for this week. To fetch top hits for a year, pass only the year. To fetch top hits for a month, pass (year and month). To fetch top hits for a week, pass (year and week). To fetch top hits for a day, pass (year, month and day). To fetch top hits for an hour, pass (year, month, day and hour)."}]},{"path":"/analytics.{format}/trending","description":"","operations":[{"parameters":[{"name":"namespace","defaultValue":"site.word","description":"The namespace for which to return hits","required":false,"dataType":"string","allowableValues":["site.word"],"allowMultiple":false,"paramType":"query"},{"name":"year","description":"Year","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"month","description":"Month","required":false,"dataType":"string","allowableValues":["1","2","3","4","5","6","7","8","9","10","11","12"],"allowMultiple":false,"paramType":"query"},{"name":"week","description":"Week","required":false,"dataType":"string","allowableValues":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31","32","33","34","35","36","37","38","39","40","41","42","43","44","45","46","47","48","49","50","51","52"],"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Number of results to skip by","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"50","description":"Number of results to fetch","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns words which were trending on a given week or month","httpMethod":"GET","errorResponses":[{"reason":"Invalid time resolution specified","code":400}],"nickname":"getTrendingHits","responseClass":"wordHitsCollection","notes":"If no time resolution parameters are passed, it returns trending hits for this week.\nTo fetch trending hits for a month, pass (year and month). To fetch trending hits for a week, pass (year and week)."}]},{"path":"/analytics.{format}/word/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"Word","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"namespace","defaultValue":"site.word","description":"The namespace for which to return hits","required":false,"dataType":"string","allowableValues":["site.word"],"allowMultiple":false,"paramType":"query"},{"name":"year","description":"Year","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"month","description":"Month","required":false,"dataType":"string","allowableValues":["1","2","3","4","5","6","7","8","9","10","11","12"],"allowMultiple":false,"paramType":"query"},{"name":"week","description":"Week","required":false,"dataType":"string","allowableValues":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31","32","33","34","35","36","37","38","39","40","41","42","43","44","45","46","47","48","49","50","51","52"],"allowMultiple":false,"paramType":"query"},{"name":"day","description":"Day","required":false,"dataType":"string","allowableValues":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31"],"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Number of results to skip by","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"50","description":"Number of results to fetch","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns hits a word received in a given year, month, week or day","httpMethod":"GET","errorResponses":[{"reason":"Invalid time resolution specified","code":400}],"nickname":"getWordHits","responseClass":"wordHitsCollection","notes":"If no time resolution parameters are passed, it returns hits the word received this week. To fetch word hits for a year, pass only the year. To fetch word hits for a month, pass (year and month). To fetch word hits for a week, pass (year and week). To fetch word hits for a day, pass (year, month and day)"}]}],"models1":[{"name":"wordHits","fields":[{"name":"timeMillis","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"wordHitsCollection","fields":[{"name":"wordHitsList","required":false,"wrapperName":"wordHitsList","allowMultiple":false,"paramType":"List[wordHits]"}]}],"basePath":"url","swaggerVersion":"1.0"}
1
+ {"resourcePath":"/analytics","models":{"WordHitsCollection":{"properties":{"wordHitsList":{"type":"array","items":{"$ref":"wordHits"}}},"id":"wordHitsCollection"},"WordHits":{"properties":{"timeMillis":{"type":"long"}},"id":"wordHits"}},"apis":[{"path":"/analytics.{format}/top","description":"","operations":[{"parameters":[{"name":"namespace","defaultValue":"site.word","description":"The namespace for which to return hits","required":false,"dataType":"string","allowableValues":{"values":["site.word"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"year","description":"Year","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"month","description":"Month","required":false,"dataType":"string","allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"week","description":"Week","required":false,"dataType":"string","allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31","32","33","34","35","36","37","38","39","40","41","42","43","44","45","46","47","48","49","50","51","52"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"day","description":"Day","required":false,"dataType":"string","allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"hour","description":"Hour","required":false,"dataType":"string","allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Number of results to skip by","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"50","description":"Number of results to fetch","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns top hits over a year, month, week, day or hour","responseTypeInternal":"com.wordnik.analytics.model.WordHitsCollection","errorResponses":[{"reason":"Invalid time resolution specified","code":400}],"nickname":"getTopHits","responseClass":"wordHitsCollection","notes":"If no time resolution parameters are passed, it returns top hits for this week. To fetch top hits for a year, pass only the year. To fetch top hits for a month, pass (year and month). To fetch top hits for a week, pass (year and week). To fetch top hits for a day, pass (year, month and day). To fetch top hits for an hour, pass (year, month, day and hour).","httpMethod":"GET"}]},{"path":"/analytics.{format}/trending","description":"","operations":[{"parameters":[{"name":"namespace","defaultValue":"site.word","description":"The namespace for which to return hits","required":false,"dataType":"string","allowableValues":{"values":["site.word"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"year","description":"Year","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"month","description":"Month","required":false,"dataType":"string","allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"week","description":"Week","required":false,"dataType":"string","allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31","32","33","34","35","36","37","38","39","40","41","42","43","44","45","46","47","48","49","50","51","52"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Number of results to skip by","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"50","description":"Number of results to fetch","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns words which were trending on a given week or month","responseTypeInternal":"com.wordnik.analytics.model.WordHitsCollection","errorResponses":[{"reason":"Invalid time resolution specified","code":400}],"nickname":"getTrendingHits","responseClass":"wordHitsCollection","notes":"If no time resolution parameters are passed, it returns trending hits for this week.\nTo fetch trending hits for a month, pass (year and month). To fetch trending hits for a week, pass (year and week).","httpMethod":"GET"}]},{"path":"/analytics.{format}/word/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"Word","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"namespace","defaultValue":"site.word","description":"The namespace for which to return hits","required":false,"dataType":"string","allowableValues":{"values":["site.word"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"year","description":"Year","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"month","description":"Month","required":false,"dataType":"string","allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"week","description":"Week","required":false,"dataType":"string","allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31","32","33","34","35","36","37","38","39","40","41","42","43","44","45","46","47","48","49","50","51","52"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"day","description":"Day","required":false,"dataType":"string","allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Number of results to skip by","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"50","description":"Number of results to fetch","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns hits a word received in a given year, month, week or day","responseTypeInternal":"com.wordnik.analytics.model.WordHitsCollection","errorResponses":[{"reason":"Invalid time resolution specified","code":400}],"nickname":"getWordHits","responseClass":"wordHitsCollection","notes":"If no time resolution parameters are passed, it returns hits the word received this week. To fetch word hits for a year, pass only the year. To fetch word hits for a month, pass (year and month). To fetch word hits for a week, pass (year and week). To fetch word hits for a day, pass (year, month and day)","httpMethod":"GET"}]}],"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1","apiVersion":"4.0"}
data/api_docs/corpus.json CHANGED
@@ -1 +1 @@
1
- {"resourcePath":"/corpus","models":{"wordView":{"properties":{"id":{"type":"long","required":true,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false}},"id":"wordView","type":"any","required":false,"uniqueItems":false},"basicWordUsage":{"properties":{"sentenceId":{"type":"long","required":false,"uniqueItems":false},"year":{"type":"integer","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false},"documentId":{"type":"long","required":false,"uniqueItems":false}},"id":"basicWordUsage","type":"any","required":false,"uniqueItems":false},"dictionaryStats":{"properties":{"dictionaryName":{"type":"string","required":false,"uniqueItems":false},"exampleCount":{"type":"int","required":false,"uniqueItems":false},"defintionCount":{"type":"int","required":false,"uniqueItems":false},"relationshipLinks":{"type":"Map[string,integer]","required":false,"uniqueItems":false},"textPronunciationCount":{"type":"int","required":false,"uniqueItems":false},"wordCount":{"type":"int","required":false,"uniqueItems":false},"wordsWithRelationship":{"type":"Map[string,integer]","required":false,"uniqueItems":false}},"id":"dictionaryStats","type":"any","required":false,"uniqueItems":false},"punctuationFactor":{"properties":{"periodCount":{"type":"long","required":false,"uniqueItems":false},"exclamationPointCount":{"type":"long","required":false,"uniqueItems":false},"wordId":{"type":"long","required":false,"uniqueItems":false},"questionMarkCount":{"type":"long","required":false,"uniqueItems":false},"totalCount":{"type":"long","required":false,"uniqueItems":false}},"id":"punctuationFactor","type":"any","required":false,"uniqueItems":false},"wordListingHistory":{"properties":{"wordId":{"type":"long","required":false,"uniqueItems":false},"listingCount":{"type":"long","required":false,"uniqueItems":false},"wordString":{"type":"string","required":false,"uniqueItems":false}},"id":"wordListingHistory","type":"any","required":false,"uniqueItems":false},"sentence":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"display":{"type":"string","required":false,"uniqueItems":false},"rating":{"type":"int","required":false,"uniqueItems":false},"documentMetadataId":{"type":"long","required":false,"uniqueItems":false},"scoredWord":{"type":"array","required":false,"items":{"$ref":"scoredWord","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"sentence","type":"any","required":false,"uniqueItems":false},"long":{"properties":{"value":{"type":"long","required":false,"uniqueItems":false}},"id":"long","type":"any","required":false,"uniqueItems":false},"basicDocumentStats":{"properties":{"uniqueBiGramsCount":{"type":"long","required":false,"uniqueItems":false},"wordsCount":{"type":"long","required":false,"uniqueItems":false},"documentsCount":{"type":"long","required":false,"uniqueItems":false},"firstUsedWordsCount":{"type":"long","required":false,"uniqueItems":false},"tokensCount":{"type":"long","required":false,"uniqueItems":false},"sentencesCount":{"type":"long","required":false,"uniqueItems":false},"viableSentencesCount":{"type":"long","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false},"uniqueWordsCount":{"type":"long","required":false,"uniqueItems":false},"key":{"type":"string","required":false,"uniqueItems":false}},"id":"basicDocumentStats","type":"any","required":false,"uniqueItems":false},"scoredWord":{"properties":{"position":{"type":"int","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"wordType":{"type":"string","required":false,"uniqueItems":false},"score":{"type":"float","required":false,"uniqueItems":false},"sentenceId":{"type":"long","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"partOfSpeech":{"type":"string","required":false,"uniqueItems":false}},"id":"scoredWord","type":"any","required":false,"uniqueItems":false},"wordResult":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"wordResult","type":"any","required":false,"uniqueItems":false},"lookupExample":{"properties":{"sourceName":{"type":"string","required":false,"uniqueItems":false},"uRL":{"type":"string","required":false,"uniqueItems":false},"exampleString":{"type":"string","required":false,"uniqueItems":false}},"id":"lookupExample","type":"any","required":false,"uniqueItems":false},"suggestion":{"properties":{"type":{"type":"int","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"suggestion","type":"any","required":false,"uniqueItems":false},"contextualLookupResponse":{"properties":{"examples":{"type":"array","required":false,"items":{"$ref":"lookupExample","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"contextualLookupResponse","type":"any","required":false,"uniqueItems":false},"wordFrequency":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"wordFrequency","type":"any","required":false,"uniqueItems":false},"relationshipMap":{"properties":{"sourceWordstring":{"type":"string","required":false,"uniqueItems":false},"suggestion":{"type":"array","required":false,"items":{"$ref":"suggestion","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"relationshipMap","type":"any","required":false,"uniqueItems":false},"contextualLookupRequest":{"properties":{"partnerId":{"type":"string","required":false,"uniqueItems":false},"documentTitle":{"type":"string","required":false,"uniqueItems":false},"contextString":{"type":"string","required":false,"uniqueItems":false},"sourceUrl":{"type":"string","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false},"metadataId":{"type":"string","required":false,"uniqueItems":false}},"id":"contextualLookupRequest","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/corpus.{format}/recentViews","description":"","operations":[{"parameters":[{"name":"limit","description":"Limits results","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"humanOnly","description":"Returns results only from human visitors","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"sortByFrequency","description":"Sorts results by frequency","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches recent views from the website.","httpMethod":"GET","nickname":"getRecentViews","responseClass":"List[wordResult]"}]},{"path":"/corpus.{format}/words/{statsType}/{object}","description":"","operations":[{"parameters":[{"name":"statsType","description":"Stats type to fetch","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"object","description":"Object identifier","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Gets WordFrequency data","httpMethod":"GET","errorResponses":[{"reason":"Invalid dimension for WordFrequency data or Object Identifier not found.","code":400}],"nickname":"getWordFrequencies","responseClass":"List[wordFrequency]"}]},{"path":"/corpus.{format}/dictionaryStats","description":"","operations":[{"parameters":[{"name":"sourceDictionary","description":"Dictionary name to fetch stats for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Gets Dictionary Statistics data","httpMethod":"GET","errorResponses":[{"reason":"Invalid dictionary name supplied.","code":404}],"nickname":"getWordFrequencies","responseClass":"dictionaryStats"}]},{"path":"/corpus.{format}/firstUsed","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Gets Dictionary Statistics data","httpMethod":"GET","errorResponses":[{"reason":"No data found for corpus.","code":404}],"nickname":"getWordFrequencies","responseClass":"List[basicWordUsage]"}]},{"path":"/corpus.{format}/totalDocumentCount","description":"","operations":[{"summary":"Returns the count of documents in the Corpus.","httpMethod":"GET","nickname":"getTotalDocumentCount","responseClass":"long"}]},{"path":"/corpus.{format}/processText","description":"","operations":[{"parameters":[{"description":"Text body to process.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"body"},{"name":"split","description":"Tells the processor to split multiple sentences from the input. Default is true.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"rank","description":"Flag to invoke the ranking logic. Default is false.","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Processes text input.","httpMethod":"POST","errorResponses":[{"reason":"Invalid text supplied.","code":400}],"nickname":"processText","responseClass":"List[sentence]","notes":"Returns tagged and processed text based on the input string."}]},{"path":"/corpus.{format}/punctuationFactor","description":"","operations":[{"summary":"Returns corpus-wide PunctuationFactor.","httpMethod":"GET","errorResponses":[{"reason":"No data available.","code":404}],"nickname":"getPunctuationFactor","responseClass":"punctuationFactor"}]},{"path":"/corpus.{format}/phraseFeedback","description":"","operations":[{"parameters":[{"description":"Phrase to store.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Receives info on phrases which should be captured","httpMethod":"POST","errorResponses":[{"reason":"Invalid phrase supplied.","code":400}],"nickname":"getPunctuationFactor","responseClass":"List[sentence]"}]},{"path":"/corpus.{format}/documentStats","description":"","operations":[{"parameters":[{"name":"documentStatsType","description":"Type of statistics to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"id","description":"ID of statistics type to return.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"split","description":"Flag to invoke the ranking logic. Default is false.","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns document-level stats.","httpMethod":"GET","errorResponses":[{"reason":"Invalid stats type supplied.","code":400}],"nickname":"getDocumentStats","responseClass":"basicDocumentStats"}]},{"path":"/corpus.{format}/words","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Gets corpus-level WordFrequency","httpMethod":"GET","errorResponses":[{"reason":"No corpus frequency data available.","code":400}],"nickname":"getCorpusWordFrequencies","responseClass":"List[wordFrequency]"}]},{"path":"/corpus.{format}/dymInternal/{wordstring}","description":"","operations":[{"parameters":[{"name":"wordstring","description":"Returns results only from human visitors","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns word relationships.","httpMethod":"GET","errorResponses":[{"reason":"No data available.","code":404},{"reason":"Invalid word supplied.","code":400}],"nickname":"getDym","responseClass":"relationshipMap"}]},{"path":"/corpus.{format}/recentListedWords","description":"","operations":[{"parameters":[{"name":"limit","description":"Maximun results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns recently listed words.","httpMethod":"GET","nickname":"getRecentListedWords","responseClass":"List[wordListingHistory]"}]},{"path":"/corpus.{format}/views","description":"","operations":[{"parameters":[{"name":"word","description":"Filter by word","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"userId","description":"filter by user id","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"userGuid","description":"Filter by user guid","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"sessionId","description":"Filter by user session id","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"callingClass","description":"Filter by calling class","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"method","description":"Filter by calling method","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"environment","description":"Deployment environment to find results from","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"serverIp","description":"Server IP to query from","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"createdAfter","description":"Date to find results after","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches views from the website.","httpMethod":"GET","nickname":"getViews","responseClass":"List[wordView]"}]},{"path":"/corpus.{format}/contextualLookup","description":"","operations":[{"parameters":[{"name":"word","description":"Word of interest","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"contextString","description":"Sentence word appears in","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"title","description":"Word of interest","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"metadataId","description":"Word of interest","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"partnerId","description":"Partner Id","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"sourceUrl","description":"Document source URL","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Mock method to return Contextual Lookup info.","httpMethod":"GET","nickname":"getMockContextualLookupInfo","responseClass":"contextualLookupResponse","notes":"Internal Only"},{"parameters":[{"name":"category","description":"Filters response by category","required":false,"dataType":"contextualLookupRequest","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches ContextualLookup info.","httpMethod":"POST","nickname":"getContextualLookupInfo","responseClass":"contextualLookupResponse"}]},{"path":"/corpus.{format}/totalWordCount","description":"","operations":[{"summary":"Returns the count of tokens in the Corpus.","httpMethod":"GET","nickname":"getTotalTokensCount","responseClass":"long"}]},{"path":"/corpus.{format}/sentenceCount","description":"","operations":[{"summary":"Returns the count of sentences in the Corpus.","httpMethod":"GET","nickname":"getTotalSentencesCount","responseClass":"long"}]}],"models1":[{"name":"sentence","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"scoredWord","required":false,"wrapperName":"scoredWords","allowMultiple":false,"paramType":"List[scoredWord]"},{"name":"display","required":false,"allowMultiple":false,"paramType":"string"},{"name":"documentMetadataId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"rating","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"wordFrequency","fields":[{"name":"count","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"contextualLookupRequest","fields":[{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sourceUrl","required":false,"allowMultiple":false,"paramType":"string"},{"name":"contextString","required":false,"allowMultiple":false,"paramType":"string"},{"name":"metadataId","required":false,"allowMultiple":false,"paramType":"string"},{"name":"partnerId","required":false,"allowMultiple":false,"paramType":"string"},{"name":"documentTitle","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"relationshipMap","fields":[{"name":"sourceWordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"suggestion","required":false,"wrapperName":"suggestions","allowMultiple":false,"paramType":"List[suggestion]"}]},{"name":"punctuationFactor","fields":[{"name":"totalCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"periodCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"exclamationPointCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"questionMarkCount","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"long","fields":[{"name":"value","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"lookupExample","fields":[{"name":"uRL","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sourceName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"exampleString","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"wordView","fields":[{"name":"id","required":true,"allowMultiple":false,"paramType":"long"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"basicWordUsage","fields":[{"name":"year","required":false,"allowMultiple":false,"paramType":"integer"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"documentId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"sentenceId","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"wordListingHistory","fields":[{"name":"wordString","required":false,"allowMultiple":false,"paramType":"string"},{"name":"wordId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"listingCount","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"dictionaryStats","fields":[{"name":"defintionCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"textPronunciationCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"exampleCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"dictionaryName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"wordCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"wordsWithRelationship","required":false,"allowMultiple":false,"paramType":"Map[string,integer]"},{"name":"relationshipLinks","required":false,"allowMultiple":false,"paramType":"Map[string,integer]"}]},{"name":"wordResult","fields":[{"name":"count","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"scoredWord","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"position","required":false,"allowMultiple":false,"paramType":"int"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"score","required":false,"allowMultiple":false,"paramType":"float"},{"name":"sentenceId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"partOfSpeech","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"contextualLookupResponse","fields":[{"name":"examples","required":false,"wrapperName":"lookupExamples","allowMultiple":false,"paramType":"List[lookupExample]"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"suggestion","fields":[{"name":"type","required":false,"allowMultiple":false,"paramType":"int"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"basicDocumentStats","fields":[{"name":"key","required":false,"allowMultiple":false,"paramType":"string"},{"name":"type","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sentencesCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"uniqueWordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"documentsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"tokensCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"firstUsedWordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"viableSentencesCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"uniqueBiGramsCount","required":false,"allowMultiple":false,"paramType":"long"}]}],"basePath":"url","swaggerVersion":"1.0"}
1
+ {"resourcePath":"/corpus","models":{"Long":{"properties":{"value":{"type":"long"}},"id":"long"},"WordResult":{"properties":{"count":{"type":"long"},"wordstring":{"type":"string"}},"id":"wordResult"},"PunctuationFactor":{"properties":{"periodCount":{"type":"long"},"exclamationPointCount":{"type":"long"},"wordId":{"type":"long"},"questionMarkCount":{"type":"long"},"totalCount":{"type":"long"}},"id":"punctuationFactor"},"WordListingHistory":{"properties":{"wordId":{"type":"long"},"listingCount":{"type":"long"},"wordString":{"type":"string"}},"id":"wordListingHistory"},"ContextualLookupRequest":{"properties":{"partnerId":{"type":"string"},"documentTitle":{"type":"string"},"contextString":{"type":"string"},"sourceUrl":{"type":"string"},"wordstring":{"type":"string"},"metadataId":{"type":"string"}},"id":"contextualLookupRequest"},"BasicWordUsage":{"properties":{"sentenceId":{"type":"long"},"year":{"type":"integer"},"wordstring":{"type":"string"},"documentId":{"type":"long"}},"id":"basicWordUsage"},"WordView":{"properties":{"id":{"type":"long","required":true},"word":{"type":"string"}},"id":"wordView"},"ScoredWord":{"properties":{"position":{"type":"int"},"id":{"type":"long"},"wordType":{"type":"string"},"score":{"type":"float"},"sentenceId":{"type":"long"},"word":{"type":"string"},"partOfSpeech":{"type":"string"}},"id":"scoredWord"},"LookupExample":{"properties":{"sourceName":{"type":"string"},"uRL":{"type":"string"},"exampleString":{"type":"string"}},"id":"lookupExample"},"DictionaryStats":{"properties":{"dictionaryName":{"type":"string"},"exampleCount":{"type":"int"},"defintionCount":{"type":"int"},"relationshipLinks":{"type":"Map[string,integer]"},"textPronunciationCount":{"type":"int"},"wordCount":{"type":"int"},"wordsWithRelationship":{"type":"Map[string,integer]"}},"id":"dictionaryStats"},"ContextualLookupResponse":{"properties":{"examples":{"type":"array","items":{"$ref":"lookupExample"}},"wordstring":{"type":"string"}},"id":"contextualLookupResponse"},"WordFrequency":{"properties":{"count":{"type":"long"},"wordstring":{"type":"string"}},"id":"wordFrequency"},"Sentence":{"properties":{"id":{"type":"long"},"display":{"type":"string"},"rating":{"type":"int"},"documentMetadataId":{"type":"long"},"scoredWord":{"type":"array","items":{"$ref":"scoredWord"}}},"id":"sentence"},"BasicDocumentStats":{"properties":{"uniqueBiGramsCount":{"type":"long"},"wordsCount":{"type":"long"},"documentsCount":{"type":"long"},"firstUsedWordsCount":{"type":"long"},"tokensCount":{"type":"long"},"sentencesCount":{"type":"long"},"viableSentencesCount":{"type":"long"},"type":{"type":"string"},"uniqueWordsCount":{"type":"long"},"key":{"type":"string"}},"id":"basicDocumentStats"}},"apis":[{"path":"/corpus.{format}/recentViews","description":"","operations":[{"parameters":[{"name":"limit","description":"Limits results","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"humanOnly","description":"Returns results only from human visitors","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sortByFrequency","description":"Sorts results by frequency","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches recent views from the website.","responseTypeInternal":"com.wordnik.corpus.model.WordResult","nickname":"getRecentViews","responseClass":"List[wordResult]","httpMethod":"GET"}]},{"path":"/corpus.{format}/words/{statsType}/{object}","description":"","operations":[{"parameters":[{"name":"statsType","description":"Stats type to fetch","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"object","description":"Object identifier","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Gets WordFrequency data","responseTypeInternal":"com.wordnik.corpus.stats.entity.WordFrequency","errorResponses":[{"reason":"Invalid dimension for WordFrequency data or Object Identifier not found.","code":400}],"nickname":"getWordFrequencies","responseClass":"List[wordFrequency]","httpMethod":"GET"}]},{"path":"/corpus.{format}/dictionaryStats","description":"","operations":[{"parameters":[{"name":"sourceDictionary","description":"Dictionary name to fetch stats for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Gets Dictionary Statistics data","responseTypeInternal":"com.wordnik.corpus.stats.entity.DictionaryStats","errorResponses":[{"reason":"Invalid dictionary name supplied.","code":404}],"nickname":"getWordFrequencies","responseClass":"dictionaryStats","httpMethod":"GET"}]},{"path":"/corpus.{format}/firstUsed","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Gets Dictionary Statistics data","responseTypeInternal":"com.wordnik.corpus.stats.entity.BasicWordUsage","errorResponses":[{"reason":"No data found for corpus.","code":404}],"nickname":"getWordFrequencies","responseClass":"List[basicWordUsage]","httpMethod":"GET"}]},{"path":"/corpus.{format}/totalDocumentCount","description":"","operations":[{"summary":"Returns the count of documents in the Corpus.","responseTypeInternal":"com.wordnik.system.model.LongResult","nickname":"getTotalDocumentCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/corpus.{format}/processText","description":"","operations":[{"parameters":[{"description":"Text body to process.","required":false,"dataType":"string","allowMultiple":false,"paramType":"body"},{"name":"split","description":"Tells the processor to split multiple sentences from the input. Default is true.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"rank","description":"Flag to invoke the ranking logic. Default is false.","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Processes text input.","responseTypeInternal":"com.wordnik.corpus.entity.Sentence","errorResponses":[{"reason":"Invalid text supplied.","code":400}],"nickname":"processText","responseClass":"List[sentence]","notes":"Returns tagged and processed text based on the input string.","httpMethod":"POST"}]},{"path":"/corpus.{format}/punctuationFactor","description":"","operations":[{"summary":"Returns corpus-wide PunctuationFactor.","responseTypeInternal":"com.wordnik.corpus.entity.BangFactor","errorResponses":[{"reason":"No data available.","code":404}],"nickname":"getPunctuationFactor","responseClass":"punctuationFactor","httpMethod":"GET"}]},{"path":"/corpus.{format}/documentStats","description":"","operations":[{"parameters":[{"name":"documentStatsType","description":"Type of statistics to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"id","description":"ID of statistics type to return.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"split","description":"Flag to invoke the ranking logic. Default is false.","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns document-level stats.","responseTypeInternal":"com.wordnik.corpus.stats.entity.BasicDocumentStats","errorResponses":[{"reason":"Invalid stats type supplied.","code":400}],"nickname":"getDocumentStats","responseClass":"basicDocumentStats","httpMethod":"GET"}]},{"path":"/corpus.{format}/words","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Gets corpus-level WordFrequency","responseTypeInternal":"com.wordnik.corpus.stats.entity.WordFrequency","errorResponses":[{"reason":"No corpus frequency data available.","code":400}],"nickname":"getCorpusWordFrequencies","responseClass":"List[wordFrequency]","httpMethod":"GET"}]},{"path":"/corpus.{format}/recentListedWords","description":"","operations":[{"parameters":[{"name":"limit","description":"Maximun results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns recently listed words.","responseTypeInternal":"com.wordnik.community.entity.WordListingHistory","nickname":"getRecentListedWords","responseClass":"List[wordListingHistory]","httpMethod":"GET"}]},{"path":"/corpus.{format}/views","description":"","operations":[{"parameters":[{"name":"word","description":"Filter by word","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userId","description":"filter by user id","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userGuid","description":"Filter by user guid","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sessionId","description":"Filter by user session id","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"callingClass","description":"Filter by calling class","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"method","description":"Filter by calling method","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"environment","description":"Deployment environment to find results from","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"serverIp","description":"Server IP to query from","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"createdAfter","description":"Date to find results after","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches views from the website.","responseTypeInternal":"com.wordnik.community.entity.WordView","nickname":"getViews","responseClass":"List[wordView]","httpMethod":"GET"}]},{"path":"/corpus.{format}/contextualLookup","description":"","operations":[{"parameters":[{"name":"word","description":"Word of interest","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"contextString","description":"Sentence word appears in","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"title","description":"Word of interest","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"metadataId","description":"Word of interest","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"partnerId","description":"Partner Id","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sourceUrl","description":"Document source URL","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Mock method to return Contextual Lookup info.","responseTypeInternal":"com.wordnik.corpus.model.ContextualLookupResponse","nickname":"getMockContextualLookupInfo","responseClass":"contextualLookupResponse","notes":"Internal Only","httpMethod":"GET"},{"parameters":[{"name":"category","description":"Filters response by category","required":false,"dataType":"contextualLookupRequest","valueTypeInternal":"com.wordnik.corpus.model.ContextualLookupRequest","allowMultiple":false,"paramType":"query"}],"summary":"Fetches ContextualLookup info.","responseTypeInternal":"com.wordnik.corpus.model.ContextualLookupResponse","nickname":"getContextualLookupInfo","responseClass":"contextualLookupResponse","httpMethod":"POST"}]},{"path":"/corpus.{format}/totalWordCount","description":"","operations":[{"summary":"Returns the count of tokens in the Corpus.","responseTypeInternal":"com.wordnik.system.model.LongResult","nickname":"getTotalTokensCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/corpus.{format}/sentenceCount","description":"","operations":[{"summary":"Returns the count of sentences in the Corpus.","responseTypeInternal":"com.wordnik.system.model.LongResult","nickname":"getTotalSentencesCount","responseClass":"long","httpMethod":"GET"}]}],"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1","apiVersion":"4.0"}
data/api_docs/document.json CHANGED
@@ -1 +1 @@
1
- {"resourcePath":"/document","models":{"authorType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"authorType","type":"any","required":false,"uniqueItems":false},"yearType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"yearType","type":"any","required":false,"uniqueItems":false},"documentModel":{"properties":{"biGramFrequency":{"type":"array","required":false,"items":{"$ref":"biGramFrequency","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"sentence":{"type":"array","required":false,"items":{"$ref":"sentence","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"wordFrequency":{"type":"array","required":false,"items":{"$ref":"wordFrequency","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"documentMetadata":{"type":"documentMetadata","required":false,"uniqueItems":false},"basicDocumentStats":{"type":"basicDocumentStats","required":false,"uniqueItems":false}},"id":"documentModel","type":"any","required":false,"uniqueItems":false},"extendedMetadata":{"properties":{"sourceFileSize":{"type":"long","required":false,"uniqueItems":false},"issn":{"type":"string","required":false,"uniqueItems":false},"isbn":{"type":"string","required":false,"uniqueItems":false},"lccn":{"type":"string","required":false,"uniqueItems":false},"documentMetadataId":{"type":"long","required":false,"uniqueItems":false}},"id":"extendedMetadata","type":"any","required":false,"uniqueItems":false},"subjectClassificationType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"subjectClassificationType","type":"any","required":false,"uniqueItems":false},"sentence":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"display":{"type":"string","required":false,"uniqueItems":false},"rating":{"type":"int","required":false,"uniqueItems":false},"documentMetadataId":{"type":"long","required":false,"uniqueItems":false},"scoredWord":{"type":"array","required":false,"items":{"$ref":"scoredWord","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"sentence","type":"any","required":false,"uniqueItems":false},"documentMedium":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"documentMedium","type":"any","required":false,"uniqueItems":false},"contentType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"contentType","type":"any","required":false,"uniqueItems":false},"documentMetadata":{"properties":{"yearType":{"type":"yearType","required":false,"uniqueItems":false},"expirationDate":{"type":"Date","required":false,"uniqueItems":false},"extendedMetadata":{"type":"extendedMetadata","required":false,"uniqueItems":false},"stats":{"type":"basicDocumentStats","required":false,"uniqueItems":false},"tag":{"type":"array","required":false,"items":{"type":"string","required":false,"uniqueItems":false},"uniqueItems":false},"provider":{"type":"contentProvider","required":false,"uniqueItems":false},"contentType":{"type":"contentType","required":false,"uniqueItems":false},"sourceUrl":{"type":"string","required":false,"uniqueItems":false},"date":{"type":"Date","required":false,"uniqueItems":false},"medium":{"type":"documentMedium","required":false,"uniqueItems":false},"guid":{"type":"string","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"author":{"type":"array","required":false,"items":{"$ref":"author","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"title":{"type":"string","required":false,"uniqueItems":false},"primaryAuthorType":{"type":"authorType","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"classification":{"type":"subjectClassificationType","required":false,"uniqueItems":false},"year":{"type":"integer","required":false,"uniqueItems":false},"primaryAuthor":{"type":"string","required":false,"uniqueItems":false},"rating":{"type":"double","required":false,"uniqueItems":false},"primaryAuthorId":{"type":"long","required":false,"uniqueItems":false}},"id":"documentMetadata","type":"any","required":false,"uniqueItems":false},"basicDocumentStats":{"properties":{"uniqueBiGramsCount":{"type":"long","required":false,"uniqueItems":false},"wordsCount":{"type":"long","required":false,"uniqueItems":false},"documentsCount":{"type":"long","required":false,"uniqueItems":false},"firstUsedWordsCount":{"type":"long","required":false,"uniqueItems":false},"tokensCount":{"type":"long","required":false,"uniqueItems":false},"sentencesCount":{"type":"long","required":false,"uniqueItems":false},"viableSentencesCount":{"type":"long","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false},"uniqueWordsCount":{"type":"long","required":false,"uniqueItems":false},"key":{"type":"string","required":false,"uniqueItems":false}},"id":"basicDocumentStats","type":"any","required":false,"uniqueItems":false},"scoredWord":{"properties":{"position":{"type":"int","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"wordType":{"type":"string","required":false,"uniqueItems":false},"score":{"type":"float","required":false,"uniqueItems":false},"sentenceId":{"type":"long","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"partOfSpeech":{"type":"string","required":false,"uniqueItems":false}},"id":"scoredWord","type":"any","required":false,"uniqueItems":false},"author":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"authorType":{"type":"authorType","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"uniqueName":{"type":"string","required":false,"uniqueItems":false}},"id":"author","type":"any","required":false,"uniqueItems":false},"bigram":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"gram2":{"type":"string","required":false,"uniqueItems":false},"gram1":{"type":"string","required":false,"uniqueItems":false},"wlmi":{"type":"double","required":false,"uniqueItems":false},"mi":{"type":"double","required":false,"uniqueItems":false}},"id":"bigram","type":"any","required":false,"uniqueItems":false},"biGramFrequency":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"bigram":{"type":"bigram","required":false,"uniqueItems":false},"wlmi":{"type":"double","required":false,"uniqueItems":false},"mi":{"type":"double","required":false,"uniqueItems":false}},"id":"biGramFrequency","type":"any","required":false,"uniqueItems":false},"contentProvider":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"contentProvider","type":"any","required":false,"uniqueItems":false},"wordFrequency":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"wordFrequency","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/document.{format}/id/{document_id}/words","description":"","operations":[{"parameters":[{"name":"document_id","description":"Document ID to fetch frequency data for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches Document objects by Content Provider code.","httpMethod":"GET","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"getWordFrequencies","responseClass":"List[wordFrequency]"}]},{"path":"/document.{format}/{contentProvider}/documents","description":"","operations":[{"parameters":[{"name":"contentProvider","description":"Partner Code to fetch for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"filterByWordScore","description":"Filter document model by word scores.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minWordScore","description":"Minimum word score to return.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches examples for a specific provider matching a criteria.","httpMethod":"GET","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":404}],"nickname":"getGlossaries","responseClass":"List[documentModel]"}]},{"path":"/document.{format}/provider/{provider}","description":"","operations":[{"parameters":[{"name":"provider","description":"Content provider","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches Document objects by Content Provider code.","httpMethod":"GET","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"getDocumentsByContentProvider","responseClass":"List[documentMetadata]"}]},{"path":"/document.{format}/{id}/metadata","description":"","operations":[{"parameters":[{"name":"id","description":"Document ID","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches Document objects by document identifier.","httpMethod":"GET","errorResponses":[{"reason":"Invalid document ID supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"getMetadataById","responseClass":"documentMetadata"}]},{"path":"/document.{format}/{id}/model","description":"","operations":[{"parameters":[{"name":"scores","description":"Return word scores","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"id","description":"Document ID","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches Document objects by id.","httpMethod":"GET","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"getModelById","responseClass":"documentModel"}]}],"models1":[{"name":"wordFrequency","fields":[{"name":"count","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"sentence","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"scoredWord","required":false,"wrapperName":"scoredWords","allowMultiple":false,"paramType":"List[scoredWord]"},{"name":"display","required":false,"allowMultiple":false,"paramType":"string"},{"name":"documentMetadataId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"rating","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"extendedMetadata","fields":[{"name":"documentMetadataId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"isbn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"issn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"lccn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sourceFileSize","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"documentModel","fields":[{"name":"documentMetadata","required":false,"allowMultiple":false,"paramType":"documentMetadata"},{"name":"basicDocumentStats","required":false,"allowMultiple":false,"paramType":"basicDocumentStats"},{"name":"wordFrequency","required":false,"wrapperName":"wordFrequencies","allowMultiple":false,"paramType":"List[wordFrequency]"},{"name":"sentence","required":false,"wrapperName":"sentences","allowMultiple":false,"paramType":"List[sentence]"},{"name":"biGramFrequency","required":false,"wrapperName":"bigramFrequencies","allowMultiple":false,"paramType":"List[biGramFrequency]"}]},{"name":"biGramFrequency","fields":[{"name":"count","required":false,"allowMultiple":false,"paramType":"long"},{"name":"mi","required":false,"allowMultiple":false,"paramType":"double"},{"name":"wlmi","required":false,"allowMultiple":false,"paramType":"double"},{"name":"bigram","required":false,"allowMultiple":false,"paramType":"bigram"}]},{"name":"author","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"authorType","required":false,"allowMultiple":false,"paramType":"authorType"},{"name":"uniqueName","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"contentType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"bigram","fields":[{"name":"count","required":false,"allowMultiple":false,"paramType":"long"},{"name":"gram1","required":false,"allowMultiple":false,"paramType":"string"},{"name":"gram2","required":false,"allowMultiple":false,"paramType":"string"},{"name":"mi","required":false,"allowMultiple":false,"paramType":"double"},{"name":"wlmi","required":false,"allowMultiple":false,"paramType":"double"}]},{"name":"yearType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"documentMetadata","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"year","required":false,"allowMultiple":false,"paramType":"integer"},{"name":"contentType","required":false,"allowMultiple":false,"paramType":"contentType"},{"name":"provider","required":false,"allowMultiple":false,"paramType":"contentProvider"},{"name":"tag","required":false,"wrapperName":"tags","allowMultiple":false,"paramType":"List[string]"},{"name":"title","required":false,"allowMultiple":false,"paramType":"string"},{"name":"rating","required":false,"allowMultiple":false,"paramType":"double"},{"name":"medium","required":false,"allowMultiple":false,"paramType":"documentMedium"},{"name":"sourceUrl","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"classification","required":false,"allowMultiple":false,"paramType":"subjectClassificationType"},{"name":"date","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"yearType","required":false,"allowMultiple":false,"paramType":"yearType"},{"name":"primaryAuthor","required":false,"allowMultiple":false,"paramType":"string"},{"name":"primaryAuthorType","required":false,"allowMultiple":false,"paramType":"authorType"},{"name":"primaryAuthorId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"guid","required":false,"allowMultiple":false,"paramType":"string"},{"name":"extendedMetadata","required":false,"allowMultiple":false,"paramType":"extendedMetadata"},{"name":"author","required":false,"wrapperName":"authors","allowMultiple":false,"paramType":"List[author]"},{"name":"expirationDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"stats","required":false,"allowMultiple":false,"paramType":"basicDocumentStats"}]},{"name":"documentMedium","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"subjectClassificationType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"contentProvider","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"authorType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"scoredWord","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"position","required":false,"allowMultiple":false,"paramType":"int"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"score","required":false,"allowMultiple":false,"paramType":"float"},{"name":"sentenceId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"partOfSpeech","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"basicDocumentStats","fields":[{"name":"key","required":false,"allowMultiple":false,"paramType":"string"},{"name":"type","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sentencesCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"uniqueWordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"documentsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"tokensCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"firstUsedWordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"viableSentencesCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"uniqueBiGramsCount","required":false,"allowMultiple":false,"paramType":"long"}]}],"basePath":"url","swaggerVersion":"1.0"}
1
+ {"resourcePath":"/document","models":{"DocumentMetadata":{"properties":{"yearType":{"type":"yearType"},"expirationDate":{"type":"Date"},"extendedMetadata":{"type":"extendedMetadata"},"tag":{"type":"array","items":{"type":"string"}},"stats":{"type":"basicDocumentStats"},"provider":{"type":"contentProvider"},"contentType":{"type":"contentType"},"sourceUrl":{"type":"string"},"date":{"type":"Date"},"medium":{"type":"documentMedium"},"guid":{"type":"string"},"id":{"type":"long"},"author":{"type":"array","items":{"$ref":"author"}},"title":{"type":"string"},"primaryAuthorType":{"type":"authorType"},"createdAt":{"type":"Date"},"classification":{"type":"subjectClassificationType"},"year":{"type":"integer"},"primaryAuthor":{"type":"string"},"rating":{"type":"double"},"primaryAuthorId":{"type":"long"}},"id":"documentMetadata"},"DocumentModel":{"properties":{"biGramFrequency":{"type":"array","items":{"$ref":"biGramFrequency"}},"sentence":{"type":"array","items":{"$ref":"sentence"}},"wordFrequency":{"type":"array","items":{"$ref":"wordFrequency"}},"documentMetadata":{"type":"documentMetadata"},"basicDocumentStats":{"type":"basicDocumentStats"}},"id":"documentModel"},"ExtendedMetadata":{"properties":{"sourceFileSize":{"type":"long"},"issn":{"type":"string"},"isbn":{"type":"string"},"lccn":{"type":"string"},"documentMetadataId":{"type":"long"}},"id":"extendedMetadata"},"Author":{"properties":{"id":{"type":"long"},"authorType":{"type":"authorType"},"createdAt":{"type":"Date"},"description":{"type":"string"},"name":{"type":"string"},"uniqueName":{"type":"string"}},"id":"author"},"ScoredWord":{"properties":{"position":{"type":"int"},"id":{"type":"long"},"wordType":{"type":"string"},"score":{"type":"float"},"sentenceId":{"type":"long"},"word":{"type":"string"},"partOfSpeech":{"type":"string"}},"id":"scoredWord"},"DocumentMedium":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"documentMedium"},"YearType":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"yearType"},"BiGramFrequency":{"properties":{"count":{"type":"long"},"bigram":{"type":"bigram"},"wlmi":{"type":"double"},"mi":{"type":"double"}},"id":"biGramFrequency"},"WordFrequency":{"properties":{"count":{"type":"long"},"wordstring":{"type":"string"}},"id":"wordFrequency"},"Sentence":{"properties":{"id":{"type":"long"},"display":{"type":"string"},"rating":{"type":"int"},"documentMetadataId":{"type":"long"},"scoredWord":{"type":"array","items":{"$ref":"scoredWord"}}},"id":"sentence"},"SubjectClassificationType":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"subjectClassificationType"},"ContentProvider":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"contentProvider"},"Bigram":{"properties":{"count":{"type":"long"},"gram2":{"type":"string"},"gram1":{"type":"string"},"wlmi":{"type":"double"},"mi":{"type":"double"}},"id":"bigram"},"AuthorType":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"authorType"},"BasicDocumentStats":{"properties":{"uniqueBiGramsCount":{"type":"long"},"wordsCount":{"type":"long"},"documentsCount":{"type":"long"},"firstUsedWordsCount":{"type":"long"},"tokensCount":{"type":"long"},"sentencesCount":{"type":"long"},"viableSentencesCount":{"type":"long"},"type":{"type":"string"},"uniqueWordsCount":{"type":"long"},"key":{"type":"string"}},"id":"basicDocumentStats"},"ContentType":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"contentType"}},"apis":[{"path":"/document.{format}/id/{document_id}/words","description":"","operations":[{"parameters":[{"name":"document_id","description":"Document ID to fetch frequency data for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches Document objects by Content Provider code.","responseTypeInternal":"com.wordnik.corpus.stats.entity.WordFrequency","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"getWordFrequencies","responseClass":"List[wordFrequency]","httpMethod":"GET"}]},{"path":"/document.{format}/{contentProvider}/documents","description":"","operations":[{"parameters":[{"name":"contentProvider","description":"Partner Code to fetch for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"filterByWordScore","description":"Filter document model by word scores.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minWordScore","description":"Minimum word score to return.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches examples for a specific provider matching a criteria.","responseTypeInternal":"com.wordnik.corpus.document.entity.DocumentModel","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":404}],"nickname":"getGlossaries","responseClass":"List[documentModel]","httpMethod":"GET"}]},{"path":"/document.{format}/provider/{provider}","description":"","operations":[{"parameters":[{"name":"provider","description":"Content provider","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches Document objects by Content Provider code.","responseTypeInternal":"com.wordnik.corpus.document.entity.DocumentMetadata","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"getDocumentsByContentProvider","responseClass":"List[documentMetadata]","httpMethod":"GET"}]},{"path":"/document.{format}/{id}/metadata","description":"","operations":[{"parameters":[{"name":"id","description":"Document ID","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches Document objects by document identifier.","responseTypeInternal":"com.wordnik.corpus.document.entity.DocumentMetadata","errorResponses":[{"reason":"Invalid document ID supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"getMetadataById","responseClass":"documentMetadata","httpMethod":"GET"}]},{"path":"/document.{format}/{id}/model","description":"","operations":[{"parameters":[{"name":"scores","description":"Return word scores","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"id","description":"Document ID","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches Document objects by id.","responseTypeInternal":"com.wordnik.corpus.document.entity.DocumentModel","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"getModelById","responseClass":"documentModel","httpMethod":"GET"}]}],"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1","apiVersion":"4.0"}
data/api_docs/glossary.json ADDED
@@ -0,0 +1 @@
1
+ {"resourcePath":"/glossary","models":{"Glossary":{"properties":{"updatedAt":{"type":"Date"},"id":{"type":"long"},"permalinkId":{"type":"string"},"status":{"type":"glossaryStatus"},"createdAt":{"type":"Date"},"description":{"type":"string"},"name":{"type":"string"},"partnerId":{"type":"string"},"totalEntries":{"type":"int"},"publishedDate":{"type":"Date"},"version":{"type":"double"}},"id":"Glossary"},"AudioType":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"audioType"},"Note":{"properties":{"noteType":{"type":"string"},"appliesTo":{"type":"array","items":{"type":"string"}},"value":{"type":"string"},"pos":{"type":"int"}},"id":"note"},"Related":{"properties":{"label1":{"type":"string"},"label2":{"type":"string"},"relationshipType":{"type":"string"},"label3":{"type":"string"},"word":{"type":"array","items":{"type":"string"}},"gram":{"type":"string"},"label4":{"type":"string"}},"id":"related"},"ScoredWord":{"properties":{"position":{"type":"int"},"id":{"type":"long"},"wordType":{"type":"string"},"score":{"type":"float"},"sentenceId":{"type":"long"},"word":{"type":"string"},"partOfSpeech":{"type":"string"}},"id":"scoredWord"},"Citation":{"properties":{"cite":{"type":"string"},"source":{"type":"string"}},"id":"citation"},"GlossaryStatus":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"glossaryStatus"},"GlossaryEntry":{"properties":{"definition":{"type":"array","items":{"$ref":"definition"}},"example":{"type":"array","items":{"$ref":"example"}},"glossaryId":{"type":"long"},"audioFile":{"type":"array","items":{"$ref":"audioFile"}},"wordstring":{"type":"string"}},"id":"GlossaryEntry"},"Category":{"properties":{"name":{"type":"string"}},"id":"category"},"Example":{"properties":{"exampleId":{"type":"long"},"title":{"type":"string"},"text":{"type":"string"},"word":{"type":"string"},"provider":{"type":"contentProvider"},"year":{"type":"integer"},"rating":{"type":"float"},"documentId":{"type":"long"},"url":{"type":"string"}},"id":"example"},"Root":{"properties":{"name":{"type":"string"},"categories":{"type":"array","items":{"$ref":"category"}}},"id":"root"},"Sentence":{"properties":{"id":{"type":"long"},"display":{"type":"string"},"rating":{"type":"int"},"documentMetadataId":{"type":"long"},"scoredWord":{"type":"array","items":{"$ref":"scoredWord"}}},"id":"sentence"},"ExampleUsage":{"properties":{"text":{"type":"string"}},"id":"ExampleUsage"},"ContentProvider":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"contentProvider"},"AudioFile":{"properties":{"attributedWordLink":{"type":"string"},"commentCount":{"type":"int"},"voteCount":{"type":"integer"},"fileUrl":{"type":"string"},"audioType":{"type":"string"},"id":{"type":"long","required":true},"duration":{"type":"double"},"createdBy":{"type":"string"},"description":{"type":"string"},"createdAt":{"type":"Date"},"dictionaryAttribution":{"type":"string"},"voteWeightedAverage":{"type":"float"},"voteAverage":{"type":"float"},"word":{"type":"string"}},"id":"audioFile"},"Label":{"properties":{"text":{"type":"string"},"type":{"type":"string"}},"id":"Label"},"Definition":{"properties":{"extendedText":{"type":"string"},"citation":{"type":"array","items":{"$ref":"citation"}},"text":{"type":"string"},"sourceDictionary":{"type":"string"},"exampleUsage":{"type":"array","items":{"$ref":"ExampleUsage"}},"relWord":{"type":"array","items":{"$ref":"related"}},"score":{"type":"float"},"label":{"type":"array","items":{"$ref":"Label"}},"seqString":{"type":"string"},"dictionaryAttribution":{"type":"string"},"sequence":{"type":"string"},"word":{"type":"string"},"note":{"type":"array","items":{"$ref":"note"}},"textPron":{"type":"array","items":{"$ref":"textPron"}},"partOfSpeech":{"type":"string"}},"id":"definition"},"PartOfSpeech":{"properties":{"roots":{"type":"array","items":{"$ref":"root"}}},"id":"partOfSpeech"},"TextPron":{"properties":{"raw":{"type":"string"},"id":{"type":"long"},"seq":{"type":"int"},"rawType":{"type":"string"}},"id":"textPron"}},"apis":[{"path":"/glossary.{format}/{permalinkId}/search","description":"","operations":[{"parameters":[{"name":"permalinkId","description":"Permalink of Glossary. This will be provided by wordnik and will be different in staging and production.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"version","description":"Specific Glossary version to fetch Entries for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"wordPattern","description":"Word pattern to fetch with. You can use * and ?.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sourceDictionaries","description":"Gets defintions for the matched word from dictionaries in the supplied order of precedence","required":false,"dataType":"string","allowableValues":{"values":["ahd"," century"," wiktionary"," webster"," wordnet"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"definitionsLimit","description":"Maximum number of definitions to return for the word that matches the exact input","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"examplesLimit","description":"Maximum number of examples to return for the word that matches the exact input","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"audioPronunciationsLimit","description":"Maximum number of audio pronunciations to return for the word that matches the exact input","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches GlossaryEntry objects for the specified Glossary. The definitions will come as per the dictionary source order. The first definition can be used to give quick overview of the word. If exact match is found, first record from the search result will be the exact match. First record will also have all the data needed to display definition, pronunciation and example usages. if it is exact match.","responseTypeInternal":"com.wordnik.community.entity.GlossaryEntry","errorResponses":[{"reason":"Invalid permalinkId supplied.","code":404}],"nickname":"getGlossaryEntries","responseClass":"List[GlossaryEntry]","httpMethod":"GET"}]},{"path":"/glossary.{format}/{permalinkId}/publish","description":"","operations":[{"parameters":[{"name":"permalinkId","description":"Permalink of Glossary to publish.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"version","description":"Version to publish.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Publishes a Glossary.","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid Permalink ID supplied.","code":404}],"nickname":"publishGlossary","responseClass":"ok","httpMethod":"POST"}]},{"path":"/glossary.{format}/{permalinkId}/clone","description":"","operations":[{"parameters":[{"name":"permalinkId","description":"Permalink of Glossary to version.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"version","description":"New version number to assign.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Creates a new version of a Glossary.","responseTypeInternal":"com.wordnik.community.entity.Glossary","errorResponses":[{"reason":"Invalid Permalink ID supplied.","code":404}],"nickname":"createVersion","responseClass":"Glossary","httpMethod":"POST"}]},{"path":"/glossary.{format}/{permalinkId}/entries","description":"","operations":[{"parameters":[{"name":"permalinkId","description":"Permalink of Glossary.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"version","description":"Specific Glossary version to fetch Entries for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"description":"Glossary Entries to add","required":false,"dataType":"GlossaryEntry[]","valueTypeInternal":"[Lcom.wordnik.community.entity.GlossaryEntry;","allowMultiple":false,"paramType":"body"}],"summary":"Adds GlossaryEntry objects for the specified Glossary.","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid Permalink ID supplied.","code":404}],"nickname":"addGlossaryEntry","responseClass":"ok","httpMethod":"POST"}]},{"path":"/glossary.{format}/{permalinkId}/entries/{word}","description":"","operations":[{"parameters":[{"name":"permalinkId","description":"Permalink of Glossary.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"word","description":"Word to remove.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"version","description":"Specific Glossary version to fetch Entries for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Removes a GlossaryEntry object from the specified Glossary.","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word being removed.","code":400},{"reason":"Invalid Permalink ID supplied.","code":404}],"nickname":"deleteGlossaryEntry","responseClass":"ok","httpMethod":"DELETE"}]},{"path":"/glossary.{format}/{permalinkId}/deleteEntries","description":"","operations":[{"parameters":[{"name":"permalinkId","description":"Permalink of Glossary.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Words to remove.","required":false,"dataType":"StringValue[]","valueTypeInternal":"[Lcom.wordnik.resource.StringValue;","allowMultiple":false,"paramType":"body"},{"name":"version","description":"Specific Glossary version to remove Entries from","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Removes a GlossaryEntry object from the specified Glossary.","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word being removed.","code":400},{"reason":"Invalid Permalink ID supplied.","code":404}],"nickname":"deleteGlossaryEntries","responseClass":"ok","httpMethod":"POST"}]},{"path":"/glossary.{format}/{permalinkId}/randomEntry","description":"","operations":[{"parameters":[{"name":"permalinkId","description":"Permalink of Glossary.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"version","description":"Specific Glossary version to fetch Entries for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sourceDictionaries","description":"Gets definitions from dictionaries in the supplied order of precedence","required":false,"dataType":"string","allowableValues":{"values":["ahd"," century"," wiktionary"," webster"," wordnet"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"definitionsLimit","description":"Maximum number of definitions to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"examplesLimit","description":"Maximum number of examples to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"audioPronunciationsLimit","description":"Maximum number of audio pronunciations to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches a random GlossaryEntry object for the specified Glossary.","responseTypeInternal":"com.wordnik.community.entity.GlossaryEntry","errorResponses":[{"reason":"Invalid Permalink ID supplied.","code":404}],"nickname":"getRandomGlossaryEntry","responseClass":"GlossaryEntry","httpMethod":"GET"}]},{"path":"/glossary.{format}/{permalinkId}/entry","description":"","operations":[{"parameters":[{"name":"permalinkId","description":"Permalink of Glossary.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"version","description":"Specific Glossary version to fetch Entries for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"word","description":"The word for which the Glossary Entry is requested","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sourceDictionaries","description":"Gets definitions from dictionaries in the supplied order of precedence","required":false,"dataType":"string","allowableValues":{"values":["ahd"," century"," wiktionary"," webster"," wordnet"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"definitionsLimit","description":"Maximum number of definitions to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"examplesLimit","description":"Maximum number of examples to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"audioPronunciationsLimit","description":"Maximum number of audio pronunciations to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches the GlossaryEntry object for the specified word in the Glossary.","responseTypeInternal":"com.wordnik.community.entity.GlossaryEntry","errorResponses":[{"reason":"Invalid word being removed.","code":400},{"reason":"Invalid Permalink ID supplied.","code":404}],"nickname":"getGlossaryEntry","responseClass":"GlossaryEntry","httpMethod":"GET"}]},{"path":"/glossary.{format}/{permalinkId}/{word}/examples","description":"","operations":[{"parameters":[{"name":"permalinkId","description":"Permalink of Glossary.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"version","description":"Specific Glossary version to fetch Entries for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"word","description":"The word for which the Glossary Entry is requested","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":{"max":1000.0,"min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":{"max":1000.0,"min":1.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"}],"summary":"Fetches examples for the Glossary entry","responseTypeInternal":"com.wordnik.corpus.model.Example","errorResponses":[{"reason":"Invalid word being removed.","code":400},{"reason":"Invalid Permalink ID supplied.","code":404}],"nickname":"getGlossaryEntryExamples","responseClass":"example","httpMethod":"GET"}]},{"path":"/glossary.{format}/{permalinkId}/{word}/pronunciation/{pronId}","description":"","operations":[{"parameters":[{"name":"permalinkId","description":"Permalink of Glossary.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"version","description":"Specific Glossary version to fetch Entries for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"word","description":"The word for which the Glossary Entry is requested","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"pronId","description":"The pronunciation id for which the audio metadata is requested","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches audio pronunciation for the given id.","responseTypeInternal":"com.wordnik.community.entity.AudioFileMetadata","errorResponses":[{"reason":"Invalid pronunciation id supplied.","code":404}],"nickname":"getAudioFile","responseClass":"audioFile","httpMethod":"GET"}]}],"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1","apiVersion":"4.0"}
data/api_docs/suggest.json CHANGED
@@ -1 +1 @@
1
- {"resourcePath":"/suggest","models":{"searchResult":{"properties":{"matches":{"type":"int","required":false,"uniqueItems":false},"more":{"type":"int","required":false,"uniqueItems":false},"searchTerm":{"type":"wordResult","required":false,"uniqueItems":false},"match":{"type":"array","required":false,"items":{"$ref":"wordResult","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"searchResult","type":"any","required":false,"uniqueItems":false},"wordResult":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"wordResult","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/suggest.{format}/tags/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"Word fragment to use.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns Word strings based on the input.","httpMethod":"GET","errorResponses":[{"reason":"Invalid Word Fragment supplied.","code":400}],"nickname":"getTagSuggestions","responseClass":"searchResult"}]}],"models1":[{"name":"wordResult","fields":[{"name":"count","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"searchResult","fields":[{"name":"matches","required":false,"allowMultiple":false,"paramType":"int"},{"name":"match","required":false,"allowMultiple":false,"paramType":"List[wordResult]"},{"name":"searchTerm","required":false,"allowMultiple":false,"paramType":"wordResult"},{"name":"more","required":false,"allowMultiple":false,"paramType":"int"}]}],"basePath":"url","swaggerVersion":"1.0"}
1
+ {"resourcePath":"/suggest","models":{"WordResult":{"properties":{"count":{"type":"long"},"wordstring":{"type":"string"}},"id":"wordResult"},"SearchResult":{"properties":{"matches":{"type":"int"},"more":{"type":"int"},"searchTerm":{"type":"wordResult"},"match":{"type":"array","items":{"$ref":"wordResult"}}},"id":"searchResult"}},"apis":[{"path":"/suggest.{format}/tags/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"Word fragment to use.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns Word strings based on the input.","responseTypeInternal":"com.wordnik.resource.SearchResult","errorResponses":[{"reason":"Invalid Word Fragment supplied.","code":400}],"nickname":"getTagSuggestions","responseClass":"searchResult","httpMethod":"GET"}]}],"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1","apiVersion":"4.0"}
data/api_docs/system.json CHANGED
@@ -1 +1 @@
1
- {"resourcePath":"/system","models":{"contentProvider":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"contentProvider","type":"any","required":false,"uniqueItems":false},"word":{"properties":{"numericProperties":{"type":"Map[string,double]","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"stringProperties":{"type":"Map[string,string]","required":false,"uniqueItems":false}},"id":"word","type":"any","required":false,"uniqueItems":false},"wordStats":{"properties":{"wordsListedCount":{"type":"long","required":false,"uniqueItems":false},"externalApiCallsCount":{"type":"long","required":false,"uniqueItems":false},"favoritesCount":{"type":"long","required":false,"uniqueItems":false},"wordViewCount":{"type":"long","required":false,"uniqueItems":false},"tokensCount":{"type":"long","required":false,"uniqueItems":false},"sentencesCount":{"type":"long","required":false,"uniqueItems":false},"apiUsersCount":{"type":"long","required":false,"uniqueItems":false},"commentsCount":{"type":"long","required":false,"uniqueItems":false},"audioPronsCount":{"type":"long","required":false,"uniqueItems":false},"listsCount":{"type":"long","required":false,"uniqueItems":false},"documentsCount":{"type":"long","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"elapsedMillis":{"type":"long","required":false,"uniqueItems":false},"userLoginCount":{"type":"long","required":false,"uniqueItems":false},"prettyWordsCount":{"type":"long","required":false,"uniqueItems":false},"usersCount":{"type":"long","required":false,"uniqueItems":false},"taggedObjectsCount":{"type":"long","required":false,"uniqueItems":false},"uniqueWordsCount":{"type":"long","required":false,"uniqueItems":false},"tagsCount":{"type":"long","required":false,"uniqueItems":false}},"id":"wordStats","type":"any","required":false,"uniqueItems":false},"long":{"properties":{"value":{"type":"long","required":false,"uniqueItems":false}},"id":"long","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/system.{format}/providers","description":"","operations":[{"summary":"Returns all defined ContentProviders.","httpMethod":"GET","nickname":"getProviders","responseClass":"List[contentProvider]"}]},{"path":"/system.{format}/stats","description":"","operations":[{"parameters":[{"name":"skip","required":true,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","required":true,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"delta","required":true,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns system-wide statistics for the platform.","httpMethod":"GET","nickname":"getStats","responseClass":"List[wordStats]"}]},{"path":"/system.{format}/{word}/related","description":"","operations":[{"parameters":[{"name":"word","description":"Word to find related items for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"type","description":"Relationship type","required":false,"dataType":"string","allowableValues":["synonym","antonym","variant","equivalent","cross-reference","related-word","rhyme","form","etymologically-related-term","hypernym","hyponym","inflected-form","primary","same-context","verb-form","verb-stem","unknown"],"allowMultiple":false,"paramType":"query"}],"summary":"Returns weighted terms related to the input word","httpMethod":"GET","errorResponses":[{"reason":"No data found.","code":404}],"nickname":"getRelatedWords","responseClass":"relatedWord"}]},{"path":"/system.{format}/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to find attributes for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"useLiteral","description":"Use exact word","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns a word with attributes","httpMethod":"GET","errorResponses":[{"reason":"No data found.","code":404}],"nickname":"getRelatedWords","responseClass":"word"}]},{"path":"/system.{format}/graph","description":"","operations":[{"parameters":[{"name":"term","description":"Term to query","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"objectType","description":"Object type","required":false,"dataType":"string","allowableValues":["word"],"allowMultiple":false,"paramType":"query"},{"name":"excludeEdgeTypes","description":"Relationships to exclude","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"includeEdgeTypes","description":"Specifies the only relationship to include (note, this overrides the exclusions)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"startConstraints","description":"Edge start constraints to enforce","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"endConstraints","description":"Edge end constraints to enforce","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxHops","defaultValue":"2","description":"Maximum number of to route","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxResults","defaultValue":"2","description":"Maximum number of routes to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"destination","description":"Destination to route to (VERY inefficient)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"useGraphML","description":"Return is GraphML format","required":false,"dataType":"string","allowableValues":["true","false"],"allowMultiple":false,"paramType":"query"},{"name":"goal","description":"Selection goal","required":false,"dataType":"string","allowableValues":["content","similar","basic-form"],"allowMultiple":false,"paramType":"query"}],"summary":"Returns a graph response for the supplied terms","httpMethod":"GET","errorResponses":[{"reason":"Invalid query.","code":400},{"reason":"No data found.","code":404}],"nickname":"getWordById","responseClass":"com.wordnik.graph.RouteResponse"}]},{"path":"/system.{format}/audioRecordId","description":"","operations":[{"summary":"Gets an Audio File ID for recording.","httpMethod":"GET","nickname":"getAudioRecordId","responseClass":"long"}]},{"path":"/system.{format}/audioDuration","description":"","operations":[{"parameters":[{"name":"audioFileId","description":"Audio file id","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"duration","description":"Audio duration","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Sets duration of an Audio File","httpMethod":"POST","errorResponses":[{"reason":"Invalid audio file id supplied.","code":400}],"nickname":"setAudioDuration","responseClass":"ok"}]}],"models1":[{"name":"wordStats","fields":[{"name":"sentencesCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"uniqueWordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"apiUsersCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"audioPronsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"commentsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"documentsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"externalApiCallsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"favoritesCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"listsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"userLoginCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"prettyWordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"taggedObjectsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"tagsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"tokensCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordsListedCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordViewCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"usersCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"elapsedMillis","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"contentProvider","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"word","fields":[{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"stringProperties","required":false,"allowMultiple":false,"paramType":"Map[string,string]"},{"name":"numericProperties","required":false,"allowMultiple":false,"paramType":"Map[string,double]"}]},{"name":"long","fields":[{"name":"value","required":false,"allowMultiple":false,"paramType":"long"}]}],"basePath":"url","swaggerVersion":"1.0"}
1
+ {"resourcePath":"/system","models":{"Long":{"properties":{"value":{"type":"long"}},"id":"long"},"Word":{"properties":{"numericProperties":{"type":"Map[string,double]"},"word":{"type":"string"},"stringProperties":{"type":"Map[string,string]"}},"id":"word"},"WordStats":{"properties":{"wordsListedCount":{"type":"long"},"externalApiCallsCount":{"type":"long"},"favoritesCount":{"type":"long"},"wordViewCount":{"type":"long"},"tokensCount":{"type":"long"},"sentencesCount":{"type":"long"},"apiUsersCount":{"type":"long"},"commentsCount":{"type":"long"},"audioPronsCount":{"type":"long"},"listsCount":{"type":"long"},"documentsCount":{"type":"long"},"createdAt":{"type":"Date"},"elapsedMillis":{"type":"long"},"userLoginCount":{"type":"long"},"prettyWordsCount":{"type":"long"},"usersCount":{"type":"long"},"taggedObjectsCount":{"type":"long"},"uniqueWordsCount":{"type":"long"},"tagsCount":{"type":"long"}},"id":"wordStats"},"ContentProvider":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"contentProvider"}},"apis":[{"path":"/system.{format}/providers","description":"","operations":[{"summary":"Returns all defined ContentProviders.","responseTypeInternal":"com.wordnik.corpus.document.model.ContentProvider","nickname":"getProviders","responseClass":"List[contentProvider]","httpMethod":"GET"}]},{"path":"/system.{format}/{word}/related","description":"","operations":[{"parameters":[{"name":"word","description":"Word to find related items for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"type","description":"Relationship type","required":false,"dataType":"string","allowableValues":{"values":["synonym","antonym","variant","equivalent","cross-reference","related-word","rhyme","form","etymologically-related-term","hypernym","hyponym","inflected-form","primary","same-context","verb-form","verb-stem","unknown"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"}],"summary":"Returns weighted terms related to the input word","responseTypeInternal":"com.wordnik.graph.WeightedRelatedWord","errorResponses":[{"reason":"No data found.","code":404}],"nickname":"getRelatedWords","responseClass":"relatedWord","httpMethod":"GET"}]},{"path":"/system.{format}/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to find attributes for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useLiteral","description":"Use exact word","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns a word with attributes","responseTypeInternal":"com.wordnik.graph.DetailedNode","errorResponses":[{"reason":"No data found.","code":404}],"nickname":"getRelatedWords","responseClass":"word","httpMethod":"GET"}]},{"path":"/system.{format}/graph","description":"","operations":[{"parameters":[{"name":"term","description":"Term to query","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"objectType","description":"Object type","required":false,"dataType":"string","allowableValues":{"values":["word"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"excludeEdgeTypes","description":"Relationships to exclude","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"includeEdgeTypes","description":"Specifies the only relationship to include (note, this overrides the exclusions)","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"startConstraints","description":"Edge start constraints to enforce","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"endConstraints","description":"Edge end constraints to enforce","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"maxHops","defaultValue":"2","description":"Maximum number of to route","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"maxResults","defaultValue":"2","description":"Maximum number of routes to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"destination","description":"Destination to route to (VERY inefficient)","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"useGraphML","description":"Return is GraphML format","required":false,"dataType":"string","allowableValues":{"values":["true","false"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"goal","description":"Selection goal","required":false,"dataType":"string","allowableValues":{"values":["content","similar","basic-form"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"}],"summary":"Returns a graph response for the supplied terms","responseTypeInternal":"com.wordnik.graph.RouteResponse","errorResponses":[{"reason":"Invalid query.","code":400},{"reason":"No data found.","code":404}],"nickname":"getWordById","responseClass":"com.wordnik.graph.RouteResponse","httpMethod":"GET"}]},{"path":"/system.{format}/audioRecordId","description":"","operations":[{"summary":"Gets an Audio File ID for recording.","responseTypeInternal":"com.wordnik.system.model.LongResult","nickname":"getAudioRecordId","responseClass":"long","httpMethod":"GET"}]},{"path":"/system.{format}/audioDuration","description":"","operations":[{"parameters":[{"name":"audioFileId","description":"Audio file id","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"duration","description":"Audio duration","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Sets duration of an Audio File","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid audio file id supplied.","code":400}],"nickname":"setAudioDuration","responseClass":"ok","httpMethod":"POST"}]},{"path":"/system.{format}/stats","description":"","operations":[{"parameters":[{"name":"skip","required":true,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","required":true,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"delta","required":true,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns system-wide statistics for the platform.","responseTypeInternal":"com.wordnik.system.model.SystemStats","nickname":"getStats","responseClass":"List[wordStats]","httpMethod":"GET"}]}],"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1","apiVersion":"4.0"}
data/api_docs/tag.json CHANGED
@@ -1 +1 @@
1
- {"resourcePath":"/tag","models":{"wordObject":{"properties":{"word":{"type":"string","required":false,"uniqueItems":false},"vulgar":{"type":"string","required":false,"uniqueItems":false}},"id":"wordObject","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/tag.{format}/{tag}/word","description":"","operations":[{"parameters":[{"name":"tag","description":"Tag to fetch words for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"userName","description":"Username to restrict results to","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches Words with a specific Tag.","httpMethod":"GET","errorResponses":[{"reason":"Invalid Tag supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getWordsTagged","responseClass":"List[wordObject]"}]}],"models1":[{"name":"wordObject","fields":[{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"vulgar","required":false,"allowMultiple":false,"paramType":"string"}]}],"basePath":"url","swaggerVersion":"1.0"}
1
+ {"resourcePath":"/tag","models":{"WordObject":{"properties":{"word":{"type":"string"},"vulgar":{"type":"string"}},"id":"wordObject"}},"apis":[{"path":"/tag.{format}/{tag}/word","description":"","operations":[{"parameters":[{"name":"tag","description":"Tag to fetch words for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"userName","description":"Username to restrict results to","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches Words with a specific Tag.","responseTypeInternal":"com.wordnik.corpus.entity.Word","errorResponses":[{"reason":"Invalid Tag supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getWordsTagged","responseClass":"List[wordObject]","httpMethod":"GET"}]}],"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1","apiVersion":"4.0"}
data/api_docs/user.json CHANGED
@@ -1 +1 @@
1
- {"resourcePath":"/user","models":{"SubscriptionStatus":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"SubscriptionStatus","type":"any","required":false,"uniqueItems":false},"wordOfTheDayList":{"properties":{"subscriptionNamespace":{"type":"string","required":false,"uniqueItems":false},"subscriberCount":{"type":"int","required":false,"uniqueItems":false},"commentCount":{"type":"int","required":false,"uniqueItems":false},"subscriptionIdentifier":{"type":"string","required":false,"uniqueItems":false},"firstItemDate":{"type":"Date","required":false,"uniqueItems":false},"voteCount":{"type":"integer","required":false,"uniqueItems":false},"id":{"type":"string","required":true,"uniqueItems":false},"category":{"type":"string","required":false,"uniqueItems":false},"createdBy":{"type":"string","required":false,"uniqueItems":false},"items":{"type":"array","required":false,"items":{"$ref":"WordOfTheDay","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"voteWeightedAverage":{"type":"float","required":false,"uniqueItems":false},"subscriptionSchedule":{"type":"string","required":false,"uniqueItems":false},"lastItemDate":{"type":"Date","required":false,"uniqueItems":false},"voteAverage":{"type":"float","required":false,"uniqueItems":false},"itemCount":{"type":"int","required":false,"uniqueItems":false},"subscriptionStatus":{"type":"string","required":false,"uniqueItems":false}},"id":"wordOfTheDayList","type":"any","required":false,"uniqueItems":false},"Principal":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"token":{"type":"string","required":false,"uniqueItems":false},"wordnikUserId":{"type":"long","required":false,"uniqueItems":false},"type":{"type":"int","required":false,"uniqueItems":false}},"id":"Principal","type":"any","required":false,"uniqueItems":false},"UserHandle":{"properties":{"webService":{"type":"int","required":false,"uniqueItems":false},"handle":{"type":"string","required":false,"uniqueItems":false}},"id":"UserHandle","type":"any","required":false,"uniqueItems":false},"tag":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"count":{"type":"long","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"tag","type":"any","required":false,"uniqueItems":false},"userTagHistory":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"wordId":{"type":"long","required":false,"uniqueItems":false},"tagDate":{"type":"Date","required":false,"uniqueItems":false},"tag":{"type":"string","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"tagId":{"type":"long","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"userTagHistory","type":"any","required":false,"uniqueItems":false},"WordOfTheDay":{"properties":{"id":{"type":"long","required":true,"uniqueItems":false},"parentId":{"type":"string","required":false,"uniqueItems":false},"category":{"type":"string","required":false,"uniqueItems":false},"definition":{"type":"array","required":false,"items":{"$ref":"SimpleDefinition","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"createdBy":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"contentProvider":{"type":"contentProvider","required":false,"uniqueItems":false},"htmlExtra":{"type":"string","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"example":{"type":"array","required":false,"items":{"$ref":"SimpleExample","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"note":{"type":"string","required":false,"uniqueItems":false},"publishDate":{"type":"Date","required":false,"uniqueItems":false}},"id":"WordOfTheDay","type":"any","required":false,"uniqueItems":false},"long":{"properties":{"value":{"type":"long","required":false,"uniqueItems":false}},"id":"long","type":"any","required":false,"uniqueItems":false},"UgcSummary":{"properties":{"ugcEvents":{"type":"Map[string,Date]","required":false,"uniqueItems":false},"ugcLabels":{"type":"Map[string,string]","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"ugcCounters":{"type":"Map[string,long]","required":false,"uniqueItems":false}},"id":"UgcSummary","type":"any","required":false,"uniqueItems":false},"SimpleDefinition":{"properties":{"text":{"type":"string","required":false,"uniqueItems":false},"source":{"type":"string","required":false,"uniqueItems":false},"note":{"type":"string","required":false,"uniqueItems":false},"partOfSpeech":{"type":"string","required":false,"uniqueItems":false}},"id":"SimpleDefinition","type":"any","required":false,"uniqueItems":false},"wordObject":{"properties":{"word":{"type":"string","required":false,"uniqueItems":false},"vulgar":{"type":"string","required":false,"uniqueItems":false}},"id":"wordObject","type":"any","required":false,"uniqueItems":false},"UserTrackingInfo":{"properties":{"signupDate":{"type":"Date","required":false,"uniqueItems":false},"lastLoginDate":{"type":"Date","required":false,"uniqueItems":false},"noOfLogins":{"type":"int","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"lastUpdatedDate":{"type":"Date","required":false,"uniqueItems":false},"signupIPAddress":{"type":"string","required":false,"uniqueItems":false}},"id":"UserTrackingInfo","type":"any","required":false,"uniqueItems":false},"audioObject":{"properties":{"recordId":{"type":"string","required":false,"uniqueItems":false},"wordId":{"type":"long","required":false,"uniqueItems":false},"audioFileType":{"type":"audioType","required":false,"uniqueItems":false},"filePath":{"type":"string","required":false,"uniqueItems":false},"type":{"type":"audioType","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"duration":{"type":"double","required":false,"uniqueItems":false},"createdBy":{"type":"string","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"streamPath":{"type":"string","required":false,"uniqueItems":false},"audioFileId":{"type":"long","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"audioObject","type":"any","required":false,"uniqueItems":false},"wordList":{"properties":{"updatedAt":{"type":"Date","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"username":{"type":"string","required":false,"uniqueItems":false},"permalink":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"numberWordsInList":{"type":"long","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false}},"id":"wordList","type":"any","required":false,"uniqueItems":false},"SubscriptionType":{"properties":{"items":{"type":"array","required":false,"items":{"$ref":"SubscriptionItem","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"SubscriptionType","type":"any","required":false,"uniqueItems":false},"UserSettings":{"properties":{"bossURL":{"type":"string","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false}},"id":"UserSettings","type":"any","required":false,"uniqueItems":false},"audioType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"audioType","type":"any","required":false,"uniqueItems":false},"SubscriptionItem":{"properties":{"createdAt":{"type":"Date","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"medium":{"type":"string","required":false,"uniqueItems":false}},"id":"SubscriptionItem","type":"any","required":false,"uniqueItems":false},"recentLookup":{"properties":{"createdAt":{"type":"Date","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"recentLookup","type":"any","required":false,"uniqueItems":false},"contentProvider":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"contentProvider","type":"any","required":false,"uniqueItems":false},"UserProfile":{"properties":{"lastName":{"type":"string","required":false,"uniqueItems":false},"mostFavoriteWord":{"type":"string","required":false,"uniqueItems":false},"location":{"type":"string","required":false,"uniqueItems":false},"seekingWord":{"type":"string","required":false,"uniqueItems":false},"leastFavoriteWord":{"type":"string","required":false,"uniqueItems":false},"onomaTopoeiaWord":{"type":"string","required":false,"uniqueItems":false},"siteUrl":{"type":"string","required":false,"uniqueItems":false},"bio":{"type":"string","required":false,"uniqueItems":false},"userHandles":{"type":"array","required":false,"items":{"$ref":"UserHandle","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"youWord":{"type":"string","required":false,"uniqueItems":false},"firstName":{"type":"string","required":false,"uniqueItems":false},"siteName":{"type":"string","required":false,"uniqueItems":false}},"id":"UserProfile","type":"any","required":false,"uniqueItems":false},"comment":{"properties":{"updatedAt":{"type":"Date","required":false,"uniqueItems":false},"id":{"type":"string","required":false,"uniqueItems":false},"body":{"type":"string","required":false,"uniqueItems":false},"commentedOn":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"objectId":{"type":"long","required":false,"uniqueItems":false},"commentedBy":{"type":"string","required":false,"uniqueItems":false},"objectType":{"type":"string","required":false,"uniqueItems":false}},"id":"comment","type":"any","required":false,"uniqueItems":false},"SimpleExample":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"title":{"type":"string","required":false,"uniqueItems":false},"text":{"type":"string","required":false,"uniqueItems":false},"url":{"type":"string","required":false,"uniqueItems":false}},"id":"SimpleExample","type":"any","required":false,"uniqueItems":false},"user":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"email":{"type":"string","required":false,"uniqueItems":false},"status":{"type":"int","required":false,"uniqueItems":false},"faceBookId":{"type":"string","required":false,"uniqueItems":false},"userName":{"type":"string","required":false,"uniqueItems":false},"displayName":{"type":"string","required":false,"uniqueItems":false},"password":{"type":"string","required":false,"uniqueItems":false}},"id":"user","type":"any","required":false,"uniqueItems":false},"partOfSpeech":{"properties":{"roots":{"type":"array","required":false,"items":{"$ref":"root","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"partOfSpeech","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/user.{format}/{username}/wordOfTheDayList","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"includeAll","description":"Include future words (owner-only)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns a user's WordOfTheDayList","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"No WordOfTheDayList available","code":404}],"nickname":"getWordOfTheDayList","responseClass":"wordOfTheDayList"},{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"WordOfTheDayList to create, provided in the format specified by the URL","required":true,"dataType":"wordOfTheDayList","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Creates a WordOfTheDayList","httpMethod":"POST","errorResponses":[{"reason":"User already has a list or list is invalid","code":400},{"reason":"User not found","code":404}],"nickname":"createWordOfTheDayList","responseClass":"wordOfTheDayList","notes":"A user can have only one WordOfTheDayList."},{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Updated WordOfTheDayList data in the format specified by the URL","required":true,"dataType":"wordOfTheDayList","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Updates a user's WordOfTheDayList","httpMethod":"PUT","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"Not authorized to perform update","code":403},{"reason":"No WordOfTheDayList available","code":404}],"nickname":"updateWordOfTheDayList","responseClass":"ok"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalink","description":"Permalink of WordOfTheDayList to delete","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Deletes a user's WordOfTheDayList","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"Not authorized to perform update","code":403},{"reason":"No WordOfTheDayList available","code":404}],"nickname":"updateWordOfTheDayList","responseClass":"ok"},{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalink","description":"Permalink of the WordOfTheDayList to add the WordOfTheDay to","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"WordOfTheDay to add, in the format specified by the URL","required":true,"dataType":"WordOfTheDay","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Adds a WordOfTheDay to a user's WordOfTheDayList","httpMethod":"PUT","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"nickname":"updateItemInWordOfTheDayList","responseClass":"ok"}]},{"path":"/user.{format}/{username}/profile","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch profile for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns a UserProfile","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getUserProfile","responseClass":"UserProfile"},{"parameters":[{"name":"username","description":"Username to fetch profile for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Updated UserProfile.","required":false,"dataType":"UserProfile","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Updates a UserProfile","httpMethod":"PUT","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"updateUserProfile","responseClass":"ok"}]},{"path":"/user.{format}/{username}/trackingInfo","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch tracking info for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns a user's tracking info","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getUserTrackingInfo","responseClass":"UserTrackingInfo"}]},{"path":"/user.{format}/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username to update.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Updated User object.","required":false,"dataType":"user","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Updates a User","httpMethod":"PUT","errorResponses":[{"reason":"Invalid username supplied or username/email already in use.","code":400},{"reason":"User not found","code":404}],"nickname":"updateUser","responseClass":"ok"},{"parameters":[{"name":"username","description":"Username to get.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches a User","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found","code":404}],"nickname":"getUser","responseClass":"user"},{"parameters":[{"name":"username","description":"Username to update.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Deletes a User","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid username supplied or username/email already in use.","code":400},{"reason":"User not found","code":404}],"nickname":"deleteUser","responseClass":"ok"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}/add","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalink","description":"WordOfTheDayList to modify","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"WordOfTheDay to add","required":true,"dataType":"WordOfTheDay","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Adds an item to a user's WordOfTheDayList","httpMethod":"PUT","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"nickname":"addWordToWordOfTheDayList","responseClass":"ok"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}/{wordToDelete}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalink","description":"Permalink of WordOfTheDayList to delete a word from","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"wordToDelete","description":"Word to delete","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Deletes a specific word from a user's WordOfTheDayList","httpMethod":"DELETE","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"nickname":"deleteWordFromWordOfTheDayList","responseClass":"ok"}]},{"path":"/user.{format}/{username}/wordOfTheDay/{date}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDay owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"date","description":"Date of the WordOfTheDay to retrieve (yyyy-MM-dd) format","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"includeAll","description":"Include WordOfTheDay items for future dates (owner-only)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns the WordOfTheDay for a given user on a given date","httpMethod":"GET","errorResponses":[{"reason":"Invalid username or dateString supplied","code":400},{"reason":"User not found or no list available","code":404}],"nickname":"getWordOfTheDayByDate","responseClass":"WordOfTheDay"}]},{"path":"/user.{format}/{username}/wordLists","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch WordLists for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"sortBy","defaultValue":"createDate","description":"Field to sort by","required":false,"dataType":"string","allowableValues":["alpha","createDate","editDate"],"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","defaultValue":"desc","description":"Direction to sort","required":false,"dataType":"string","allowableValues":["asc","desc"],"allowMultiple":false,"paramType":"query"}],"summary":"Gets WordLists for a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found","code":404}],"nickname":"getUserWordLists","responseClass":"List[wordList]"}]},{"path":"/user.{format}/{username}/wordListsCount","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch WordLists for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Gets the count of WordLists for a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found","code":404}],"nickname":"getUserWordListCount","responseClass":"long"}]},{"path":"/user.{format}/{username}/settings","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch settings for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns a user's settings","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getUserSettings","responseClass":"UserSettings"},{"parameters":[{"name":"username","description":"Username to fetch profile for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Updated UserSettings.","required":false,"dataType":"UserSettings","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Updates a user's settings","httpMethod":"PUT","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"updateUserSettings","responseClass":"ok"}]},{"path":"/user.{format}/{username}/apiKey","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch api key for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns the API key for the specified user","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404},{"reason":"API key not found","code":409}],"nickname":"getApiKeyForUser","responseClass":"Principal","notes":"Use the super user API key for getting this information or auth token of the user who is requesting the API key"}]},{"path":"/user.{format}/{username}/comment","description":"","operations":[{"parameters":[{"name":"username","description":"Username to comment on.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Comment to save.","required":false,"dataType":"comment","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Adds a Comment on a User","httpMethod":"POST","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"commentOnUser","responseClass":"comment"},{"parameters":[{"name":"username","description":"Username with Comment.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Updated Comment.","required":false,"dataType":"comment","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Updates a Comment on a User","httpMethod":"PUT","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"updateCommentOnUser","responseClass":"comment"}]},{"path":"/user.{format}/{username}/comment/{commentId}","description":"","operations":[{"parameters":[{"name":"username","description":"Username with Comment.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Updated Comment.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Deletes a Comment on a User","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"deleteCommentOnUser","responseClass":"ok"},{"parameters":[{"name":"username","description":"Username with Comment.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Comment ID.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches a comment by ID","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getCommentOnUserById","responseClass":"comment"}]},{"path":"/user.{format}/{username}/commentsOnCount","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns a count of Comments on a user","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getCommentsOnUserCount","responseClass":"long"}]},{"path":"/user.{format}/{username}/commentsByCount","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count by.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns a count of Comments by a user","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getCommentsByUserCount","responseClass":"long"}]},{"path":"/user.{format}/{username}/commentsBy","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count by.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Sort order","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns Comments by a user","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getCommentsByUser","responseClass":"List[comment]"}]},{"path":"/user.{format}/{username}/commentsOnUser","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count by.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Sort order","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns Comments on a user","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getCommentsOnUser","responseClass":"List[comment]"}]},{"path":"/user.{format}/{username}/ugcSummary","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get statistics for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Sort order","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns UgcSummary info a user","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getUgcSummaryForUser","responseClass":"UgcSummary"}]},{"path":"/user.{format}/{user}/tagHistory","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch History for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches TagHistory for a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserTagHistory","responseClass":"List[userTagHistory]"}]},{"path":"/user.{format}/{user}/tags","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Tags for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches Tags by a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserTags","responseClass":"List[tag]"}]},{"path":"/user.{format}/{user}/tagCount","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Tag count for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches the count of Tags created by a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"nickname":"getUserTagCount","responseClass":"long"}]},{"path":"/user.{format}/{user}/subscriptions","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch subscriptions for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches all subscriptions for a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"Not authorized to fetch subscriptions.","code":403},{"reason":"User not found.","code":404}],"nickname":"getSubscriptions","responseClass":"List[SubscriptionType]"}]},{"path":"/user.{format}/{user}/subscriptions/{objectType}/{objectIdentifier}","description":"","operations":[{"parameters":[{"name":"user","description":"User to add subscriptions to","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"objectType","description":"Object Type","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"objectIdentifier","description":"Object Identifier","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"medium","description":"Subscription medium","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Subscribes to an object.","httpMethod":"POST","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"Not authorized to subscribe user to WordOfTheDayList.","code":403},{"reason":"User not found to filter by.","code":404}],"nickname":"addSubscription","responseClass":"ok"},{"parameters":[{"name":"user","description":"User to add subscriptions to","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"objectType","description":"Object Type","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"objectIdentifier","description":"Object Identifier","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"medium","description":"Subscription medium","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Deletes a subscription to an object.","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"Not authorized to subscribe user to WordOfTheDayList.","code":403},{"reason":"User not found to filter by.","code":404}],"nickname":"removeSubscription","responseClass":"ok"}]},{"path":"/user.{format}/{user}/favorites/words","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite Words for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches Favorite Words for a user.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserFavoriteWords","responseClass":"List[wordObject]"}]},{"path":"/user.{format}/{user}/favorites/wordCount","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite Words for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches favorite word count for a user.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserFavoriteCount","responseClass":"long"}]},{"path":"/user.{format}/{user}/favorites/wordLists","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite WordLists for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"access","description":"Filters results by access","required":false,"dataType":"string","allowableValues":["public","private"],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches Favorite WordLists for a user.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserFavoriteWordLists","responseClass":"List[wordList]"}]},{"path":"/user.{format}/{user}/favorites/wordListCount","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite WordList count for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches Favorite WordList count for a user.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserFavoriteWordListsCount","responseClass":"long"}]},{"path":"/user.{format}/{user}/searches","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch History for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches SearchHistory for a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserSearchHistory","responseClass":"List[recentLookup]"},{"parameters":[{"name":"user","description":"User to remove search history for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"word","description":"Word to delete","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches SearchHistory for a User.","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"nickname":"removeUserSearchHistoryItem","responseClass":"List[recentLookup]"}]},{"path":"/user.{format}/{user}/totalSearches","description":"","operations":[{"parameters":[{"name":"user","description":"User to retrieve search count for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches the total search count for a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"nickname":"getUserSearchHistoryCount","responseClass":"Long"}]},{"path":"/user.{format}/{user}/pronunciations","description":"","operations":[{"parameters":[{"name":"user","description":"User to retrieve search count for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches the total search count for a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"nickname":"getUserPronunciations","responseClass":"List[audioObject]"}]},{"path":"/user.{format}/{user}/activitystream","description":"","operations":[{"parameters":[{"name":"user","description":"User to retrieve search count for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches the total search count for a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"nickname":"getUserActivityStream","responseClass":"Long"}]}],"models1":[{"name":"Principal","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"type","required":false,"allowMultiple":false,"paramType":"int"},{"name":"token","required":false,"allowMultiple":false,"paramType":"string"},{"name":"wordnikUserId","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"tag","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"count","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"userTagHistory","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"tag","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"wordId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"tagId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"tagDate","required":false,"allowMultiple":false,"paramType":"Date"}]},{"name":"long","fields":[{"name":"value","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"wordOfTheDayList","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":true,"allowMultiple":false,"paramType":"string"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"category","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"items","required":false,"allowMultiple":false,"paramType":"List[WordOfTheDay]"},{"name":"subscriberCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"subscriptionStatus","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"commentCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"voteCount","required":false,"allowMultiple":false,"paramType":"integer"},{"name":"voteAverage","required":false,"allowMultiple":false,"paramType":"float"},{"name":"voteWeightedAverage","required":false,"allowMultiple":false,"paramType":"float"},{"name":"itemCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"firstItemDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"lastItemDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"subscriptionSchedule","required":false,"allowMultiple":false,"paramType":"string"},{"name":"subscriptionNamespace","required":false,"allowMultiple":false,"paramType":"string"},{"name":"subscriptionIdentifier","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"SubscriptionType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"items","required":false,"allowMultiple":false,"paramType":"List[SubscriptionItem]"}]},{"name":"contentProvider","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"audioType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"audioType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"SimpleDefinition","fields":[{"name":"text","required":false,"allowMultiple":false,"paramType":"string"},{"name":"partOfSpeech","required":false,"allowMultiple":false,"paramType":"string"},{"name":"note","required":false,"allowMultiple":false,"paramType":"string"},{"name":"source","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"wordObject","fields":[{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"vulgar","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"UserHandle","fields":[{"name":"webService","required":false,"allowMultiple":false,"paramType":"int"},{"name":"handle","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"SubscriptionItem","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"medium","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"}]},{"name":"UserTrackingInfo","fields":[{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"noOfLogins","required":false,"allowMultiple":false,"paramType":"int"},{"name":"signupDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"signupIPAddress","required":false,"allowMultiple":false,"paramType":"string"},{"name":"lastUpdatedDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"lastLoginDate","required":false,"allowMultiple":false,"paramType":"Date"}]},{"name":"comment","fields":[{"name":"objectType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"objectId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"commentedBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"id","required":false,"allowMultiple":false,"paramType":"string"},{"name":"commentedOn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"body","required":false,"allowMultiple":false,"paramType":"string"},{"name":"updatedAt","required":false,"allowMultiple":false,"paramType":"Date"}]},{"name":"partOfSpeech","fields":[{"name":"roots","required":false,"allowMultiple":false,"paramType":"List[root]"}]},{"name":"recentLookup","fields":[{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"}]},{"name":"UserProfile","fields":[{"name":"location","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"firstName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"lastName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"bio","required":false,"allowMultiple":false,"paramType":"string"},{"name":"siteUrl","required":false,"allowMultiple":false,"paramType":"string"},{"name":"leastFavoriteWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"mostFavoriteWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"onomaTopoeiaWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"seekingWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"youWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userHandles","required":false,"allowMultiple":false,"paramType":"List[UserHandle]"},{"name":"siteName","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"wordList","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"type","required":false,"allowMultiple":false,"paramType":"string"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"permalink","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"username","required":false,"allowMultiple":false,"paramType":"string"},{"name":"updatedAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"numberWordsInList","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"WordOfTheDay","fields":[{"name":"id","required":true,"allowMultiple":false,"paramType":"long"},{"name":"category","required":false,"allowMultiple":false,"paramType":"string"},{"name":"example","required":false,"wrapperName":"examples","allowMultiple":false,"paramType":"List[SimpleExample]"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"definition","required":false,"wrapperName":"definitions","allowMultiple":false,"paramType":"List[SimpleDefinition]"},{"name":"contentProvider","required":false,"allowMultiple":false,"paramType":"contentProvider"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"publishDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"parentId","required":false,"allowMultiple":false,"paramType":"string"},{"name":"note","required":false,"allowMultiple":false,"paramType":"string"},{"name":"htmlExtra","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"UserSettings","fields":[{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"bossURL","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"SubscriptionStatus","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"UgcSummary","fields":[{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"ugcEvents","required":false,"allowMultiple":false,"paramType":"Map[string,Date]"},{"name":"ugcCounters","required":false,"allowMultiple":false,"paramType":"Map[string,long]"},{"name":"ugcLabels","required":false,"allowMultiple":false,"paramType":"Map[string,string]"}]},{"name":"audioObject","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"type","required":false,"allowMultiple":false,"paramType":"audioType"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"duration","required":false,"allowMultiple":false,"paramType":"double"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"audioFileType","required":false,"allowMultiple":false,"paramType":"audioType"},{"name":"audioFileId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"filePath","required":false,"allowMultiple":false,"paramType":"string"},{"name":"wordId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"recordId","required":false,"allowMultiple":false,"paramType":"string"},{"name":"streamPath","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"SimpleExample","fields":[{"name":"url","required":false,"allowMultiple":false,"paramType":"string"},{"name":"text","required":false,"allowMultiple":false,"paramType":"string"},{"name":"title","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"user","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"displayName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"status","required":false,"allowMultiple":false,"paramType":"int"},{"name":"password","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"email","required":false,"allowMultiple":false,"paramType":"string"},{"name":"faceBookId","required":false,"allowMultiple":false,"paramType":"string"}]}],"basePath":"url","swaggerVersion":"1.0"}
1
+ {"resourcePath":"/user","models":{"SubscriptionStatus":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"SubscriptionStatus"},"AudioObject":{"properties":{"recordId":{"type":"string"},"wordId":{"type":"long"},"audioFileType":{"type":"audioType"},"filePath":{"type":"string"},"type":{"type":"audioType"},"id":{"type":"long"},"duration":{"type":"double"},"createdBy":{"type":"string"},"description":{"type":"string"},"createdAt":{"type":"Date"},"userId":{"type":"long"},"streamPath":{"type":"string"},"audioFileId":{"type":"long"},"wordstring":{"type":"string"}},"id":"audioObject"},"User":{"properties":{"id":{"type":"long"},"username":{"type":"string"},"email":{"type":"string"},"status":{"type":"int"},"faceBookId":{"type":"string"},"userName":{"type":"string"},"displayName":{"type":"string"},"password":{"type":"string"}},"id":"user"},"AudioType":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"audioType"},"Principal":{"properties":{"id":{"type":"long"},"token":{"type":"string"},"wordnikUserId":{"type":"long"},"type":{"type":"int"}},"id":"Principal"},"UserHandle":{"properties":{"webService":{"type":"int"},"handle":{"type":"string"}},"id":"UserHandle"},"WordOfTheDayList":{"properties":{"subscriptionNamespace":{"type":"string"},"subscriberCount":{"type":"int"},"commentCount":{"type":"int"},"subscriptionIdentifier":{"type":"string"},"firstItemDate":{"type":"Date"},"voteCount":{"type":"integer"},"id":{"type":"string","required":true},"category":{"type":"string"},"createdBy":{"type":"string"},"items":{"type":"array","items":{"$ref":"WordOfTheDay"}},"description":{"type":"string"},"createdAt":{"type":"Date"},"name":{"type":"string"},"voteWeightedAverage":{"type":"float"},"subscriptionSchedule":{"type":"string"},"lastItemDate":{"type":"Date"},"voteAverage":{"type":"float"},"itemCount":{"type":"int"},"subscriptionStatus":{"type":"string"}},"id":"wordOfTheDayList"},"WordOfTheDay":{"properties":{"id":{"type":"long","required":true},"parentId":{"type":"string"},"category":{"type":"string"},"definition":{"type":"array","items":{"$ref":"SimpleDefinition"}},"createdBy":{"type":"string"},"createdAt":{"type":"Date"},"contentProvider":{"type":"contentProvider"},"htmlExtra":{"type":"string"},"word":{"type":"string"},"example":{"type":"array","items":{"$ref":"SimpleExample"}},"note":{"type":"string"},"publishDate":{"type":"Date"}},"id":"WordOfTheDay"},"UserTagHistory":{"properties":{"id":{"type":"long"},"wordId":{"type":"long"},"tagDate":{"type":"Date"},"tag":{"type":"string"},"userId":{"type":"long"},"tagId":{"type":"long"},"wordstring":{"type":"string"}},"id":"userTagHistory"},"WordObject":{"properties":{"word":{"type":"string"},"vulgar":{"type":"string"}},"id":"wordObject"},"RecentLookup":{"properties":{"createdAt":{"type":"Date"},"wordstring":{"type":"string"}},"id":"recentLookup"},"UgcSummary":{"properties":{"ugcEvents":{"type":"Map[string,Date]"},"ugcLabels":{"type":"Map[string,string]"},"userId":{"type":"long"},"ugcCounters":{"type":"Map[string,long]"}},"id":"UgcSummary"},"SimpleDefinition":{"properties":{"text":{"type":"string"},"source":{"type":"string"},"note":{"type":"string"},"partOfSpeech":{"type":"string"}},"id":"SimpleDefinition"},"Tag":{"properties":{"id":{"type":"long"},"count":{"type":"long"},"name":{"type":"string"}},"id":"tag"},"UserTrackingInfo":{"properties":{"signupDate":{"type":"Date"},"lastLoginDate":{"type":"Date"},"noOfLogins":{"type":"int"},"userId":{"type":"long"},"lastUpdatedDate":{"type":"Date"},"signupIPAddress":{"type":"string"}},"id":"UserTrackingInfo"},"Long":{"properties":{"value":{"type":"long"}},"id":"long"},"SubscriptionType":{"properties":{"items":{"type":"array","items":{"$ref":"SubscriptionItem"}},"name":{"type":"string"}},"id":"SubscriptionType"},"WordList":{"properties":{"updatedAt":{"type":"Date"},"id":{"type":"long"},"username":{"type":"string"},"permalink":{"type":"string"},"createdAt":{"type":"Date"},"description":{"type":"string"},"userId":{"type":"long"},"name":{"type":"string"},"numberWordsInList":{"type":"long"},"type":{"type":"string"}},"id":"wordList"},"UserSettings":{"properties":{"notifyComments":{"type":"boolean"},"bossURL":{"type":"string"},"enableActivityFeed":{"type":"boolean"},"userId":{"type":"long"},"publicLookupHistory":{"type":"boolean"},"showImages":{"type":"boolean"},"notifyGeneralNews":{"type":"boolean"},"notifyWordOfTheDay":{"type":"boolean"},"showLookupHistory":{"type":"boolean"}},"id":"UserSettings"},"Comment":{"properties":{"id":{"type":"string"},"updatedAt":{"type":"Date"},"body":{"type":"string"},"approved":{"type":"boolean"},"disemvoweled":{"type":"boolean"},"commentedOn":{"type":"string"},"createdAt":{"type":"Date"},"objectId":{"type":"long"},"commentedBy":{"type":"string"},"objectType":{"type":"string"}},"id":"comment"},"SubscriptionItem":{"properties":{"createdAt":{"type":"Date"},"name":{"type":"string"},"medium":{"type":"string"}},"id":"SubscriptionItem"},"ContentProvider":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"contentProvider"},"UserProfile":{"properties":{"publicProfile":{"type":"boolean"},"lastName":{"type":"string"},"mostFavoriteWord":{"type":"string"},"location":{"type":"string"},"seekingWord":{"type":"string"},"leastFavoriteWord":{"type":"string"},"onomaTopoeiaWord":{"type":"string"},"siteUrl":{"type":"string"},"bio":{"type":"string"},"userHandles":{"type":"array","items":{"$ref":"UserHandle"}},"userId":{"type":"long"},"youWord":{"type":"string"},"firstName":{"type":"string"},"siteName":{"type":"string"}},"id":"UserProfile"},"SimpleExample":{"properties":{"id":{"type":"long"},"title":{"type":"string"},"text":{"type":"string"},"url":{"type":"string"}},"id":"SimpleExample"},"PartOfSpeech":{"properties":{"roots":{"type":"array","items":{"$ref":"root"}}},"id":"partOfSpeech"}},"apis":[{"path":"/user.{format}/{username}/wordOfTheDayList","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"includeAll","description":"Include future words (owner-only)","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns a user's WordOfTheDayList","responseTypeInternal":"com.wordnik.corpus.updated.entity.WordOfTheDayList","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"No WordOfTheDayList available","code":404}],"nickname":"getWordOfTheDayList","responseClass":"wordOfTheDayList","httpMethod":"GET"},{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"WordOfTheDayList to create, provided in the format specified by the URL","required":true,"dataType":"wordOfTheDayList","valueTypeInternal":"com.wordnik.corpus.updated.entity.WordOfTheDayList","allowMultiple":false,"paramType":"body"}],"summary":"Creates a WordOfTheDayList","responseTypeInternal":"com.wordnik.corpus.updated.entity.WordOfTheDayList","errorResponses":[{"reason":"User already has a list or list is invalid","code":400},{"reason":"User not found","code":404}],"nickname":"createWordOfTheDayList","responseClass":"wordOfTheDayList","notes":"A user can have only one WordOfTheDayList.","httpMethod":"POST"},{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Updated WordOfTheDayList data in the format specified by the URL","required":true,"dataType":"wordOfTheDayList","valueTypeInternal":"com.wordnik.corpus.updated.entity.WordOfTheDayList","allowMultiple":false,"paramType":"body"}],"summary":"Updates a user's WordOfTheDayList","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"Not authorized to perform update","code":403},{"reason":"No WordOfTheDayList available","code":404}],"nickname":"updateWordOfTheDayList","responseClass":"ok","httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"permalink","description":"Permalink of WordOfTheDayList to delete","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Deletes a user's WordOfTheDayList","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"Not authorized to perform update","code":403},{"reason":"No WordOfTheDayList available","code":404}],"nickname":"updateWordOfTheDayList","responseClass":"ok","httpMethod":"DELETE"},{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"permalink","description":"Permalink of the WordOfTheDayList to add the WordOfTheDay to","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"WordOfTheDay to add, in the format specified by the URL","required":true,"dataType":"WordOfTheDay","valueTypeInternal":"com.wordnik.community.entity.WordOfTheDay","allowMultiple":false,"paramType":"body"}],"summary":"Adds a WordOfTheDay to a user's WordOfTheDayList","responseTypeInternal":"ok","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"nickname":"updateItemInWordOfTheDayList","responseClass":"ok","httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/profile","description":"","operations":[{"parameters":[{"name":"username","description":"Username or email to fetch UserProfile object","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns a UserProfile","responseTypeInternal":"com.wordnik.system.user.entity.UserProfile","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getUserProfile","responseClass":"UserProfile","httpMethod":"GET"},{"parameters":[{"name":"username","description":"Username or email to update UserProfile object","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Updated UserProfile.","required":false,"dataType":"UserProfile","valueTypeInternal":"com.wordnik.system.user.entity.UserProfile","allowMultiple":false,"paramType":"body"}],"summary":"Updates a UserProfile","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"updateUserProfile","responseClass":"ok","httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/trackingInfo","description":"","operations":[{"parameters":[{"name":"username","description":"Username or email to get UserTrackingInfo","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns a user's tracking info","responseTypeInternal":"com.wordnik.system.user.entity.UserTrackingInfo","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getUserTrackingInfo","responseClass":"UserTrackingInfo","httpMethod":"GET"}]},{"path":"/user.{format}/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username or email to update User object","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Updated User object.","required":false,"dataType":"user","valueTypeInternal":"com.wordnik.system.user.entity.User","allowMultiple":false,"paramType":"body"}],"summary":"Updates a User","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid username supplied or username/email already in use.","code":400},{"reason":"User not found","code":404}],"nickname":"updateUser","responseClass":"ok","httpMethod":"PUT"},{"parameters":[{"name":"username","description":"Username or email to fetch User object for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches a User by username or email address","responseTypeInternal":"com.wordnik.system.user.entity.User","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found","code":404}],"nickname":"getUser","responseClass":"user","httpMethod":"GET"},{"parameters":[{"name":"username","description":"Username or email to delete User object","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Deletes a User","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid username supplied or username/email already in use.","code":400},{"reason":"User not found","code":404}],"nickname":"deleteUser","responseClass":"ok","httpMethod":"DELETE"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}/add","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"permalink","description":"WordOfTheDayList to modify","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"WordOfTheDay to add","required":true,"dataType":"WordOfTheDay","valueTypeInternal":"com.wordnik.community.entity.WordOfTheDay","allowMultiple":false,"paramType":"body"}],"summary":"Adds an item to a user's WordOfTheDayList","responseTypeInternal":"ok","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"nickname":"addWordToWordOfTheDayList","responseClass":"ok","httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}/{wordToDelete}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"permalink","description":"Permalink of WordOfTheDayList to delete a word from","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"wordToDelete","description":"Word to delete","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Deletes a specific word from a user's WordOfTheDayList","responseTypeInternal":"ok","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"nickname":"deleteWordFromWordOfTheDayList","responseClass":"ok","httpMethod":"DELETE"}]},{"path":"/user.{format}/{username}/wordOfTheDay/{date}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDay owner","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"date","description":"Date of the WordOfTheDay to retrieve (yyyy-MM-dd) format","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"includeAll","description":"Include WordOfTheDay items for future dates (owner-only)","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns the WordOfTheDay for a given user on a given date","responseTypeInternal":"com.wordnik.community.entity.WordOfTheDay","errorResponses":[{"reason":"Invalid username or dateString supplied","code":400},{"reason":"User not found or no list available","code":404}],"nickname":"getWordOfTheDayByDate","responseClass":"WordOfTheDay","httpMethod":"GET"}]},{"path":"/user.{format}/{username}/wordLists","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch WordLists for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sortBy","defaultValue":"createDate","description":"Field to sort by","required":false,"dataType":"string","allowableValues":{"values":["alpha","createDate","editDate"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","defaultValue":"desc","description":"Direction to sort","required":false,"dataType":"string","allowableValues":{"values":["asc","desc"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"}],"summary":"Gets WordLists for a User.","responseTypeInternal":"com.wordnik.community.entity.WordList","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found","code":404}],"nickname":"getUserWordLists","responseClass":"List[wordList]","httpMethod":"GET"}]},{"path":"/user.{format}/{username}/wordListsCount","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch WordLists for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Gets the count of WordLists for a User.","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found","code":404}],"nickname":"getUserWordListCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/user.{format}/{username}/settings","description":"","operations":[{"parameters":[{"name":"username","description":"Username or email to fetch UserSettings object","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns a user's settings","responseTypeInternal":"com.wordnik.system.user.entity.UserSettings","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getUserSettings","responseClass":"UserSettings","httpMethod":"GET"},{"parameters":[{"name":"username","description":"Username or email to update UserSettings object","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Updated UserSettings.","required":false,"dataType":"UserSettings","valueTypeInternal":"com.wordnik.system.user.entity.UserSettings","allowMultiple":false,"paramType":"body"}],"summary":"Updates a user's settings","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"updateUserSettings","responseClass":"ok","httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/apiKey","description":"","operations":[{"parameters":[{"name":"username","description":"Username or email to fetch API Key for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns the API key for the specified user","responseTypeInternal":"com.wordnik.security.entity.Principal","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404},{"reason":"API key not found","code":409}],"nickname":"getApiKeyForUser","responseClass":"Principal","notes":"Use the super user API key for getting this information or auth token of the user who is requesting the API key","httpMethod":"GET"}]},{"path":"/user.{format}/{username}/comment","description":"","operations":[{"parameters":[{"name":"username","description":"Username to comment on.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Comment to save.","required":false,"dataType":"comment","valueTypeInternal":"com.wordnik.community.entity.Comment","allowMultiple":false,"paramType":"body"}],"summary":"Adds a Comment on a User","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"commentOnUser","responseClass":"comment","httpMethod":"POST"},{"parameters":[{"name":"username","description":"Username with Comment.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Updated Comment.","required":false,"dataType":"comment","valueTypeInternal":"com.wordnik.community.entity.Comment","allowMultiple":false,"paramType":"body"}],"summary":"Updates a Comment on a User","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"updateCommentOnUser","responseClass":"comment","httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/comment/{commentId}","description":"","operations":[{"parameters":[{"name":"username","description":"Username with Comment.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Updated Comment.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Deletes a Comment on a User","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"deleteCommentOnUser","responseClass":"ok","httpMethod":"DELETE"},{"parameters":[{"name":"username","description":"Username with Comment.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Comment ID.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches a comment by ID","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getCommentOnUserById","responseClass":"comment","httpMethod":"GET"}]},{"path":"/user.{format}/{username}/commentsOnCount","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns a count of Comments on a user","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getCommentsOnUserCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/user.{format}/{username}/commentsByCount","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count by.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns a count of Comments by a user","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getCommentsByUserCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/user.{format}/{username}/commentsBy","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count by.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Sort order","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns Comments by a user","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getCommentsByUser","responseClass":"List[comment]","httpMethod":"GET"}]},{"path":"/user.{format}/{username}/commentsOnUser","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count by.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Sort order","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns Comments on a user","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getCommentsOnUser","responseClass":"List[comment]","httpMethod":"GET"}]},{"path":"/user.{format}/{username}/ugcSummary","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get statistics for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Sort order","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns UgcSummary info a user","responseTypeInternal":"com.wordnik.community.entity.UgcSummaryStats","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getUgcSummaryForUser","responseClass":"UgcSummary","httpMethod":"GET"}]},{"path":"/user.{format}/{user}/tagHistory","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch History for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches TagHistory for a User.","responseTypeInternal":"com.wordnik.community.entity.UserTagHistory","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserTagHistory","responseClass":"List[userTagHistory]","httpMethod":"GET"}]},{"path":"/user.{format}/{user}/tags","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Tags for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches Tags by a User.","responseTypeInternal":"com.wordnik.community.entity.Tag","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserTags","responseClass":"List[tag]","httpMethod":"GET"}]},{"path":"/user.{format}/{user}/tagCount","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Tag count for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches the count of Tags created by a User.","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"nickname":"getUserTagCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/user.{format}/{user}/subscriptions","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch subscriptions for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches all subscriptions for a User.","responseTypeInternal":"com.wordnik.corpus.updated.model.SubscriptionType","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"Not authorized to fetch subscriptions.","code":403},{"reason":"User not found.","code":404}],"nickname":"getSubscriptions","responseClass":"List[SubscriptionType]","httpMethod":"GET"}]},{"path":"/user.{format}/{user}/subscriptions/{objectType}/{objectIdentifier}","description":"","operations":[{"parameters":[{"name":"user","description":"User to add subscriptions to","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"objectType","description":"Object Type","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"objectIdentifier","description":"Object Identifier","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"medium","description":"Subscription medium","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Subscribes to an object.","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"Not authorized to subscribe user to WordOfTheDayList.","code":403},{"reason":"User not found to filter by.","code":404}],"nickname":"addSubscription","responseClass":"ok","httpMethod":"POST"},{"parameters":[{"name":"user","description":"User to add subscriptions to","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"objectType","description":"Object Type","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"objectIdentifier","description":"Object Identifier","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"medium","description":"Subscription medium","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Deletes a subscription to an object.","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"Not authorized to subscribe user to WordOfTheDayList.","code":403},{"reason":"User not found to filter by.","code":404}],"nickname":"removeSubscription","responseClass":"ok","httpMethod":"DELETE"}]},{"path":"/user.{format}/{user}/favorites/words","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite Words for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches Favorite Words for a user.","responseTypeInternal":"com.wordnik.corpus.entity.Word","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserFavoriteWords","responseClass":"List[wordObject]","httpMethod":"GET"}]},{"path":"/user.{format}/{user}/favorites/wordCount","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite Words for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches favorite word count for a user.","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserFavoriteCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/user.{format}/{user}/favorites/wordLists","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite WordLists for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"access","description":"Filters results by access","required":false,"dataType":"string","allowableValues":{"values":["public","private"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"}],"summary":"Fetches Favorite WordLists for a user.","responseTypeInternal":"com.wordnik.community.entity.WordList","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserFavoriteWordLists","responseClass":"List[wordList]","httpMethod":"GET"}]},{"path":"/user.{format}/{user}/favorites/wordListCount","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite WordList count for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches Favorite WordList count for a user.","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserFavoriteWordListsCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/user.{format}/{user}/searches","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch History for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches SearchHistory for a User.","responseTypeInternal":"com.wordnik.community.entity.UserWordLookupHistoryItem","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserSearchHistory","responseClass":"List[recentLookup]","httpMethod":"GET"},{"parameters":[{"name":"user","description":"User to remove search history for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"word","description":"Word to delete","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches SearchHistory for a User.","responseTypeInternal":"com.wordnik.community.entity.UserWordLookupHistoryItem","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"nickname":"removeUserSearchHistoryItem","responseClass":"List[recentLookup]","httpMethod":"DELETE"}]},{"path":"/user.{format}/{user}/totalSearches","description":"","operations":[{"parameters":[{"name":"user","description":"User to retrieve search count for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches the total search count for a User.","responseTypeInternal":"Long","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"nickname":"getUserSearchHistoryCount","responseClass":"Long","httpMethod":"GET"}]},{"path":"/user.{format}/{user}/pronunciations","description":"","operations":[{"parameters":[{"name":"user","description":"User to retrieve search count for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches the total search count for a User.","responseTypeInternal":"com.wordnik.community.entity.AudioPron","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"nickname":"getUserPronunciations","responseClass":"List[audioObject]","httpMethod":"GET"}]},{"path":"/user.{format}/{user}/activitystream","description":"","operations":[{"parameters":[{"name":"user","description":"User to retrieve search count for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches the total search count for a User.","responseTypeInternal":"Long","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"nickname":"getUserActivityStream","responseClass":"Long","httpMethod":"GET"}]}],"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1","apiVersion":"4.0"}
data/api_docs/users.json CHANGED
@@ -1 +1 @@
1
- {"resourcePath":"/users","models":{"wordObject":{"properties":{"word":{"type":"string","required":false,"uniqueItems":false},"vulgar":{"type":"string","required":false,"uniqueItems":false}},"id":"wordObject","type":"any","required":false,"uniqueItems":false},"UserSummary":{"properties":{"totalListedWordsCount":{"type":"long","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"userName":{"type":"string","required":false,"uniqueItems":false}},"id":"UserSummary","type":"any","required":false,"uniqueItems":false},"comment":{"properties":{"updatedAt":{"type":"Date","required":false,"uniqueItems":false},"id":{"type":"string","required":false,"uniqueItems":false},"body":{"type":"string","required":false,"uniqueItems":false},"commentedOn":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"objectId":{"type":"long","required":false,"uniqueItems":false},"commentedBy":{"type":"string","required":false,"uniqueItems":false},"objectType":{"type":"string","required":false,"uniqueItems":false}},"id":"comment","type":"any","required":false,"uniqueItems":false},"user":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"email":{"type":"string","required":false,"uniqueItems":false},"status":{"type":"int","required":false,"uniqueItems":false},"faceBookId":{"type":"string","required":false,"uniqueItems":false},"userName":{"type":"string","required":false,"uniqueItems":false},"displayName":{"type":"string","required":false,"uniqueItems":false},"password":{"type":"string","required":false,"uniqueItems":false}},"id":"user","type":"any","required":false,"uniqueItems":false},"audioObject":{"properties":{"recordId":{"type":"string","required":false,"uniqueItems":false},"wordId":{"type":"long","required":false,"uniqueItems":false},"audioFileType":{"type":"audioType","required":false,"uniqueItems":false},"filePath":{"type":"string","required":false,"uniqueItems":false},"type":{"type":"audioType","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"duration":{"type":"double","required":false,"uniqueItems":false},"createdBy":{"type":"string","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"streamPath":{"type":"string","required":false,"uniqueItems":false},"audioFileId":{"type":"long","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"audioObject","type":"any","required":false,"uniqueItems":false},"audioType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"audioType","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/users.{format}/pronunciations","description":"","operations":[{"parameters":[{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches recent AudioPron objects","httpMethod":"GET","nickname":"getRecentPronunciations","responseClass":"List[audioObject]"}]},{"path":"/users.{format}/id/{id}","description":"","operations":[{"parameters":[{"name":"id","description":"User ID to filter by","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches a User by ID","httpMethod":"GET","errorResponses":[{"reason":"User not found.","code":404}],"nickname":"getUserById","responseClass":"user"}]},{"path":"/users.{format}/facebook/{facebookId}","description":"","operations":[{"parameters":[{"name":"facebookId","description":"Facebook ID to filter by","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches a User by Facebook ID","httpMethod":"GET","errorResponses":[{"reason":"User not found.","code":404}],"nickname":"getByFacebookId","responseClass":"user"}]},{"path":"/users.{format}","description":"","operations":[{"parameters":[{"name":"signupIP","description":"Client IP address","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"password","description":"Password","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"description":"User to create","required":false,"dataType":"user","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Creates a User","httpMethod":"POST","errorResponses":[{"reason":"Invalid User or User parameters supplied.","code":400}],"nickname":"createUser","responseClass":"user"}]},{"path":"/users.{format}/favorites","description":"","operations":[{"parameters":[{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches recent Favorite Word objects.","httpMethod":"GET","nickname":"getRecentFavorites","responseClass":"List[wordObject]"}]},{"path":"/users.{format}/comments","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches recent Comment objects","httpMethod":"GET","nickname":"getRecentComments","responseClass":"List[comment]"}]},{"path":"/users.{format}/listedMostWords","description":"","operations":[{"parameters":[{"name":"dayInterval","description":"Interval in days to compute from","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches info on Users who listed most words","httpMethod":"GET","nickname":"getUsersWhoListedMostWords","responseClass":"List[UserSummary]"}]}],"models1":[{"name":"wordObject","fields":[{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"vulgar","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"audioType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"audioType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"comment","fields":[{"name":"objectType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"objectId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"commentedBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"id","required":false,"allowMultiple":false,"paramType":"string"},{"name":"commentedOn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"body","required":false,"allowMultiple":false,"paramType":"string"},{"name":"updatedAt","required":false,"allowMultiple":false,"paramType":"Date"}]},{"name":"audioObject","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"type","required":false,"allowMultiple":false,"paramType":"audioType"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"duration","required":false,"allowMultiple":false,"paramType":"double"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"audioFileType","required":false,"allowMultiple":false,"paramType":"audioType"},{"name":"audioFileId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"filePath","required":false,"allowMultiple":false,"paramType":"string"},{"name":"wordId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"recordId","required":false,"allowMultiple":false,"paramType":"string"},{"name":"streamPath","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"UserSummary","fields":[{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"userName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"totalListedWordsCount","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"user","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"displayName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"status","required":false,"allowMultiple":false,"paramType":"int"},{"name":"password","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"email","required":false,"allowMultiple":false,"paramType":"string"},{"name":"faceBookId","required":false,"allowMultiple":false,"paramType":"string"}]}],"basePath":"url","swaggerVersion":"1.0"}
1
+ {"resourcePath":"/users","models":{"User":{"properties":{"id":{"type":"long"},"username":{"type":"string"},"email":{"type":"string"},"status":{"type":"int"},"faceBookId":{"type":"string"},"userName":{"type":"string"},"displayName":{"type":"string"},"password":{"type":"string"}},"id":"user"},"AudioObject":{"properties":{"recordId":{"type":"string"},"wordId":{"type":"long"},"audioFileType":{"type":"audioType"},"filePath":{"type":"string"},"type":{"type":"audioType"},"id":{"type":"long"},"duration":{"type":"double"},"createdBy":{"type":"string"},"description":{"type":"string"},"createdAt":{"type":"Date"},"userId":{"type":"long"},"streamPath":{"type":"string"},"audioFileId":{"type":"long"},"wordstring":{"type":"string"}},"id":"audioObject"},"AudioType":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"audioType"},"UserSummary":{"properties":{"totalListedWordsCount":{"type":"long"},"userId":{"type":"long"},"userName":{"type":"string"}},"id":"UserSummary"},"Comment":{"properties":{"id":{"type":"string"},"updatedAt":{"type":"Date"},"body":{"type":"string"},"approved":{"type":"boolean"},"disemvoweled":{"type":"boolean"},"commentedOn":{"type":"string"},"createdAt":{"type":"Date"},"objectId":{"type":"long"},"commentedBy":{"type":"string"},"objectType":{"type":"string"}},"id":"comment"},"WordObject":{"properties":{"word":{"type":"string"},"vulgar":{"type":"string"}},"id":"wordObject"}},"apis":[{"path":"/users.{format}/pronunciations","description":"","operations":[{"parameters":[{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches recent AudioPron objects","responseTypeInternal":"com.wordnik.community.entity.AudioPron","nickname":"getRecentPronunciations","responseClass":"List[audioObject]","httpMethod":"GET"}]},{"path":"/users.{format}/id/{id}","description":"","operations":[{"parameters":[{"name":"id","description":"User ID to filter by","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches a User by ID","responseTypeInternal":"com.wordnik.system.user.entity.User","errorResponses":[{"reason":"User not found.","code":404}],"nickname":"getUserById","responseClass":"user","httpMethod":"GET"}]},{"path":"/users.{format}/facebook/{facebookId}","description":"","operations":[{"parameters":[{"name":"facebookId","description":"Facebook ID to filter by","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches a User by Facebook ID","responseTypeInternal":"com.wordnik.system.user.entity.User","errorResponses":[{"reason":"User not found.","code":404}],"nickname":"getByFacebookId","responseClass":"user","httpMethod":"GET"}]},{"path":"/users.{format}","description":"","operations":[{"parameters":[{"name":"signupIP","description":"Client IP address","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"password","description":"Password","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"description":"User to create","required":false,"dataType":"user","valueTypeInternal":"com.wordnik.system.user.entity.User","allowMultiple":false,"paramType":"body"}],"summary":"Creates a User","responseTypeInternal":"com.wordnik.system.user.entity.User","errorResponses":[{"reason":"Invalid User or User parameters supplied.","code":400}],"nickname":"createUser","responseClass":"user","httpMethod":"POST"}]},{"path":"/users.{format}/favorites","description":"","operations":[{"parameters":[{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches recent Favorite Word objects.","responseTypeInternal":"com.wordnik.corpus.entity.Word","nickname":"getRecentFavorites","responseClass":"List[wordObject]","httpMethod":"GET"}]},{"path":"/users.{format}/comments","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches recent Comment objects","responseTypeInternal":"com.wordnik.community.entity.Comment","nickname":"getRecentComments","responseClass":"List[comment]","httpMethod":"GET"}]},{"path":"/users.{format}/listedMostWords","description":"","operations":[{"parameters":[{"name":"dayInterval","description":"Interval in days to compute from","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches info on Users who listed most words","responseTypeInternal":"com.wordnik.system.user.entity.UserSummary","nickname":"getUsersWhoListedMostWords","responseClass":"List[UserSummary]","httpMethod":"GET"}]}],"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1","apiVersion":"4.0"}
data/api_docs/word.json CHANGED
@@ -1 +1 @@
1
- {"resourcePath":"/word","models":{"sizes":{"properties":{"size":{"type":"array","required":false,"items":{"$ref":"size","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"sizes","type":"any","required":false,"uniqueItems":false},"facet":{"properties":{"facetValue":{"type":"array","required":false,"items":{"$ref":"facetValue","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"facet","type":"any","required":false,"uniqueItems":false},"detailedWordUsage":{"properties":{"sentence":{"type":"sentence","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false},"metadata":{"type":"documentMetadata","required":false,"uniqueItems":false}},"id":"detailedWordUsage","type":"any","required":false,"uniqueItems":false},"root":{"properties":{"name":{"type":"string","required":false,"uniqueItems":false},"categories":{"type":"array","required":false,"items":{"$ref":"category","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"root","type":"any","required":false,"uniqueItems":false},"tag":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"count":{"type":"long","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"tag","type":"any","required":false,"uniqueItems":false},"contentType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"contentType","type":"any","required":false,"uniqueItems":false},"long":{"properties":{"value":{"type":"long","required":false,"uniqueItems":false}},"id":"long","type":"any","required":false,"uniqueItems":false},"type":{"properties":{"enteredAt":{"type":"string","required":false,"uniqueItems":false},"text":{"type":"string","required":false,"uniqueItems":false},"mapping":{"type":"long","required":false,"uniqueItems":false},"typeId":{"type":"int","required":false,"uniqueItems":false}},"id":"type","type":"any","required":false,"uniqueItems":false},"documentMetadata":{"properties":{"yearType":{"type":"yearType","required":false,"uniqueItems":false},"expirationDate":{"type":"Date","required":false,"uniqueItems":false},"extendedMetadata":{"type":"extendedMetadata","required":false,"uniqueItems":false},"stats":{"type":"basicDocumentStats","required":false,"uniqueItems":false},"tag":{"type":"array","required":false,"items":{"type":"string","required":false,"uniqueItems":false},"uniqueItems":false},"provider":{"type":"contentProvider","required":false,"uniqueItems":false},"contentType":{"type":"contentType","required":false,"uniqueItems":false},"sourceUrl":{"type":"string","required":false,"uniqueItems":false},"date":{"type":"Date","required":false,"uniqueItems":false},"medium":{"type":"documentMedium","required":false,"uniqueItems":false},"guid":{"type":"string","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"author":{"type":"array","required":false,"items":{"$ref":"author","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"title":{"type":"string","required":false,"uniqueItems":false},"primaryAuthorType":{"type":"authorType","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"classification":{"type":"subjectClassificationType","required":false,"uniqueItems":false},"year":{"type":"integer","required":false,"uniqueItems":false},"primaryAuthor":{"type":"string","required":false,"uniqueItems":false},"rating":{"type":"double","required":false,"uniqueItems":false},"primaryAuthorId":{"type":"long","required":false,"uniqueItems":false}},"id":"documentMetadata","type":"any","required":false,"uniqueItems":false},"related":{"properties":{"label1":{"type":"string","required":false,"uniqueItems":false},"label2":{"type":"string","required":false,"uniqueItems":false},"relationshipType":{"type":"string","required":false,"uniqueItems":false},"label3":{"type":"string","required":false,"uniqueItems":false},"word":{"type":"array","required":false,"items":{"type":"string","required":false,"uniqueItems":false},"uniqueItems":false},"gram":{"type":"string","required":false,"uniqueItems":false},"label4":{"type":"string","required":false,"uniqueItems":false}},"id":"related","type":"any","required":false,"uniqueItems":false},"exampleSearchResults":{"properties":{"facet":{"type":"array","required":false,"items":{"$ref":"facet","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"example":{"type":"array","required":false,"items":{"$ref":"example","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"exampleSearchResults","type":"any","required":false,"uniqueItems":false},"BooleanValue":{"properties":{"value":{"type":"boolean","required":false,"uniqueItems":false}},"id":"BooleanValue","type":"any","required":false,"uniqueItems":false},"frequencyStats":{"properties":{"author":{"type":"Map[long,long]","required":false,"uniqueItems":false},"subject":{"type":"Map[integer,long]","required":false,"uniqueItems":false},"contentProvider":{"type":"Map[integer,long]","required":false,"uniqueItems":false},"contentType":{"type":"Map[integer,long]","required":false,"uniqueItems":false},"yearWise":{"type":"Map[integer,long]","required":false,"uniqueItems":false},"corpusCount":{"type":"long","required":false,"uniqueItems":false},"medium":{"type":"Map[integer,long]","required":false,"uniqueItems":false}},"id":"frequencyStats","type":"any","required":false,"uniqueItems":false},"wordStats":{"properties":{"dictionaryStats":{"type":"Map[string,dictionaryWordStats]","required":false,"uniqueItems":false},"documentsCount":{"type":"long","required":false,"uniqueItems":false},"sentencesCount":{"type":"long","required":false,"uniqueItems":false},"frequencyStats":{"type":"frequencyStats","required":false,"uniqueItems":false},"partOfSpeechStats":{"type":"Map[string,integer]","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"wordStats","type":"any","required":false,"uniqueItems":false},"RelatedDataSource":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"RelatedDataSource","type":"any","required":false,"uniqueItems":false},"audioObject":{"properties":{"recordId":{"type":"string","required":false,"uniqueItems":false},"wordId":{"type":"long","required":false,"uniqueItems":false},"audioFileType":{"type":"audioType","required":false,"uniqueItems":false},"filePath":{"type":"string","required":false,"uniqueItems":false},"type":{"type":"audioType","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"duration":{"type":"double","required":false,"uniqueItems":false},"createdBy":{"type":"string","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"streamPath":{"type":"string","required":false,"uniqueItems":false},"audioFileId":{"type":"long","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"audioObject","type":"any","required":false,"uniqueItems":false},"citation":{"properties":{"cite":{"type":"string","required":false,"uniqueItems":false},"source":{"type":"string","required":false,"uniqueItems":false}},"id":"citation","type":"any","required":false,"uniqueItems":false},"relatedData":{"properties":{"direction":{"type":"string","required":false,"uniqueItems":false},"targetWordstring":{"type":"string","required":false,"uniqueItems":false},"frequency":{"type":"long","required":false,"uniqueItems":false},"sense":{"type":"integer","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"sourceWordstring":{"type":"string","required":false,"uniqueItems":false},"sourceWordId":{"type":"long","required":false,"uniqueItems":false},"relationshipType":{"type":"RelationshipType","required":false,"uniqueItems":false},"source":{"type":"RelatedDataSource","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"partOfSpeech":{"type":"string","required":false,"uniqueItems":false},"targetWordId":{"type":"long","required":false,"uniqueItems":false}},"id":"relatedData","type":"any","required":false,"uniqueItems":false},"punctuationFactor":{"properties":{"periodCount":{"type":"long","required":false,"uniqueItems":false},"exclamationPointCount":{"type":"long","required":false,"uniqueItems":false},"wordId":{"type":"long","required":false,"uniqueItems":false},"questionMarkCount":{"type":"long","required":false,"uniqueItems":false},"totalCount":{"type":"long","required":false,"uniqueItems":false}},"id":"punctuationFactor","type":"any","required":false,"uniqueItems":false},"subjectClassificationType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"subjectClassificationType","type":"any","required":false,"uniqueItems":false},"basicDocumentStats":{"properties":{"uniqueBiGramsCount":{"type":"long","required":false,"uniqueItems":false},"wordsCount":{"type":"long","required":false,"uniqueItems":false},"documentsCount":{"type":"long","required":false,"uniqueItems":false},"firstUsedWordsCount":{"type":"long","required":false,"uniqueItems":false},"tokensCount":{"type":"long","required":false,"uniqueItems":false},"sentencesCount":{"type":"long","required":false,"uniqueItems":false},"viableSentencesCount":{"type":"long","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false},"uniqueWordsCount":{"type":"long","required":false,"uniqueItems":false},"key":{"type":"string","required":false,"uniqueItems":false}},"id":"basicDocumentStats","type":"any","required":false,"uniqueItems":false},"header":{"properties":{"position":{"type":"integer","required":false,"uniqueItems":false},"sourceDictionary":{"type":"string","required":false,"uniqueItems":false},"homograph":{"type":"string","required":false,"uniqueItems":false},"derivedFrom":{"type":"string","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"etymologyXml":{"type":"string","required":false,"uniqueItems":false},"derivativeSense":{"type":"string","required":false,"uniqueItems":false},"type":{"type":"type","required":false,"uniqueItems":false},"note":{"type":"array","required":false,"items":{"$ref":"note","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"syllable":{"type":"array","required":false,"items":{"$ref":"syllable","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"partOfSpeech":{"type":"string","required":false,"uniqueItems":false},"textPron":{"type":"array","required":false,"items":{"$ref":"textPron","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"header","type":"any","required":false,"uniqueItems":false},"facetValue":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"value":{"type":"string","required":false,"uniqueItems":false}},"id":"facetValue","type":"any","required":false,"uniqueItems":false},"category":{"properties":{"name":{"type":"string","required":false,"uniqueItems":false}},"id":"category","type":"any","required":false,"uniqueItems":false},"RelationshipType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"RelationshipType","type":"any","required":false,"uniqueItems":false},"suggestion":{"properties":{"type":{"type":"int","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"suggestion","type":"any","required":false,"uniqueItems":false},"relationshipMap":{"properties":{"sourceWordstring":{"type":"string","required":false,"uniqueItems":false},"suggestion":{"type":"array","required":false,"items":{"$ref":"suggestion","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"relationshipMap","type":"any","required":false,"uniqueItems":false},"example":{"properties":{"exampleId":{"type":"long","required":false,"uniqueItems":false},"title":{"type":"string","required":false,"uniqueItems":false},"text":{"type":"string","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"provider":{"type":"contentProvider","required":false,"uniqueItems":false},"year":{"type":"integer","required":false,"uniqueItems":false},"rating":{"type":"float","required":false,"uniqueItems":false},"documentId":{"type":"long","required":false,"uniqueItems":false},"url":{"type":"string","required":false,"uniqueItems":false}},"id":"example","type":"any","required":false,"uniqueItems":false},"comment":{"properties":{"updatedAt":{"type":"Date","required":false,"uniqueItems":false},"id":{"type":"string","required":false,"uniqueItems":false},"body":{"type":"string","required":false,"uniqueItems":false},"commentedOn":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"objectId":{"type":"long","required":false,"uniqueItems":false},"commentedBy":{"type":"string","required":false,"uniqueItems":false},"objectType":{"type":"string","required":false,"uniqueItems":false}},"id":"comment","type":"any","required":false,"uniqueItems":false},"frequencySummary":{"properties":{"unknownYearCount":{"type":"int","required":false,"uniqueItems":false},"totalCount":{"type":"long","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"frequency":{"type":"array","required":false,"items":{"$ref":"frequency","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"frequencySummary","type":"any","required":false,"uniqueItems":false},"textPron":{"properties":{"raw":{"type":"string","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"seq":{"type":"int","required":false,"uniqueItems":false},"rawType":{"type":"string","required":false,"uniqueItems":false}},"id":"textPron","type":"any","required":false,"uniqueItems":false},"yearType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"yearType","type":"any","required":false,"uniqueItems":false},"extendedMetadata":{"properties":{"sourceFileSize":{"type":"long","required":false,"uniqueItems":false},"issn":{"type":"string","required":false,"uniqueItems":false},"isbn":{"type":"string","required":false,"uniqueItems":false},"lccn":{"type":"string","required":false,"uniqueItems":false},"documentMetadataId":{"type":"long","required":false,"uniqueItems":false}},"id":"extendedMetadata","type":"any","required":false,"uniqueItems":false},"sentence":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"display":{"type":"string","required":false,"uniqueItems":false},"rating":{"type":"int","required":false,"uniqueItems":false},"documentMetadataId":{"type":"long","required":false,"uniqueItems":false},"scoredWord":{"type":"array","required":false,"items":{"$ref":"scoredWord","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"sentence","type":"any","required":false,"uniqueItems":false},"documentMedium":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"documentMedium","type":"any","required":false,"uniqueItems":false},"frequency":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"year":{"type":"int","required":false,"uniqueItems":false}},"id":"frequency","type":"any","required":false,"uniqueItems":false},"author":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"authorType":{"type":"authorType","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"uniqueName":{"type":"string","required":false,"uniqueItems":false}},"id":"author","type":"any","required":false,"uniqueItems":false},"bigram":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"gram2":{"type":"string","required":false,"uniqueItems":false},"gram1":{"type":"string","required":false,"uniqueItems":false},"wlmi":{"type":"double","required":false,"uniqueItems":false},"mi":{"type":"double","required":false,"uniqueItems":false}},"id":"bigram","type":"any","required":false,"uniqueItems":false},"wordObject":{"properties":{"word":{"type":"string","required":false,"uniqueItems":false},"vulgar":{"type":"string","required":false,"uniqueItems":false}},"id":"wordObject","type":"any","required":false,"uniqueItems":false},"ExampleUsage":{"properties":{"text":{"type":"string","required":false,"uniqueItems":false}},"id":"ExampleUsage","type":"any","required":false,"uniqueItems":false},"ExampleSearchQuery":{"properties":{"limit":{"type":"int","required":false,"uniqueItems":false},"dateRange":{"type":"string","required":false,"uniqueItems":false},"subject":{"type":"string","required":false,"uniqueItems":false},"endDate":{"type":"Date","required":false,"uniqueItems":false},"contentType":{"type":"string","required":false,"uniqueItems":false},"skip":{"type":"int","required":false,"uniqueItems":false},"beginDate":{"type":"Date","required":false,"uniqueItems":false},"medium":{"type":"string","required":false,"uniqueItems":false},"wordType":{"type":"string","required":false,"uniqueItems":false},"contentProvider":{"type":"string","required":false,"uniqueItems":false},"year":{"type":"int","required":false,"uniqueItems":false},"wordString":{"type":"string","required":false,"uniqueItems":false},"filter":{"type":"string","required":false,"uniqueItems":false},"partOfSpeech":{"type":"string","required":false,"uniqueItems":false}},"id":"ExampleSearchQuery","type":"any","required":false,"uniqueItems":false},"note":{"properties":{"noteType":{"type":"string","required":false,"uniqueItems":false},"appliesTo":{"type":"array","required":false,"items":{"type":"string","required":false,"uniqueItems":false},"uniqueItems":false},"value":{"type":"string","required":false,"uniqueItems":false},"pos":{"type":"int","required":false,"uniqueItems":false}},"id":"note","type":"any","required":false,"uniqueItems":false},"wordList":{"properties":{"updatedAt":{"type":"Date","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"username":{"type":"string","required":false,"uniqueItems":false},"permalink":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"numberWordsInList":{"type":"long","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false}},"id":"wordList","type":"any","required":false,"uniqueItems":false},"authorType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"authorType","type":"any","required":false,"uniqueItems":false},"definition":{"properties":{"extendedText":{"type":"string","required":false,"uniqueItems":false},"citation":{"type":"array","required":false,"items":{"$ref":"citation","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"text":{"type":"string","required":false,"uniqueItems":false},"sourceDictionary":{"type":"string","required":false,"uniqueItems":false},"exampleUsage":{"type":"array","required":false,"items":{"$ref":"ExampleUsage","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"relWord":{"type":"array","required":false,"items":{"$ref":"related","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"score":{"type":"float","required":false,"uniqueItems":false},"label":{"type":"array","required":false,"items":{"$ref":"Label","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"seqString":{"type":"string","required":false,"uniqueItems":false},"sequence":{"type":"string","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"note":{"type":"array","required":false,"items":{"$ref":"note","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"textPron":{"type":"array","required":false,"items":{"$ref":"textPron","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"partOfSpeech":{"type":"string","required":false,"uniqueItems":false}},"id":"definition","type":"any","required":false,"uniqueItems":false},"otherForms":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"wordId":{"type":"long","required":false,"uniqueItems":false},"totalCount":{"type":"long","required":false,"uniqueItems":false},"plain":{"type":"string","required":false,"uniqueItems":false},"wordString":{"type":"string","required":false,"uniqueItems":false}},"id":"otherForms","type":"any","required":false,"uniqueItems":false},"DefinitionSearchResults":{"properties":{"result":{"type":"array","required":false,"items":{"$ref":"definition","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"totalResults":{"type":"int","required":false,"uniqueItems":false}},"id":"DefinitionSearchResults","type":"any","required":false,"uniqueItems":false},"photo":{"properties":{"isfamily":{"type":"int","required":false,"uniqueItems":false},"ispublic":{"type":"int","required":false,"uniqueItems":false},"linkUri":{"type":"string","required":false,"uniqueItems":false},"isfriend":{"type":"int","required":false,"uniqueItems":false},"size":{"type":"size","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"farm":{"type":"int","required":false,"uniqueItems":false},"title":{"type":"string","required":false,"uniqueItems":false},"ownerLink":{"type":"string","required":false,"uniqueItems":false},"ownername":{"type":"string","required":false,"uniqueItems":false},"owner":{"type":"string","required":false,"uniqueItems":false},"secret":{"type":"string","required":false,"uniqueItems":false},"server":{"type":"int","required":false,"uniqueItems":false}},"id":"photo","type":"any","required":false,"uniqueItems":false},"scoredWord":{"properties":{"position":{"type":"int","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"wordType":{"type":"string","required":false,"uniqueItems":false},"score":{"type":"float","required":false,"uniqueItems":false},"sentenceId":{"type":"long","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"partOfSpeech":{"type":"string","required":false,"uniqueItems":false}},"id":"scoredWord","type":"any","required":false,"uniqueItems":false},"syllable":{"properties":{"text":{"type":"string","required":false,"uniqueItems":false},"seq":{"type":"int","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false}},"id":"syllable","type":"any","required":false,"uniqueItems":false},"audioType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"audioType","type":"any","required":false,"uniqueItems":false},"contentProvider":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"contentProvider","type":"any","required":false,"uniqueItems":false},"entry":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"sourceDictionary":{"type":"string","required":false,"uniqueItems":false},"relWord":{"type":"array","required":false,"items":{"$ref":"related","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"definition":{"type":"array","required":false,"items":{"$ref":"definition","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"syll":{"type":"array","required":false,"items":{"$ref":"syllable","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"note":{"type":"array","required":false,"items":{"$ref":"note","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"header":{"type":"header","required":false,"uniqueItems":false}},"id":"entry","type":"any","required":false,"uniqueItems":false},"Label":{"properties":{"text":{"type":"string","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false}},"id":"Label","type":"any","required":false,"uniqueItems":false},"ExampleDataStore":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"ExampleDataStore","type":"any","required":false,"uniqueItems":false},"user":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"email":{"type":"string","required":false,"uniqueItems":false},"status":{"type":"int","required":false,"uniqueItems":false},"faceBookId":{"type":"string","required":false,"uniqueItems":false},"userName":{"type":"string","required":false,"uniqueItems":false},"displayName":{"type":"string","required":false,"uniqueItems":false},"password":{"type":"string","required":false,"uniqueItems":false}},"id":"user","type":"any","required":false,"uniqueItems":false},"audioFile":{"properties":{"id":{"type":"long","required":true,"uniqueItems":false},"duration":{"type":"double","required":false,"uniqueItems":false},"createdBy":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"voteWeightedAverage":{"type":"float","required":false,"uniqueItems":false},"voteAverage":{"type":"float","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"commentCount":{"type":"int","required":false,"uniqueItems":false},"voteCount":{"type":"integer","required":false,"uniqueItems":false},"audioType":{"type":"string","required":false,"uniqueItems":false},"fileUrl":{"type":"string","required":false,"uniqueItems":false}},"id":"audioFile","type":"any","required":false,"uniqueItems":false},"partOfSpeech":{"properties":{"roots":{"type":"array","required":false,"items":{"$ref":"root","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"partOfSpeech","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/word.{format}/{word}/entries","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"tags","description":"Return XML tags in response","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"etymologies","description":"Return etymologies","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Return entries for a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getEntries","responseClass":"List[entry]"}]},{"path":"/word.{format}/{word}/examples","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return examples for","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"includeDuplicates","description":"Show duplicate examples from different sources","required":false,"dataType":"string","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"},{"name":"contentProvider","description":"Return results from a specific ContentProvider","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"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","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"},{"name":"internalDataStore","description":"Specify the internal storage engine.","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns examples for a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getExamples","responseClass":"exampleSearchResults"},{"parameters":[{"name":"word","description":"Word to fetch examples for","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Search definition object","required":false,"dataType":"ExampleSearchQuery","allowableValues":[],"allowMultiple":false,"paramType":"body"},{"name":"internalDataStore","description":"Specify the internal storage engine.","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Fetches examples for a word","httpMethod":"POST","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getExamplesPost","responseClass":"exampleSearchResults"}]},{"path":"/word.{format}/{word}/wordForms","description":"","operations":[{"parameters":[{"name":"word","description":"Word to add forms for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"RelationshipMapWord to add","required":false,"dataType":"suggestion","allowableValues":[],"allowMultiple":false,"paramType":"body"},{"name":"canonical","description":"Make this the Canonical form of the word.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Adds a Relationship Map to a word","httpMethod":"POST","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"addWordForm","responseClass":"ok"},{"parameters":[{"name":"word","description":"Word to fetch forms for","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"If true will try to return a correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns other forms of a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"getWordForms","responseClass":"relationshipMap"},{"parameters":[{"name":"word","description":"Word to delete forms from","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"type","description":"Relationship type to delete","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"word","description":"Target word to remove relationship from.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Deletes a relationship from a word","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"deleteWordForm","responseClass":"ok"}]},{"path":"/word.{format}/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"String value of WordObject to return","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"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","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"},{"name":"includeSuggestions","description":"Return suggestions (for correct spelling, case variants, etc.)","required":false,"dataType":"string","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"},{"name":"shouldCreate","description":"Create word if not existing","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Given a word as a string, returns the WordObject that represents it","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getWord","responseClass":"wordObject"}]},{"path":"/word.{format}/{word}/definitions","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return definitions for","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"partOfSpeech","description":"CSV list of part-of-speech types","required":false,"dataType":"string","allowableValues":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"allowMultiple":false,"paramType":"query"},{"name":"includeRelated","description":"Return related words with definitions","required":false,"dataType":"string","allowableValues":["true","false"],"allowMultiple":false,"paramType":"query"},{"name":"sourceDictionaries","description":"Gets from dictionaries in the supplied order of precedence","required":false,"dataType":"string","allowableValues":["ahd"," century"," wiktionary"," webster"," wordnet"],"allowMultiple":false,"paramType":"query"},{"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","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"},{"name":"includeTags","description":"Return a closed set of XML tags in response","required":false,"dataType":"string","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"}],"summary":"Return definitions for a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No definitions found.","code":404}],"nickname":"getDefinitions","responseClass":"List[definition]"}]},{"path":"/word.{format}/{word}/stats","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return stats for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"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","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"detailed","description":"Return detailed usage info","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns word statistics","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No stats available.","code":404}],"nickname":"getWordStats","responseClass":"wordStats"}]},{"path":"/word.{format}/{word}/topExample","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch examples for","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"contentProvider","description":"Return results from a specific ContentProvider","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"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","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"},{"name":"internalDataStore","description":"Specify the internal storage engine.","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns a top example for a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getTopExample","responseClass":"example"}]},{"path":"/word.{format}/{word}/punctuationFactor","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"caseSensitive","description":"Input is case sensitive","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches other forms of a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"getPunctuationFactor","responseClass":"punctuationFactor","notes":"Deprecated"}]},{"path":"/word.{format}/{word}/contextualLookup","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return definitions for","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"sentence","description":"The sentence in which the word occurs","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"offset","defaultValue":"-1","description":"The start character offset of the word in the given sentence","required":false,"dataType":"int","allowableValues":["0 to 4096"],"allowMultiple":false,"paramType":"query"},{"name":"expandTerms","description":"Expand context terms using related words","required":false,"dataType":"string","allowableValues":["true","false"],"allowMultiple":false,"paramType":"query"},{"name":"includeSourceDictionaries","description":"Only include these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":["ahd"," century"," wiktionary"," webster"," wordnet"],"allowMultiple":false,"paramType":"query"},{"name":"excludeSourceDictionaries","description":"Exclude these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":["ahd"," century"," wiktionary"," webster"," wordnet"],"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":["0 to 1000"],"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":["1 to 1000"],"allowMultiple":false,"paramType":"query"}],"summary":"Returns definitions for a word based on the sentence in which it is found","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"contextualLookup","responseClass":"DefinitionSearchResults","notes":"Use the offset parameter when the word occurs more than once in the sentence"},{"parameters":[{"name":"word","description":"Word to return definitions for","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"The sentence in which the word occurs","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"body"},{"name":"offset","defaultValue":"-1","description":"The start character offset of the word in the given sentence","required":false,"dataType":"int","allowableValues":["0 to 4096"],"allowMultiple":false,"paramType":"query"},{"name":"expandTerms","description":"Expand context terms using related words","required":false,"dataType":"string","allowableValues":["true","false"],"allowMultiple":false,"paramType":"query"},{"name":"includeSourceDictionaries","description":"Only include these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":["ahd"," century"," wiktionary"," webster"," wordnet"],"allowMultiple":false,"paramType":"query"},{"name":"excludeSourceDictionaries","description":"Exclude these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":["ahd"," century"," wiktionary"," webster"," wordnet"],"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":["0 to 1000"],"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":["1 to 1000"],"allowMultiple":false,"paramType":"query"}],"summary":"Returns definitions for a word based on the sentence in which it is found","httpMethod":"POST","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"nickname":"contextualLookupPost","responseClass":"DefinitionSearchResults","notes":"Use the offset parameter when the word occurs more than once in the sentence"}]},{"path":"/word.{format}/{word}/commentCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get comment count for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns the number of comments on a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getCommentCount","responseClass":"long"}]},{"path":"/word.{format}/{word}/citations","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get citations for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"If true will try to return a correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns citations for a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getCitations","responseClass":"List[citation]"}]},{"path":"/word.{format}/{word}/related","description":"","operations":[{"parameters":[{"name":"word","description":"Word for which to return related words","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"partOfSpeech","description":"CSV list of part-of-speech types","required":false,"dataType":"string","allowableValues":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get data from a single dictionary","required":false,"dataType":"string","allowableValues":["ahd"," century"," wiktionary"," webster"," wordnet"],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"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","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"},{"name":"type","description":"Relationship type","required":false,"dataType":"string","allowableValues":["synonym","antonym","variant","equivalent","cross-reference","related-word","rhyme","form","etymologically-related-term","hypernym","hyponym","inflected-form","primary","same-context","verb-form","verb-stem","unknown"],"allowMultiple":false,"paramType":"query"}],"summary":"Return related words (thesaurus data) for a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No definitions found.","code":404}],"nickname":"getRelatedWords","responseClass":"List[related]"}]},{"path":"/word.{format}/{word}/listedIn","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch WordLists for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"sortBy","description":"Specifies a sort parameter","required":false,"dataType":"string","allowableValues":["rating"],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"username","description":"User to scope the request to","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns WordLists containing a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied","code":400},{"reason":"Supplied user does not exist","code":404}],"nickname":"getListedIn","responseClass":"List[wordList]"}]},{"path":"/word.{format}/{word}/listedInCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch count for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns a count of lists a word appears in","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getListedInCount","responseClass":"long"}]},{"path":"/word.{format}/{word}/firstListedIn","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch a WordList for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns the first WordList a word appeared in","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getFirstListedIn","responseClass":"wordList"}]},{"path":"/word.{format}/{word}/firstListedBy","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch a User for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns the first User to list a particular word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getFirstListedBy","responseClass":"user"}]},{"path":"/word.{format}/{word}/pronunciations","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get pronunciations for","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"If true will try to return a correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary.","required":false,"dataType":"string","allowableValues":["ahd","century","cmu","macmillan","wiktionary","webster","wordnet"],"allowMultiple":false,"paramType":"query"},{"name":"typeFormat","description":"Text pronunciation type","required":false,"dataType":"string","allowableValues":["ahd","arpabet","gcide-diacritical","IPA"],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns text pronunciations for a given word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getTextPronunciations","responseClass":"List[textPron]"}]},{"path":"/word.{format}/{word}/images/flickr","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get flickr images for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"size","description":"Image size","required":false,"dataType":"string","allowableValues":["thumb","small","med","lg","orig"],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns Flickr images for a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getFlickrImages","responseClass":"List[photo]"}]},{"path":"/word.{format}/{word}/scrabbleScore","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get scrabble score for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns the Scrabble score for a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No scrabble score found.","code":404}],"nickname":"getScrabbleScore","responseClass":"long"}]},{"path":"/word.{format}/{word}/hyphenation","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get syllables for","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"If true will try to return a correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns syllable information for a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getHyphenation","responseClass":"List[syllable]"}]},{"path":"/word.{format}/{word}/unigramCountInternal","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get unigram count for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns syllable information for a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getUnigramCountInternal","responseClass":"long"}]},{"path":"/word.{format}/{word}/phrasesInternal","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get bigrams for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"gamma","description":"Gamma filter","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minWlmi","description":"WLMI Limit","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns Bigrams for the given word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getBigramsInternal","responseClass":"List[bigram]"}]},{"path":"/word.{format}/{word}/lookupCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get Bigrams for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns the number of times a word has been viewed","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getLookupCount","responseClass":"long"}]},{"path":"/word.{format}/{word}/tags","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch Tags on","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"username","description":"Restrict to a particular user","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches tags for a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getTagsOnWord","responseClass":"List[tag]"}]},{"path":"/word.{format}/{word}/tagCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch Tag count on","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"username","description":"Restrict to a particular user","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches tag count for a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getTagCountOnWord","responseClass":"long"}]},{"path":"/word.{format}/{word}/tag","description":"","operations":[{"parameters":[{"name":"word","description":"Word to add a Tag to","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"tags","description":"CSV list of tags to add.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"username","description":"Add tag on behalf of a particular user","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Adds a tag to a word","httpMethod":"POST","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"addTagToWord","responseClass":"ok"},{"parameters":[{"name":"word","description":"Word to add a Tag to","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"tags","description":"CSV list of tags to remove.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"username","description":"Remove tag on behalf of a particular user","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Removes a tag from a word","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"deleteTagFromWord","responseClass":"ok"}]},{"path":"/word.{format}/{word}/frequency","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"caseSensitive","description":"Input is case sensitive","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"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","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"startYear","description":"Starting Year","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"endYear","description":"Ending Year","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"includeErrorBars","description":"Get error bar data","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns word usage over time","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"getWordFrequency","responseClass":"frequencySummary"}]},{"path":"/word.{format}/{word}/firstUsed","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return first usage for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"detailed","description":"Return detailed usage info","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns first usage of a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getFirstUsageOfWord","responseClass":"detailedWordUsage"}]},{"path":"/word.{format}/{word}/wordView","description":"","operations":[{"parameters":[{"name":"word","description":"Word to record a word view for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"userId","description":"ID of the user viewing the word","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"userGuid","description":"Tracking ID for the user","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"userSessionId","description":"Session ID for the user","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"serverIp","description":"Internal IP address of the web server","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"pageName","description":"Page being viewed","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"method","description":"Method of the word view","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"userAgent","description":"Browser user agent","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Records a word view from the website","httpMethod":"POST","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"addWordView","responseClass":"ok"}]},{"path":"/word.{format}/{word}/isFavorite","description":"","operations":[{"parameters":[{"name":"word","description":"Word to check","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"userName","description":"Check for a particular user","required":true,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Checks to see if a word is a user's favorite","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied","code":400},{"reason":"No user found","code":404}],"nickname":"isFavorite","responseClass":"BooleanValue"}]},{"path":"/word.{format}/{word}/favoriteCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to check","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"userName","description":"Check for a particular user","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns the number of times a word has been Favorited","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied","code":400},{"reason":"No user found","code":404}],"nickname":"getFavoriteCount","responseClass":"long"}]},{"path":"/word.{format}/{word}/favorite","description":"","operations":[{"parameters":[{"name":"word","description":"Word to favorite","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"userName","description":"Add as favorite on behalf of a particular user","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Favorites a Word for a user","httpMethod":"POST","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No user found","code":404}],"nickname":"addWordToFavorites","responseClass":"ok"},{"parameters":[{"name":"word","description":"Word to remove","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"userName","description":"Remove on behalf of a particular user","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Removes a Word from a user's Favorites","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid word supplied or no user found.","code":400}],"nickname":"deleteFromFavorites","responseClass":"ok"}]},{"path":"/word.{format}/{word}/phrases","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch phrases for","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"wlmi","description":"Minimum WLMI for the phrase","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"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","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches bi-gram phrases for a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getPhrases","responseClass":"List[bigram]"}]},{"path":"/word.{format}/{word}/etymologies","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"sourceDictionary","description":"Get etymologies from a single dictionary. Options are ahd or century.","required":false,"dataType":"string","allowableValues":["ahd","webster","wiktionary"],"allowMultiple":false,"paramType":"query"},{"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","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"},{"name":"type","description":"Etymology type","required":false,"dataType":"string","allowableValues":["ahd","webster","wiktionary"],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches etymology data","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No definitions found.","code":404}],"nickname":"getEtymologies","responseClass":"String"}]},{"path":"/word.{format}/{word}/otherFormsInternal","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minFrequency","description":"Minimum corpus frequency","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches other forms of a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getOtherFormsInternal","responseClass":"List[otherForms]","notes":"Deprecated"}]},{"path":"/word.{format}/{word}/wordRelationshipInternal","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Relationship to add","required":false,"dataType":"relatedData","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Adds a word relationship","httpMethod":"POST","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"addWordRelationshipInternal","responseClass":"ok","notes":"Deprecated"}]},{"path":"/word.{format}/{word}/comments","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return Comments for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"sortOrder","defaultValue":"descending","description":"Direction to sort by","required":false,"dataType":"string","allowableValues":["ascending","descending"],"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches comments on a Word","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getCommentsOnWord","responseClass":"List[comment]"}]},{"path":"/word.{format}/{word}/comment/{commentId}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch Comment for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"ID of Comment to fetch.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches a Comment by ID","httpMethod":"GET","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"nickname":"getCommentOnWord","responseClass":"comment"},{"parameters":[{"name":"word","description":"Word to update Comment on.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Updated Comment.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Deletes an existing word comment","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"nickname":"deleteCommentByIdOnWord","responseClass":"ok"}]},{"path":"/word.{format}/{word}/comment","description":"","operations":[{"parameters":[{"name":"word","description":"Word to add Comment to.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Comment to add.","required":false,"dataType":"comment","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Adds a comment to a word","httpMethod":"POST","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"nickname":"commentOnWord","responseClass":"comment"},{"parameters":[{"name":"word","description":"Word to update Comment on.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Updated Comment.","required":false,"dataType":"comment","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Updates an existing word comment","httpMethod":"PUT","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"nickname":"updateCommentOnWord","responseClass":"comment"}]},{"path":"/word.{format}/{word}/audio","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get audio for.","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"v3Format","description":"Use the V3 api.","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches audio metadata for a word.","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getAudio","responseClass":"List[audioFile]","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."},{"parameters":[{"name":"word","description":"Word to add audio to.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"AudioPon metadata to add.","required":false,"dataType":"audioObject","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Creates AudioPron metadata","httpMethod":"POST","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"addAudio","responseClass":"ok"}]},{"path":"/word.{format}/{word}/pronunciation/{pronId}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get audio for.","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"pronId","description":"Id to get audio for.","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches single audio pronunciation.","httpMethod":"GET","errorResponses":[{"reason":"Invalid pron id supplied.","code":400}],"nickname":"getPronunciation","responseClass":"audioFile","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."}]},{"path":"/word.{format}/{word}/audioInternal","description":"","operations":[{"parameters":[{"name":"word","description":"audio object to update","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Updated metadata.","required":false,"dataType":"audioObject","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Internal method to update an audio object","httpMethod":"PUT","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"updateAudioInternal","responseClass":"ok"}]},{"path":"/word.{format}/{word}/audio/{audio_id}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to delete audio from.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"audio_id","description":"AudioPon metadata to add.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Deletes an AudioPron","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Unauthorized.","code":401}],"nickname":"deleteAudio","responseClass":"ok"}]}],"models1":[{"name":"BooleanValue","fields":[{"name":"value","required":false,"allowMultiple":false,"paramType":"boolean"}]},{"name":"note","fields":[{"name":"noteType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"pos","required":false,"allowMultiple":false,"paramType":"int"},{"name":"value","required":false,"allowMultiple":false,"paramType":"string"},{"name":"appliesTo","required":false,"allowMultiple":false,"paramType":"List[string]"}]},{"name":"author","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"authorType","required":false,"allowMultiple":false,"paramType":"authorType"},{"name":"uniqueName","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"long","fields":[{"name":"value","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"header","fields":[{"name":"type","required":false,"allowMultiple":false,"paramType":"type"},{"name":"position","required":false,"allowMultiple":false,"paramType":"integer"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"textPron","required":false,"wrapperName":"textProns","allowMultiple":false,"paramType":"List[textPron]"},{"name":"partOfSpeech","required":false,"allowMultiple":false,"paramType":"string"},{"name":"note","required":false,"wrapperName":"notes","allowMultiple":false,"paramType":"List[note]"},{"name":"syllable","required":false,"wrapperName":"syllables","allowMultiple":false,"paramType":"List[syllable]"},{"name":"sourceDictionary","required":false,"allowMultiple":false,"paramType":"string"},{"name":"homograph","required":false,"allowMultiple":false,"paramType":"string"},{"name":"derivativeSense","required":false,"allowMultiple":false,"paramType":"string"},{"name":"derivedFrom","required":false,"allowMultiple":false,"paramType":"string"},{"name":"etymologyXml","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"documentMedium","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"contentProvider","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"frequency","fields":[{"name":"year","required":false,"allowMultiple":false,"paramType":"int"},{"name":"count","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"authorType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"audioType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"frequencySummary","fields":[{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"totalCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"frequency","required":false,"allowMultiple":false,"paramType":"List[frequency]"},{"name":"unknownYearCount","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"detailedWordUsage","fields":[{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sentence","required":false,"allowMultiple":false,"paramType":"sentence"},{"name":"metadata","required":false,"allowMultiple":false,"paramType":"documentMetadata"}]},{"name":"citation","fields":[{"name":"source","required":false,"allowMultiple":false,"paramType":"string"},{"name":"cite","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"audioType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"basicDocumentStats","fields":[{"name":"key","required":false,"allowMultiple":false,"paramType":"string"},{"name":"type","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sentencesCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"uniqueWordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"documentsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"tokensCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"firstUsedWordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"viableSentencesCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"uniqueBiGramsCount","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"otherForms","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordString","required":false,"allowMultiple":false,"paramType":"string"},{"name":"totalCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"plain","required":false,"allowMultiple":false,"paramType":"string"},{"name":"wordId","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"facet","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"facetValue","required":false,"wrapperName":"facetValues","allowMultiple":false,"paramType":"List[facetValue]"}]},{"name":"wordObject","fields":[{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"vulgar","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"relationshipMap","fields":[{"name":"sourceWordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"suggestion","required":false,"wrapperName":"suggestions","allowMultiple":false,"paramType":"List[suggestion]"}]},{"name":"contentType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"comment","fields":[{"name":"objectType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"objectId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"commentedBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"id","required":false,"allowMultiple":false,"paramType":"string"},{"name":"commentedOn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"body","required":false,"allowMultiple":false,"paramType":"string"},{"name":"updatedAt","required":false,"allowMultiple":false,"paramType":"Date"}]},{"name":"exampleSearchResults","fields":[{"name":"facet","required":false,"wrapperName":"facets","allowMultiple":false,"paramType":"List[facet]"},{"name":"example","required":false,"wrapperName":"examples","allowMultiple":false,"paramType":"List[example]"}]},{"name":"partOfSpeech","fields":[{"name":"roots","required":false,"allowMultiple":false,"paramType":"List[root]"}]},{"name":"sizes","fields":[{"name":"size","required":false,"allowMultiple":false,"paramType":"List[size]"}]},{"name":"subjectClassificationType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"Label","fields":[{"name":"type","required":false,"allowMultiple":false,"paramType":"string"},{"name":"text","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"audioFile","fields":[{"name":"id","required":true,"allowMultiple":false,"paramType":"long"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"duration","required":false,"allowMultiple":false,"paramType":"double"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"commentCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"voteCount","required":false,"allowMultiple":false,"paramType":"integer"},{"name":"voteAverage","required":false,"allowMultiple":false,"paramType":"float"},{"name":"voteWeightedAverage","required":false,"allowMultiple":false,"paramType":"float"},{"name":"fileUrl","required":false,"allowMultiple":false,"paramType":"string"},{"name":"audioType","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"DefinitionSearchResults","fields":[{"name":"totalResults","required":false,"allowMultiple":false,"paramType":"int"},{"name":"result","required":false,"wrapperName":"results","allowMultiple":false,"paramType":"List[definition]"}]},{"name":"RelatedDataSource","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"audioObject","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"type","required":false,"allowMultiple":false,"paramType":"audioType"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"duration","required":false,"allowMultiple":false,"paramType":"double"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"audioFileType","required":false,"allowMultiple":false,"paramType":"audioType"},{"name":"audioFileId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"filePath","required":false,"allowMultiple":false,"paramType":"string"},{"name":"wordId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"recordId","required":false,"allowMultiple":false,"paramType":"string"},{"name":"streamPath","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"extendedMetadata","fields":[{"name":"documentMetadataId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"isbn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"issn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"lccn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sourceFileSize","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"tag","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"count","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"example","fields":[{"name":"year","required":false,"allowMultiple":false,"paramType":"integer"},{"name":"provider","required":false,"allowMultiple":false,"paramType":"contentProvider"},{"name":"url","required":false,"allowMultiple":false,"paramType":"string"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"text","required":false,"allowMultiple":false,"paramType":"string"},{"name":"title","required":false,"allowMultiple":false,"paramType":"string"},{"name":"rating","required":false,"allowMultiple":false,"paramType":"float"},{"name":"exampleId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"documentId","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"definition","fields":[{"name":"exampleUsage","required":false,"wrapperName":"exampleUses","allowMultiple":false,"paramType":"List[ExampleUsage]"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"text","required":false,"allowMultiple":false,"paramType":"string"},{"name":"textPron","required":false,"wrapperName":"textProns","allowMultiple":false,"paramType":"List[textPron]"},{"name":"score","required":false,"allowMultiple":false,"paramType":"float"},{"name":"partOfSpeech","required":false,"allowMultiple":false,"paramType":"string"},{"name":"note","required":false,"wrapperName":"notes","allowMultiple":false,"paramType":"List[note]"},{"name":"relWord","required":false,"wrapperName":"relatedWords","allowMultiple":false,"paramType":"List[related]"},{"name":"sourceDictionary","required":false,"allowMultiple":false,"paramType":"string"},{"name":"label","required":false,"wrapperName":"labels","allowMultiple":false,"paramType":"List[Label]"},{"name":"citation","required":false,"wrapperName":"citations","allowMultiple":false,"paramType":"List[citation]"},{"name":"sequence","required":false,"allowMultiple":false,"paramType":"string"},{"name":"seqString","required":false,"allowMultiple":false,"paramType":"string"},{"name":"extendedText","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"photo","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"owner","required":false,"allowMultiple":false,"paramType":"string"},{"name":"server","required":false,"allowMultiple":false,"paramType":"int"},{"name":"title","required":false,"allowMultiple":false,"paramType":"string"},{"name":"ownername","required":false,"allowMultiple":false,"paramType":"string"},{"name":"secret","required":false,"allowMultiple":false,"paramType":"string"},{"name":"farm","required":false,"allowMultiple":false,"paramType":"int"},{"name":"ispublic","required":false,"allowMultiple":false,"paramType":"int"},{"name":"isfriend","required":false,"allowMultiple":false,"paramType":"int"},{"name":"isfamily","required":false,"allowMultiple":false,"paramType":"int"},{"name":"ownerLink","required":false,"allowMultiple":false,"paramType":"string"},{"name":"linkUri","required":false,"allowMultiple":false,"paramType":"string"},{"name":"size","required":false,"allowMultiple":false,"paramType":"size"}]},{"name":"category","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"RelationshipType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"relatedData","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"source","required":false,"allowMultiple":false,"paramType":"RelatedDataSource"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"sourceWordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"targetWordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"relationshipType","required":false,"allowMultiple":false,"paramType":"RelationshipType"},{"name":"frequency","required":false,"allowMultiple":false,"paramType":"long"},{"name":"partOfSpeech","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"targetWordId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"sourceWordId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"sense","required":false,"allowMultiple":false,"paramType":"integer"},{"name":"direction","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"root","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"categories","required":false,"allowMultiple":false,"paramType":"List[category]"}]},{"name":"ExampleUsage","fields":[{"name":"text","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"entry","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"header","required":false,"allowMultiple":false,"paramType":"header"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"note","required":false,"wrapperName":"notes","allowMultiple":false,"paramType":"List[note]"},{"name":"definition","required":false,"wrapperName":"definitions","allowMultiple":false,"paramType":"List[definition]"},{"name":"syll","required":false,"wrapperName":"syllabified","allowMultiple":false,"paramType":"List[syllable]"},{"name":"relWord","required":false,"wrapperName":"relatedWords","allowMultiple":false,"paramType":"List[related]"},{"name":"sourceDictionary","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"scoredWord","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"position","required":false,"allowMultiple":false,"paramType":"int"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"score","required":false,"allowMultiple":false,"paramType":"float"},{"name":"sentenceId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"partOfSpeech","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"facetValue","fields":[{"name":"value","required":false,"allowMultiple":false,"paramType":"string"},{"name":"count","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"sentence","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"scoredWord","required":false,"wrapperName":"scoredWords","allowMultiple":false,"paramType":"List[scoredWord]"},{"name":"display","required":false,"allowMultiple":false,"paramType":"string"},{"name":"documentMetadataId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"rating","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"type","fields":[{"name":"typeId","required":false,"allowMultiple":false,"paramType":"int"},{"name":"text","required":false,"allowMultiple":false,"paramType":"string"},{"name":"enteredAt","required":false,"allowMultiple":false,"paramType":"string"},{"name":"mapping","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"punctuationFactor","fields":[{"name":"totalCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"periodCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"exclamationPointCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"questionMarkCount","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"bigram","fields":[{"name":"count","required":false,"allowMultiple":false,"paramType":"long"},{"name":"gram1","required":false,"allowMultiple":false,"paramType":"string"},{"name":"gram2","required":false,"allowMultiple":false,"paramType":"string"},{"name":"mi","required":false,"allowMultiple":false,"paramType":"double"},{"name":"wlmi","required":false,"allowMultiple":false,"paramType":"double"}]},{"name":"yearType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"related","fields":[{"name":"word","required":false,"wrapperName":"words","allowMultiple":false,"paramType":"List[string]"},{"name":"relationshipType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"label1","required":false,"allowMultiple":false,"paramType":"string"},{"name":"label2","required":false,"allowMultiple":false,"paramType":"string"},{"name":"label3","required":false,"allowMultiple":false,"paramType":"string"},{"name":"label4","required":false,"allowMultiple":false,"paramType":"string"},{"name":"gram","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"documentMetadata","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"year","required":false,"allowMultiple":false,"paramType":"integer"},{"name":"contentType","required":false,"allowMultiple":false,"paramType":"contentType"},{"name":"provider","required":false,"allowMultiple":false,"paramType":"contentProvider"},{"name":"tag","required":false,"wrapperName":"tags","allowMultiple":false,"paramType":"List[string]"},{"name":"title","required":false,"allowMultiple":false,"paramType":"string"},{"name":"rating","required":false,"allowMultiple":false,"paramType":"double"},{"name":"medium","required":false,"allowMultiple":false,"paramType":"documentMedium"},{"name":"sourceUrl","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"classification","required":false,"allowMultiple":false,"paramType":"subjectClassificationType"},{"name":"date","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"yearType","required":false,"allowMultiple":false,"paramType":"yearType"},{"name":"primaryAuthor","required":false,"allowMultiple":false,"paramType":"string"},{"name":"primaryAuthorType","required":false,"allowMultiple":false,"paramType":"authorType"},{"name":"primaryAuthorId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"guid","required":false,"allowMultiple":false,"paramType":"string"},{"name":"extendedMetadata","required":false,"allowMultiple":false,"paramType":"extendedMetadata"},{"name":"author","required":false,"wrapperName":"authors","allowMultiple":false,"paramType":"List[author]"},{"name":"expirationDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"stats","required":false,"allowMultiple":false,"paramType":"basicDocumentStats"}]},{"name":"ExampleSearchQuery","fields":[{"name":"year","required":false,"allowMultiple":false,"paramType":"int"},{"name":"contentType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"filter","required":false,"allowMultiple":false,"paramType":"string"},{"name":"limit","required":false,"allowMultiple":false,"paramType":"int"},{"name":"wordType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"wordString","required":false,"allowMultiple":false,"paramType":"string"},{"name":"contentProvider","required":false,"allowMultiple":false,"paramType":"string"},{"name":"partOfSpeech","required":false,"allowMultiple":false,"paramType":"string"},{"name":"skip","required":false,"allowMultiple":false,"paramType":"int"},{"name":"medium","required":false,"allowMultiple":false,"paramType":"string"},{"name":"subject","required":false,"allowMultiple":false,"paramType":"string"},{"name":"dateRange","required":false,"allowMultiple":false,"paramType":"string"},{"name":"beginDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"endDate","required":false,"allowMultiple":false,"paramType":"Date"}]},{"name":"wordStats","fields":[{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sentencesCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"documentsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"frequencyStats","required":false,"allowMultiple":false,"paramType":"frequencyStats"},{"name":"dictionaryStats","required":false,"allowMultiple":false,"paramType":"Map[string,dictionaryWordStats]"},{"name":"partOfSpeechStats","required":false,"allowMultiple":false,"paramType":"Map[string,integer]"}]},{"name":"syllable","fields":[{"name":"type","required":false,"allowMultiple":false,"paramType":"string"},{"name":"seq","required":false,"allowMultiple":false,"paramType":"int"},{"name":"text","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"textPron","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"seq","required":false,"allowMultiple":false,"paramType":"int"},{"name":"raw","required":false,"allowMultiple":false,"paramType":"string"},{"name":"rawType","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"wordList","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"type","required":false,"allowMultiple":false,"paramType":"string"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"permalink","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"username","required":false,"allowMultiple":false,"paramType":"string"},{"name":"updatedAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"numberWordsInList","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"ExampleDataStore","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"frequencyStats","fields":[{"name":"corpusCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"yearWise","required":false,"allowMultiple":false,"paramType":"Map[integer,long]"},{"name":"contentType","required":false,"allowMultiple":false,"paramType":"Map[integer,long]"},{"name":"contentProvider","required":false,"allowMultiple":false,"paramType":"Map[integer,long]"},{"name":"medium","required":false,"allowMultiple":false,"paramType":"Map[integer,long]"},{"name":"subject","required":false,"allowMultiple":false,"paramType":"Map[integer,long]"},{"name":"author","required":false,"allowMultiple":false,"paramType":"Map[long,long]"}]},{"name":"suggestion","fields":[{"name":"type","required":false,"allowMultiple":false,"paramType":"int"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"user","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"displayName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"status","required":false,"allowMultiple":false,"paramType":"int"},{"name":"password","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"email","required":false,"allowMultiple":false,"paramType":"string"},{"name":"faceBookId","required":false,"allowMultiple":false,"paramType":"string"}]}],"basePath":"url","swaggerVersion":"1.0"}
1
+ {"resourcePath":"/word","models":{"User":{"properties":{"id":{"type":"long"},"username":{"type":"string"},"email":{"type":"string"},"status":{"type":"int"},"faceBookId":{"type":"string"},"userName":{"type":"string"},"displayName":{"type":"string"},"password":{"type":"string"}},"id":"user"},"DocumentMetadata":{"properties":{"yearType":{"type":"yearType"},"expirationDate":{"type":"Date"},"extendedMetadata":{"type":"extendedMetadata"},"tag":{"type":"array","items":{"type":"string"}},"stats":{"type":"basicDocumentStats"},"provider":{"type":"contentProvider"},"contentType":{"type":"contentType"},"sourceUrl":{"type":"string"},"date":{"type":"Date"},"medium":{"type":"documentMedium"},"guid":{"type":"string"},"id":{"type":"long"},"author":{"type":"array","items":{"$ref":"author"}},"title":{"type":"string"},"primaryAuthorType":{"type":"authorType"},"createdAt":{"type":"Date"},"classification":{"type":"subjectClassificationType"},"year":{"type":"integer"},"primaryAuthor":{"type":"string"},"rating":{"type":"double"},"primaryAuthorId":{"type":"long"}},"id":"documentMetadata"},"Facet":{"properties":{"facetValue":{"type":"array","items":{"$ref":"facetValue"}},"name":{"type":"string"}},"id":"facet"},"WordObject":{"properties":{"word":{"type":"string"},"vulgar":{"type":"string"}},"id":"wordObject"},"WordUGCStats":{"properties":{"listedInCount":{"type":"long"},"favoriteCount":{"type":"long"},"lookupCount":{"type":"long"},"commentCount":{"type":"long"},"tagCount":{"type":"long"}},"id":"wordUGCStats"},"ExampleSearchResults":{"properties":{"facet":{"type":"array","items":{"$ref":"facet"}},"example":{"type":"array","items":{"$ref":"example"}}},"id":"exampleSearchResults"},"BooleanValue":{"properties":{"value":{"type":"boolean"}},"id":"BooleanValue"},"Tag":{"properties":{"id":{"type":"long"},"count":{"type":"long"},"name":{"type":"string"}},"id":"tag"},"AudioFile":{"properties":{"attributedWordLink":{"type":"string"},"commentCount":{"type":"int"},"voteCount":{"type":"integer"},"fileUrl":{"type":"string"},"audioType":{"type":"string"},"id":{"type":"long","required":true},"duration":{"type":"double"},"createdBy":{"type":"string"},"description":{"type":"string"},"createdAt":{"type":"Date"},"dictionaryAttribution":{"type":"string"},"voteWeightedAverage":{"type":"float"},"voteAverage":{"type":"float"},"word":{"type":"string"}},"id":"audioFile"},"Bigram":{"properties":{"count":{"type":"long"},"gram2":{"type":"string"},"gram1":{"type":"string"},"wlmi":{"type":"double"},"mi":{"type":"double"}},"id":"bigram"},"Frequency":{"properties":{"count":{"type":"long"},"year":{"type":"int"}},"id":"frequency"},"RelatedDataSource":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"RelatedDataSource"},"TextPron":{"properties":{"raw":{"type":"string"},"id":{"type":"long"},"seq":{"type":"int"},"rawType":{"type":"string"}},"id":"textPron"},"Long":{"properties":{"value":{"type":"long"}},"id":"long"},"Entry":{"properties":{"id":{"type":"long"},"sourceDictionary":{"type":"string"},"relWord":{"type":"array","items":{"$ref":"related"}},"definition":{"type":"array","items":{"$ref":"definition"}},"syll":{"type":"array","items":{"$ref":"syllable"}},"dictionaryAttribution":{"type":"string"},"word":{"type":"string"},"note":{"type":"array","items":{"$ref":"note"}},"header":{"type":"header"}},"id":"entry"},"WordList":{"properties":{"updatedAt":{"type":"Date"},"id":{"type":"long"},"username":{"type":"string"},"permalink":{"type":"string"},"createdAt":{"type":"Date"},"description":{"type":"string"},"userId":{"type":"long"},"name":{"type":"string"},"numberWordsInList":{"type":"long"},"type":{"type":"string"}},"id":"wordList"},"Comment":{"properties":{"id":{"type":"string"},"updatedAt":{"type":"Date"},"body":{"type":"string"},"approved":{"type":"boolean"},"disemvoweled":{"type":"boolean"},"commentedOn":{"type":"string"},"createdAt":{"type":"Date"},"objectId":{"type":"long"},"commentedBy":{"type":"string"},"objectType":{"type":"string"}},"id":"comment"},"DetailedWordUsage":{"properties":{"sentence":{"type":"sentence"},"wordstring":{"type":"string"},"metadata":{"type":"documentMetadata"}},"id":"detailedWordUsage"},"PunctuationFactor":{"properties":{"periodCount":{"type":"long"},"exclamationPointCount":{"type":"long"},"wordId":{"type":"long"},"questionMarkCount":{"type":"long"},"totalCount":{"type":"long"}},"id":"punctuationFactor"},"FacetValue":{"properties":{"count":{"type":"long"},"value":{"type":"string"}},"id":"facetValue"},"Photo":{"properties":{"isfamily":{"type":"int"},"ispublic":{"type":"int"},"linkUri":{"type":"string"},"isfriend":{"type":"int"},"size":{"type":"size"},"id":{"type":"long"},"farm":{"type":"int"},"title":{"type":"string"},"ownerLink":{"type":"string"},"ownername":{"type":"string"},"owner":{"type":"string"},"secret":{"type":"string"},"server":{"type":"int"}},"id":"photo"},"ScoredWord":{"properties":{"position":{"type":"int"},"id":{"type":"long"},"wordType":{"type":"string"},"score":{"type":"float"},"sentenceId":{"type":"long"},"word":{"type":"string"},"partOfSpeech":{"type":"string"}},"id":"scoredWord"},"Sizes":{"properties":{"size":{"type":"array","items":{"$ref":"size"}}},"id":"sizes"},"ContentProvider":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"contentProvider"},"RelationshipType":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"RelationshipType"},"RelatedData":{"properties":{"direction":{"type":"string"},"targetWordstring":{"type":"string"},"frequency":{"type":"long"},"sense":{"type":"integer"},"id":{"type":"long"},"sourceWordstring":{"type":"string"},"sourceWordId":{"type":"long"},"relationshipType":{"type":"RelationshipType"},"source":{"type":"RelatedDataSource"},"createdAt":{"type":"Date"},"userId":{"type":"long"},"partOfSpeech":{"type":"string"},"targetWordId":{"type":"long"}},"id":"relatedData"},"PartOfSpeech":{"properties":{"roots":{"type":"array","items":{"$ref":"root"}}},"id":"partOfSpeech"},"FrequencySummary":{"properties":{"unknownYearCount":{"type":"int"},"totalCount":{"type":"long"},"word":{"type":"string"},"frequency":{"type":"array","items":{"$ref":"frequency"}}},"id":"frequencySummary"},"AudioObject":{"properties":{"recordId":{"type":"string"},"wordId":{"type":"long"},"audioFileType":{"type":"audioType"},"filePath":{"type":"string"},"type":{"type":"audioType"},"id":{"type":"long"},"duration":{"type":"double"},"createdBy":{"type":"string"},"description":{"type":"string"},"createdAt":{"type":"Date"},"userId":{"type":"long"},"streamPath":{"type":"string"},"audioFileId":{"type":"long"},"wordstring":{"type":"string"}},"id":"audioObject"},"Syllable":{"properties":{"text":{"type":"string"},"seq":{"type":"int"},"type":{"type":"string"}},"id":"syllable"},"AudioType":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"audioType"},"Type":{"properties":{"enteredAt":{"type":"string"},"text":{"type":"string"},"mapping":{"type":"long"},"typeId":{"type":"int"}},"id":"type"},"OtherForms":{"properties":{"id":{"type":"long"},"wordId":{"type":"long"},"totalCount":{"type":"long"},"plain":{"type":"string"},"wordString":{"type":"string"}},"id":"otherForms"},"RelationshipMap":{"properties":{"sourceWordstring":{"type":"string"},"suggestion":{"type":"array","items":{"$ref":"suggestion"}}},"id":"relationshipMap"},"Example":{"properties":{"exampleId":{"type":"long"},"title":{"type":"string"},"text":{"type":"string"},"word":{"type":"string"},"provider":{"type":"contentProvider"},"year":{"type":"integer"},"rating":{"type":"float"},"documentId":{"type":"long"},"url":{"type":"string"}},"id":"example"},"Header":{"properties":{"position":{"type":"integer"},"sourceDictionary":{"type":"string"},"homograph":{"type":"string"},"derivedFrom":{"type":"string"},"type":{"type":"type"},"syllable":{"type":"array","items":{"$ref":"syllable"}},"dictionaryAttribution":{"type":"string"},"word":{"type":"string"},"etymologyXml":{"type":"string"},"derivativeSense":{"type":"string"},"note":{"type":"array","items":{"$ref":"note"}},"textPron":{"type":"array","items":{"$ref":"textPron"}},"partOfSpeech":{"type":"string"}},"id":"header"},"ExampleUsage":{"properties":{"text":{"type":"string"}},"id":"ExampleUsage"},"ExampleSearchQuery":{"properties":{"limit":{"type":"int"},"returnFacets":{"type":"boolean"},"dateRange":{"type":"string"},"endDateInclusive":{"type":"boolean"},"subject":{"type":"string"},"endDate":{"type":"Date"},"contentType":{"type":"string"},"beginDate":{"type":"Date"},"skip":{"type":"int"},"medium":{"type":"string"},"beginDateInclusive":{"type":"boolean"},"wordType":{"type":"string"},"contentProvider":{"type":"string"},"year":{"type":"int"},"wordString":{"type":"string"},"filter":{"type":"string"},"partOfSpeech":{"type":"string"}},"id":"ExampleSearchQuery"},"Suggestion":{"properties":{"type":{"type":"int"},"wordstring":{"type":"string"}},"id":"suggestion"},"DefinitionSearchResults":{"properties":{"result":{"type":"array","items":{"$ref":"definition"}},"totalResults":{"type":"int"}},"id":"DefinitionSearchResults"},"Note":{"properties":{"noteType":{"type":"string"},"appliesTo":{"type":"array","items":{"type":"string"}},"value":{"type":"string"},"pos":{"type":"int"}},"id":"note"},"Related":{"properties":{"label1":{"type":"string"},"label2":{"type":"string"},"relationshipType":{"type":"string"},"label3":{"type":"string"},"word":{"type":"array","items":{"type":"string"}},"gram":{"type":"string"},"label4":{"type":"string"}},"id":"related"},"Citation":{"properties":{"cite":{"type":"string"},"source":{"type":"string"}},"id":"citation"},"FrequencyStats":{"properties":{"author":{"type":"Map[long,long]"},"subject":{"type":"Map[integer,long]"},"contentProvider":{"type":"Map[integer,long]"},"contentType":{"type":"Map[integer,long]"},"yearWise":{"type":"Map[integer,long]"},"corpusCount":{"type":"long"},"medium":{"type":"Map[integer,long]"}},"id":"frequencyStats"},"Category":{"properties":{"name":{"type":"string"}},"id":"category"},"WordStats":{"properties":{"dictionaryStats":{"type":"Map[string,dictionaryWordStats]"},"documentsCount":{"type":"long"},"ugcStats":{"type":"wordUGCStats"},"sentencesCount":{"type":"long"},"frequencyStats":{"type":"frequencyStats"},"partOfSpeechStats":{"type":"Map[string,integer]"},"wordstring":{"type":"string"}},"id":"wordStats"},"Root":{"properties":{"name":{"type":"string"},"categories":{"type":"array","items":{"$ref":"category"}}},"id":"root"},"Sentence":{"properties":{"id":{"type":"long"},"display":{"type":"string"},"rating":{"type":"int"},"documentMetadataId":{"type":"long"},"scoredWord":{"type":"array","items":{"$ref":"scoredWord"}}},"id":"sentence"},"Label":{"properties":{"text":{"type":"string"},"type":{"type":"string"}},"id":"Label"},"ExampleDataStore":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"ExampleDataStore"},"Definition":{"properties":{"extendedText":{"type":"string"},"citation":{"type":"array","items":{"$ref":"citation"}},"text":{"type":"string"},"sourceDictionary":{"type":"string"},"exampleUsage":{"type":"array","items":{"$ref":"ExampleUsage"}},"relWord":{"type":"array","items":{"$ref":"related"}},"score":{"type":"float"},"label":{"type":"array","items":{"$ref":"Label"}},"seqString":{"type":"string"},"dictionaryAttribution":{"type":"string"},"sequence":{"type":"string"},"word":{"type":"string"},"note":{"type":"array","items":{"$ref":"note"}},"textPron":{"type":"array","items":{"$ref":"textPron"}},"partOfSpeech":{"type":"string"}},"id":"definition"}},"apis":[{"path":"/word.{format}/{word}/entries","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"tags","description":"Return XML tags in response","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"etymologies","description":"Return etymologies","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Return entries for a word","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.Entry","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getEntries","responseClass":"List[entry]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/examples","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return examples for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"includeDuplicates","description":"Show duplicate examples from different sources","required":false,"dataType":"string","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"contentProvider","description":"Return results from a specific ContentProvider","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"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","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"internalDataStore","description":"Specify the internal storage engine.","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns examples for a word","responseTypeInternal":"com.wordnik.corpus.model.ExampleSearchResults","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getExamples","responseClass":"exampleSearchResults","httpMethod":"GET"},{"parameters":[{"name":"word","description":"Word to fetch examples for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Search definition object","required":false,"dataType":"ExampleSearchQuery","valueTypeInternal":"com.wordnik.index.example.ExampleSearchQuery","allowMultiple":false,"paramType":"body"},{"name":"internalDataStore","description":"Specify the internal storage engine.","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Fetches examples for a word","responseTypeInternal":"com.wordnik.corpus.model.ExampleSearchResults","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getExamplesPost","responseClass":"exampleSearchResults","httpMethod":"POST"}]},{"path":"/word.{format}/{word}/wordForms","description":"","operations":[{"parameters":[{"name":"word","description":"Word to add forms for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"RelationshipMapWord to add","required":false,"dataType":"suggestion","valueTypeInternal":"com.wordnik.corpus.entity.RelationshipMapWord","allowMultiple":false,"paramType":"body"},{"name":"canonical","description":"Make this the Canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Adds a Relationship Map to a word","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"addWordForm","responseClass":"ok","httpMethod":"POST"},{"parameters":[{"name":"word","description":"Word to fetch forms for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"If true will try to return a correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns other forms of a word","responseTypeInternal":"com.wordnik.corpus.entity.RelationshipMap","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"getWordForms","responseClass":"relationshipMap","httpMethod":"GET"},{"parameters":[{"name":"word","description":"Word to delete forms from","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"type","description":"Relationship type to delete","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"word","description":"Target word to remove relationship from.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Deletes a relationship from a word","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"deleteWordForm","responseClass":"ok","httpMethod":"DELETE"}]},{"path":"/word.{format}/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"String value of WordObject to return","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"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","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"includeSuggestions","description":"Return suggestions (for correct spelling, case variants, etc.)","required":false,"dataType":"string","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"shouldCreate","description":"Create word if not existing","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Given a word as a string, returns the WordObject that represents it","responseTypeInternal":"com.wordnik.corpus.entity.Word","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getWord","responseClass":"wordObject","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/definitions","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return definitions for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"partOfSpeech","description":"CSV list of part-of-speech types","required":false,"dataType":"string","allowableValues":{"values":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"includeRelated","description":"Return related words with definitions","required":false,"dataType":"string","allowableValues":{"values":["true","false"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"sourceDictionaries","description":"If 'all' is received, results are returned from all sources. If multiple values are received (e.g. 'century,wiktionary'), results are returned from the first specified dictionary that has definitions. If left blank, results are returned from the first dictionary that has definitions. By default, dictionaries are searched in this order: ahd, wiktionary, webster, century, wordnet","required":false,"dataType":"string","allowableValues":{"values":["all","ahd","century","wiktionary","webster","wordnet"],"valueType":"LIST"},"allowMultiple":true,"paramType":"query"},{"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","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"includeTags","description":"Return a closed set of XML tags in response","required":false,"dataType":"string","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"}],"summary":"Return definitions for a word","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.Definition","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No definitions found.","code":404}],"nickname":"getDefinitions","responseClass":"List[definition]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/stats","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return stats for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"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","allowMultiple":false,"paramType":"query"},{"name":"detailed","description":"Return detailed usage info","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"statsToInclude","description":"stats to include in the results","required":false,"dataType":"string","allowableValues":{"values":["ugc","frequency","dictionary","part_of_speech"],"valueType":"LIST"},"allowMultiple":true,"paramType":"query"}],"summary":"Returns word statistics","responseTypeInternal":"com.wordnik.corpus.stats.entity.WordStats","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No stats available.","code":404}],"nickname":"getWordStats","responseClass":"wordStats","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/topExample","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch examples for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"contentProvider","description":"Return results from a specific ContentProvider","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"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","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"internalDataStore","description":"Specify the internal storage engine.","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns a top example for a word","responseTypeInternal":"com.wordnik.corpus.model.Example","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getTopExample","responseClass":"example","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/punctuationFactor","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"caseSensitive","description":"Input is case sensitive","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches other forms of a word","responseTypeInternal":"com.wordnik.corpus.entity.BangFactor","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"getPunctuationFactor","responseClass":"punctuationFactor","deprecated":true,"notes":"Deprecated","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/contextualLookup","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return definitions for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"sentence","description":"The sentence in which the word occurs","required":true,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"offset","defaultValue":"-1","description":"The start character offset of the word in the given sentence","required":false,"dataType":"int","allowableValues":{"max":4096.0,"min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"expandTerms","description":"Expand context terms using related words","required":false,"dataType":"string","allowableValues":{"values":["true","false"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"includeSourceDictionaries","description":"Only include these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":{"values":["ahd"," century"," wiktionary"," webster"," wordnet"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"excludeSourceDictionaries","description":"Exclude these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":{"values":["ahd"," century"," wiktionary"," webster"," wordnet"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":{"max":1000.0,"min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":{"max":1000.0,"min":1.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"}],"summary":"Returns definitions for a word based on the sentence in which it is found","responseTypeInternal":"com.wordnik.index.definition.DefinitionSearchResults","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"contextualLookup","responseClass":"DefinitionSearchResults","notes":"Use the offset parameter when the word occurs more than once in the sentence","httpMethod":"GET"},{"parameters":[{"name":"word","description":"Word to return definitions for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"The sentence in which the word occurs","required":true,"dataType":"string","allowMultiple":false,"paramType":"body"},{"name":"offset","defaultValue":"-1","description":"The start character offset of the word in the given sentence","required":false,"dataType":"int","allowableValues":{"max":4096.0,"min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"expandTerms","description":"Expand context terms using related words","required":false,"dataType":"string","allowableValues":{"values":["true","false"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"includeSourceDictionaries","description":"Only include these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":{"values":["ahd"," century"," wiktionary"," webster"," wordnet"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"excludeSourceDictionaries","description":"Exclude these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":{"values":["ahd"," century"," wiktionary"," webster"," wordnet"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":{"max":1000.0,"min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":{"max":1000.0,"min":1.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"}],"summary":"Returns definitions for a word based on the sentence in which it is found","responseTypeInternal":"com.wordnik.index.definition.DefinitionSearchResults","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"nickname":"contextualLookupPost","responseClass":"DefinitionSearchResults","notes":"Use the offset parameter when the word occurs more than once in the sentence","httpMethod":"POST"}]},{"path":"/word.{format}/{word}/commentCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get comment count for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns the number of comments on a word","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getCommentCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/relatedWords","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch relationships for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"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","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"relationshipTypes","description":"Limits the total results per type of relationship type","required":false,"dataType":"string","allowableValues":{"values":["synonym","antonym","variant","equivalent","cross-reference","related-word","rhyme","form","etymologically-related-term","hypernym","hyponym","inflected-form","primary","same-context","verb-form","verb-stem"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"limitPerRelationshipType","description":"Restrict to the supplied relatinship types","required":false,"dataType":"string","allowableValues":{"max":"Infinity","min":1.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"}],"summary":"Given a word as a string, returns relationships from the Word Graph","responseTypeInternal":"com.wordnik.corpus.entity.Word","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getRelatedWords","responseClass":"wordObject","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/related","description":"","operations":[{"parameters":[{"name":"word","description":"Word for which to return related words","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"partOfSpeech","description":"CSV list of part-of-speech types","required":false,"dataType":"string","allowableValues":{"values":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get data from a single dictionary","required":false,"dataType":"string","allowableValues":{"values":["ahd"," century"," wiktionary"," webster"," wordnet"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"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","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"type","description":"Relationship type","required":false,"dataType":"string","allowableValues":{"values":["synonym","antonym","variant","equivalent","cross-reference","related-word","rhyme","form","etymologically-related-term","hypernym","hyponym","inflected-form","primary","same-context","verb-form","verb-stem","unknown"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"}],"summary":"Return related words (thesaurus data) for a word","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.Related","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No definitions found.","code":404}],"nickname":"getRelatedWords","responseClass":"List[related]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/listedIn","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch WordLists for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"sortBy","description":"Specifies a sort parameter","required":false,"dataType":"string","allowableValues":{"values":["rating"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"username","description":"User to scope the request to","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns WordLists containing a word","responseTypeInternal":"com.wordnik.community.entity.WordList","errorResponses":[{"reason":"Invalid word supplied","code":400},{"reason":"Supplied user does not exist","code":404}],"nickname":"getListedIn","responseClass":"List[wordList]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/listedInCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch count for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns a count of lists a word appears in","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getListedInCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/firstListedIn","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch a WordList for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns the first WordList a word appeared in","responseTypeInternal":"com.wordnik.community.entity.WordList","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getFirstListedIn","responseClass":"wordList","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/firstListedBy","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch a User for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns the first User to list a particular word","responseTypeInternal":"com.wordnik.system.user.entity.User","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getFirstListedBy","responseClass":"user","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/pronunciations","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get pronunciations for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"If true will try to return a correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary.","required":false,"dataType":"string","allowableValues":{"values":["ahd","century","cmu","macmillan","wiktionary","webster","wordnet"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"typeFormat","description":"Text pronunciation type","required":false,"dataType":"string","allowableValues":{"values":["ahd","arpabet","gcide-diacritical","IPA"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns text pronunciations for a given word","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.TextPron","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getTextPronunciations","responseClass":"List[textPron]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/images/flickr","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get flickr images for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"size","description":"Image size","required":false,"dataType":"string","allowableValues":{"values":["thumb","small","med","lg","orig"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns Flickr images for a word","responseTypeInternal":"com.wordnik.corpus.model.FlickrImage","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getFlickrImages","responseClass":"List[photo]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/scrabbleScore","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get scrabble score for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns the Scrabble score for a word","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No scrabble score found.","code":404}],"nickname":"getScrabbleScore","responseClass":"long","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/citations","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get citations for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"If true will try to return a correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns citations for a word","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.Citation","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getCitations","responseClass":"List[citation]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/hyphenation","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get syllables for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"If true will try to return a correct word root ('cats' -> 'cat'). If false returns exactly what was requested.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sourceDictionary","description":"Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns syllable information for a word","responseTypeInternal":"com.wordnik.corpus.dictionary.entity.Syllable","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getHyphenation","responseClass":"List[syllable]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/unigramCountInternal","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get unigram count for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns syllable information for a word","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getUnigramCountInternal","responseClass":"long","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/phrasesInternal","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get bigrams for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"gamma","description":"Gamma filter","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minWlmi","description":"WLMI Limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns Bigrams for the given word","responseTypeInternal":"com.wordnik.corpus.ngram.entity.Bigram","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getBigramsInternal","responseClass":"List[bigram]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/lookupCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get Bigrams for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns the number of times a word has been viewed","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Word not found.","code":404}],"nickname":"getLookupCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/tags","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch Tags on","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"username","description":"Restrict to a particular user","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches tags for a word","responseTypeInternal":"com.wordnik.community.entity.Tag","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getTagsOnWord","responseClass":"List[tag]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/tagCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch Tag count on","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"username","description":"Restrict to a particular user","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches tag count for a word","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getTagCountOnWord","responseClass":"long","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/tag","description":"","operations":[{"parameters":[{"name":"word","description":"Word to add a Tag to","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"tags","description":"CSV list of tags to add.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"username","description":"Add tag on behalf of a particular user","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Adds a tag to a word","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"addTagToWord","responseClass":"ok","httpMethod":"POST"},{"parameters":[{"name":"word","description":"Word to add a Tag to","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"tags","description":"CSV list of tags to remove.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"username","description":"Remove tag on behalf of a particular user","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Removes a tag from a word","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"deleteTagFromWord","responseClass":"ok","httpMethod":"DELETE"}]},{"path":"/word.{format}/{word}/frequency","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"caseSensitive","description":"Input is case sensitive","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"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","allowMultiple":false,"paramType":"query"},{"name":"startYear","description":"Starting Year","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"endYear","description":"Ending Year","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"includeErrorBars","description":"Get error bar data","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns word usage over time","responseTypeInternal":"com.wordnik.corpus.entity.FrequencySummary","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"getWordFrequency","responseClass":"frequencySummary","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/firstUsed","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return first usage for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"detailed","description":"Return detailed usage info","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns first usage of a word","responseTypeInternal":"com.wordnik.corpus.stats.entity.DetailedWordUsage","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getFirstUsageOfWord","responseClass":"detailedWordUsage","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/wordView","description":"","operations":[{"parameters":[{"name":"word","description":"Word to record a word view for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"userId","description":"ID of the user viewing the word","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userGuid","description":"Tracking ID for the user","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userSessionId","description":"Session ID for the user","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"serverIp","description":"Internal IP address of the web server","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"pageName","description":"Page being viewed","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"method","description":"Method of the word view","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userAgent","description":"Browser user agent","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Records a word view from the website","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"addWordView","responseClass":"ok","httpMethod":"POST"}]},{"path":"/word.{format}/{word}/isFavorite","description":"","operations":[{"parameters":[{"name":"word","description":"Word to check","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userName","description":"Check for a particular user","required":true,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Checks to see if a word is a user's favorite","responseTypeInternal":"com.wordnik.system.model.BooleanValue","errorResponses":[{"reason":"Invalid word supplied","code":400},{"reason":"No user found","code":404}],"nickname":"isFavorite","responseClass":"BooleanValue","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/favoriteCount","description":"","operations":[{"parameters":[{"name":"word","description":"Word to check","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"userName","description":"Check for a particular user","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns the number of times a word has been Favorited","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid word supplied","code":400},{"reason":"No user found","code":404}],"nickname":"getFavoriteCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/favorite","description":"","operations":[{"parameters":[{"name":"word","description":"Word to favorite","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"userName","description":"Add as favorite on behalf of a particular user","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Favorites a Word for a user","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No user found","code":404}],"nickname":"addWordToFavorites","responseClass":"ok","httpMethod":"POST"},{"parameters":[{"name":"word","description":"Word to remove","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"userName","description":"Remove on behalf of a particular user","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Removes a Word from a user's Favorites","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied or no user found.","code":400}],"nickname":"deleteFromFavorites","responseClass":"ok","httpMethod":"DELETE"}]},{"path":"/word.{format}/{word}/phrases","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch phrases for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"wlmi","description":"Minimum WLMI for the phrase","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"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","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"}],"summary":"Fetches bi-gram phrases for a word","responseTypeInternal":"com.wordnik.corpus.ngram.entity.Bigram","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getPhrases","responseClass":"List[bigram]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/etymologies","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"sourceDictionary","description":"Get etymologies from a single dictionary. Options are ahd or century.","required":false,"dataType":"string","allowableValues":{"values":["ahd","webster","wiktionary"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"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","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"type","description":"Etymology type","required":false,"dataType":"string","allowableValues":{"values":["ahd","webster","wiktionary"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"}],"summary":"Fetches etymology data","responseTypeInternal":"String","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No definitions found.","code":404}],"nickname":"getEtymologies","responseClass":"String","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/otherFormsInternal","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minFrequency","description":"Minimum corpus frequency","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches other forms of a word","responseTypeInternal":"com.wordnik.corpus.site.entity.OtherFormsData","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getOtherFormsInternal","responseClass":"List[otherForms]","deprecated":true,"notes":"Deprecated","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/wordRelationshipInternal","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Relationship to add","required":false,"dataType":"relatedData","valueTypeInternal":"com.wordnik.corpus.site.entity.SiteRelatedData","allowMultiple":false,"paramType":"body"}],"summary":"Adds a word relationship","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"addWordRelationshipInternal","responseClass":"ok","deprecated":true,"notes":"Deprecated","httpMethod":"POST"}]},{"path":"/word.{format}/{word}/comments","description":"","operations":[{"parameters":[{"name":"word","description":"Word to return Comments for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"sortOrder","defaultValue":"descending","description":"Direction to sort by","required":false,"dataType":"string","allowableValues":{"values":["ascending","descending"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches comments on a Word","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getCommentsOnWord","responseClass":"List[comment]","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/comment/{commentId}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to fetch Comment for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"ID of Comment to fetch.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches a Comment by ID","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"nickname":"getCommentOnWord","responseClass":"comment","httpMethod":"GET"},{"parameters":[{"name":"word","description":"Word to update Comment on.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Updated Comment.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Deletes an existing word comment","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"nickname":"deleteCommentByIdOnWord","responseClass":"ok","httpMethod":"DELETE"}]},{"path":"/word.{format}/{word}/comment","description":"","operations":[{"parameters":[{"name":"word","description":"Word to add Comment to.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Comment to add.","required":false,"dataType":"comment","valueTypeInternal":"com.wordnik.community.entity.Comment","allowMultiple":false,"paramType":"body"}],"summary":"Adds a comment to a word","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"nickname":"commentOnWord","responseClass":"comment","httpMethod":"POST"},{"parameters":[{"name":"word","description":"Word to update Comment on.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Updated Comment.","required":false,"dataType":"comment","valueTypeInternal":"com.wordnik.community.entity.Comment","allowMultiple":false,"paramType":"body"}],"summary":"Updates an existing word comment","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid word or Comment supplied.","code":400},{"reason":"Word or commentor not found.","code":404}],"nickname":"updateCommentOnWord","responseClass":"comment","httpMethod":"PUT"}]},{"path":"/word.{format}/{word}/audio","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get audio for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"useCanonical","description":"Use the canonical form of the word.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"v3Format","description":"Use the V3 api.","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches audio metadata for a word.","responseTypeInternal":"com.wordnik.community.entity.AudioFileMetadata","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getAudio","responseClass":"List[audioFile]","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.","httpMethod":"GET"},{"parameters":[{"name":"word","description":"Word to add audio to.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"AudioPon metadata to add.","required":false,"dataType":"audioObject","valueTypeInternal":"com.wordnik.community.entity.AudioPron","allowMultiple":false,"paramType":"body"}],"summary":"Creates AudioPron metadata","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"addAudio","responseClass":"ok","httpMethod":"POST"}]},{"path":"/word.{format}/{word}/pronunciation/{pronId}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to get audio for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"pronId","description":"Id to get audio for.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches single audio pronunciation.","responseTypeInternal":"com.wordnik.community.entity.AudioFileMetadata","errorResponses":[{"reason":"Invalid pron id supplied.","code":400}],"nickname":"getPronunciation","responseClass":"audioFile","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.","httpMethod":"GET"}]},{"path":"/word.{format}/{word}/audioInternal","description":"","operations":[{"parameters":[{"name":"word","description":"audio object to update","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Updated metadata.","required":false,"dataType":"audioObject","valueTypeInternal":"com.wordnik.community.entity.AudioPron","allowMultiple":false,"paramType":"body"}],"summary":"Internal method to update an audio object","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"updateAudioInternal","responseClass":"ok","httpMethod":"PUT"}]},{"path":"/word.{format}/{word}/audio/{audio_id}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to delete audio from.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"audio_id","description":"AudioPon metadata to add.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Deletes an AudioPron","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid word supplied.","code":400},{"reason":"Unauthorized.","code":401}],"nickname":"deleteAudio","responseClass":"ok","httpMethod":"DELETE"}]}],"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1","apiVersion":"4.0"}
data/api_docs/wordList.json CHANGED
@@ -1 +1 @@
1
- {"resourcePath":"/wordList","models":{"BooleanValue":{"properties":{"value":{"type":"boolean","required":false,"uniqueItems":false}},"id":"BooleanValue","type":"any","required":false,"uniqueItems":false},"tag":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"count":{"type":"long","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"tag","type":"any","required":false,"uniqueItems":false},"comment":{"properties":{"updatedAt":{"type":"Date","required":false,"uniqueItems":false},"id":{"type":"string","required":false,"uniqueItems":false},"body":{"type":"string","required":false,"uniqueItems":false},"commentedOn":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"objectId":{"type":"long","required":false,"uniqueItems":false},"commentedBy":{"type":"string","required":false,"uniqueItems":false},"objectType":{"type":"string","required":false,"uniqueItems":false}},"id":"comment","type":"any","required":false,"uniqueItems":false},"long":{"properties":{"value":{"type":"long","required":false,"uniqueItems":false}},"id":"long","type":"any","required":false,"uniqueItems":false},"wordListWord":{"properties":{"username":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"numberCommentsOnWord":{"type":"long","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"numberLists":{"type":"long","required":false,"uniqueItems":false}},"id":"wordListWord","type":"any","required":false,"uniqueItems":false},"wordList":{"properties":{"updatedAt":{"type":"Date","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"username":{"type":"string","required":false,"uniqueItems":false},"permalink":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"numberWordsInList":{"type":"long","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false}},"id":"wordList","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/wordList.{format}/{wordListId}","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to update","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Updated WordList","required":false,"dataType":"wordList","allowableValues":[],"allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Updates an existing WordList","httpMethod":"PUT","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to update WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"updateWordList","responseClass":"ok"},{"parameters":[{"name":"wordListId","description":"ID of WordList to delete","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Deletes an existing WordList","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to delete WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"deleteWordList","responseClass":"ok"},{"parameters":[{"name":"wordListId","description":"ID of WordList to fetch","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Fetches a WordList by ID","httpMethod":"GET","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"getWordListById","responseClass":"wordList"}]},{"path":"/wordList.{format}/{wordListId}/words","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to user","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to add words on behalf of","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"description":"Array of words to add to WordList","required":false,"dataType":"StringValue[]","allowableValues":[],"allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Adds words to a WordList","httpMethod":"POST","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"addWordsToWordList","responseClass":"ok"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"sortBy","defaultValue":"createDate","description":"Field to sort by","required":false,"dataType":"string","allowableValues":["createDate","alpha"],"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","defaultValue":"desc","description":"Direction to sort","required":false,"dataType":"string","allowableValues":["asc","desc"],"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Fetches words in a WordList","httpMethod":"GET","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"getWordListWords","responseClass":"List[wordListWord]"}]},{"path":"/wordList.{format}/{wordListId}/isFavorite","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to check","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to check for Favorite status","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Checks to see if a WordList has been favorited for a user","httpMethod":"GET","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"Not Authorized to favorite WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"isFavoriteWordList","responseClass":"BooleanValue"}]},{"path":"/wordList.{format}/{wordListId}/favorite","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to fetch","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to favorite on behalf of","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Favorites a WordList for a User","httpMethod":"POST","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"Not Authorized to favorite WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"favoriteWordList","responseClass":"ok"},{"parameters":[{"name":"wordListId","description":"ID of WordList to fetch","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to unfavorite on behalf of","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Unfavorites a WordList for a User","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"Not Authorized to favorite WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"unFavoriteWordList","responseClass":"ok"}]},{"path":"/wordList.{format}/{wordListId}/tags","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to get Tags for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches Tags on a WordList","httpMethod":"GET","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListTags","responseClass":"List[tag]"}]},{"path":"/wordList.{format}/{wordListId}/tagCount","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to get Tags for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches Tag count on a WordList","httpMethod":"GET","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListTagCount","responseClass":"long"}]},{"path":"/wordList.{format}/{wordListId}/tag","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to add Tags for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"tags","description":"Tags to add","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Adds a Tag on a WordList","httpMethod":"POST","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"addWordListTag","responseClass":"ok"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to delete Tags for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"tags","description":"Tags to delete","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Deletes a tag on a WordList","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"deleteWordListTag","responseClass":"ok"}]},{"path":"/wordList.{format}/{wordListId}/comments","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Direction to sort","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches comments on a WordList","httpMethod":"GET","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListComments","responseClass":"List[comment]"}]},{"path":"/wordList.{format}/{wordListId}/comment","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Comment to add","required":false,"dataType":"comment","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Adds a Comment on a WordList","httpMethod":"POST","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"Not Authorized to access WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"addCommentToWordList","responseClass":"comment"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Updated Comment","required":false,"dataType":"comment","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Updates a Comment on a WordList","httpMethod":"PUT","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"Not Authorized to access WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"updateCommentOnWordList","responseClass":"comment"}]},{"path":"/wordList.{format}/{wordListId}/comment/{commentId}","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Comment ID to fetch","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches a WordList comment by ID","httpMethod":"GET","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList or Comment not found.","code":404}],"nickname":"getWordListCommentById","responseClass":"comment"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Comment ID to delete","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Deletes a WordList comment by ID","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList or Comment not found.","code":404}],"nickname":"deleteWordListCommentById","responseClass":"ok"}]},{"path":"/wordList.{format}/{wordListId}/commentCount","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches WordList Comment count","httpMethod":"GET","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListCommentCount","responseClass":"long"}]},{"path":"/wordList.{format}/{wordListId}/deleteWords","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to remove words on behalf of","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"description":"Words to remove from WordList","required":false,"dataType":"StringValue[]","allowableValues":[],"allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Removes words from a WordList","httpMethod":"POST","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to modify WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"deleteWordsFromWordList","responseClass":"ok"}]},{"path":"/wordList.{format}/{wordListId}/wordsCount","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Gets a count of Words in a WordList","httpMethod":"GET","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"getWordListWordsCount","responseClass":"long"}]}],"models1":[{"name":"BooleanValue","fields":[{"name":"value","required":false,"allowMultiple":false,"paramType":"boolean"}]},{"name":"tag","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"count","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"wordList","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"type","required":false,"allowMultiple":false,"paramType":"string"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"permalink","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"username","required":false,"allowMultiple":false,"paramType":"string"},{"name":"updatedAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"numberWordsInList","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"wordListWord","fields":[{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"username","required":false,"allowMultiple":false,"paramType":"string"},{"name":"numberCommentsOnWord","required":false,"allowMultiple":false,"paramType":"long"},{"name":"numberLists","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"long","fields":[{"name":"value","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"comment","fields":[{"name":"objectType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"objectId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"commentedBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"id","required":false,"allowMultiple":false,"paramType":"string"},{"name":"commentedOn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"body","required":false,"allowMultiple":false,"paramType":"string"},{"name":"updatedAt","required":false,"allowMultiple":false,"paramType":"Date"}]}],"basePath":"url","swaggerVersion":"1.0"}
1
+ {"resourcePath":"/wordList","models":{"Long":{"properties":{"value":{"type":"long"}},"id":"long"},"WordList":{"properties":{"updatedAt":{"type":"Date"},"id":{"type":"long"},"username":{"type":"string"},"permalink":{"type":"string"},"createdAt":{"type":"Date"},"description":{"type":"string"},"userId":{"type":"long"},"name":{"type":"string"},"numberWordsInList":{"type":"long"},"type":{"type":"string"}},"id":"wordList"},"BooleanValue":{"properties":{"value":{"type":"boolean"}},"id":"BooleanValue"},"Tag":{"properties":{"id":{"type":"long"},"count":{"type":"long"},"name":{"type":"string"}},"id":"tag"},"Comment":{"properties":{"id":{"type":"string"},"updatedAt":{"type":"Date"},"body":{"type":"string"},"approved":{"type":"boolean"},"disemvoweled":{"type":"boolean"},"commentedOn":{"type":"string"},"createdAt":{"type":"Date"},"objectId":{"type":"long"},"commentedBy":{"type":"string"},"objectType":{"type":"string"}},"id":"comment"},"WordListWord":{"properties":{"username":{"type":"string"},"createdAt":{"type":"Date"},"numberCommentsOnWord":{"type":"long"},"userId":{"type":"long"},"word":{"type":"string"},"numberLists":{"type":"long"}},"id":"wordListWord"}},"apis":[{"path":"/wordList.{format}/{wordListId}","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to update","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Updated WordList","required":false,"dataType":"wordList","valueTypeInternal":"com.wordnik.community.entity.WordList","allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Updates an existing WordList","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to update WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"updateWordList","responseClass":"ok","httpMethod":"PUT"},{"parameters":[{"name":"wordListId","description":"ID of WordList to delete","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Deletes an existing WordList","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to delete WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"deleteWordList","responseClass":"ok","httpMethod":"DELETE"},{"parameters":[{"name":"wordListId","description":"ID of WordList to fetch","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Fetches a WordList by ID","responseTypeInternal":"com.wordnik.community.entity.WordList","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"getWordListById","responseClass":"wordList","httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/words","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to user","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to add words on behalf of","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"description":"Array of words to add to WordList","required":false,"dataType":"StringValue[]","valueTypeInternal":"[Lcom.wordnik.resource.StringValue;","allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Adds words to a WordList","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"addWordsToWordList","responseClass":"ok","httpMethod":"POST"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"sortBy","defaultValue":"createDate","description":"Field to sort by","required":false,"dataType":"string","allowableValues":{"values":["createDate","alpha"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","defaultValue":"desc","description":"Direction to sort","required":false,"dataType":"string","allowableValues":{"values":["asc","desc"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Fetches words in a WordList","responseTypeInternal":"com.wordnik.community.entity.WordListWord","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"getWordListWords","responseClass":"List[wordListWord]","httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/isFavorite","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to check","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to check for Favorite status","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Checks to see if a WordList has been favorited for a user","responseTypeInternal":"com.wordnik.system.model.BooleanValue","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"Not Authorized to favorite WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"isFavoriteWordList","responseClass":"BooleanValue","httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/favorite","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to fetch","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to favorite on behalf of","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Favorites a WordList for a User","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"Not Authorized to favorite WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"favoriteWordList","responseClass":"ok","httpMethod":"POST"},{"parameters":[{"name":"wordListId","description":"ID of WordList to fetch","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to unfavorite on behalf of","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Unfavorites a WordList for a User","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"Not Authorized to favorite WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"unFavoriteWordList","responseClass":"ok","httpMethod":"DELETE"}]},{"path":"/wordList.{format}/{wordListId}/tags","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to get Tags for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches Tags on a WordList","responseTypeInternal":"com.wordnik.community.entity.Tag","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListTags","responseClass":"List[tag]","httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/tagCount","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to get Tags for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches Tag count on a WordList","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListTagCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/tag","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to add Tags for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"tags","description":"Tags to add","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Adds a Tag on a WordList","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"addWordListTag","responseClass":"ok","httpMethod":"POST"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to delete Tags for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"tags","description":"Tags to delete","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Deletes a tag on a WordList","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"deleteWordListTag","responseClass":"ok","httpMethod":"DELETE"}]},{"path":"/wordList.{format}/{wordListId}/comments","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Direction to sort","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches comments on a WordList","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListComments","responseClass":"List[comment]","httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/comment","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Comment to add","required":false,"dataType":"comment","valueTypeInternal":"com.wordnik.community.entity.Comment","allowMultiple":false,"paramType":"body"}],"summary":"Adds a Comment on a WordList","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"Not Authorized to access WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"addCommentToWordList","responseClass":"comment","httpMethod":"POST"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Updated Comment","required":false,"dataType":"comment","valueTypeInternal":"com.wordnik.community.entity.Comment","allowMultiple":false,"paramType":"body"}],"summary":"Updates a Comment on a WordList","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"Not Authorized to access WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"updateCommentOnWordList","responseClass":"comment","httpMethod":"PUT"}]},{"path":"/wordList.{format}/{wordListId}/comment/{commentId}","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Comment ID to fetch","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches a WordList comment by ID","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList or Comment not found.","code":404}],"nickname":"getWordListCommentById","responseClass":"comment","httpMethod":"GET"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Comment ID to delete","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Deletes a WordList comment by ID","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList or Comment not found.","code":404}],"nickname":"deleteWordListCommentById","responseClass":"ok","httpMethod":"DELETE"}]},{"path":"/wordList.{format}/{wordListId}/commentCount","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches WordList Comment count","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListCommentCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/deleteWords","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to remove words on behalf of","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"description":"Words to remove from WordList","required":false,"dataType":"StringValue[]","valueTypeInternal":"[Lcom.wordnik.resource.StringValue;","allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Removes words from a WordList","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to modify WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"deleteWordsFromWordList","responseClass":"ok","httpMethod":"POST"}]},{"path":"/wordList.{format}/{wordListId}/wordsCount","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Gets a count of Words in a WordList","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"getWordListWordsCount","responseClass":"long","httpMethod":"GET"}]}],"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1","apiVersion":"4.0"}
data/api_docs/wordLists.json CHANGED
@@ -1 +1 @@
1
- {"resourcePath":"/wordLists","models":{"commentSummary":{"properties":{"objectDisplayName":{"type":"string","required":false,"uniqueItems":false},"objectName":{"type":"string","required":false,"uniqueItems":false},"totalCount":{"type":"long","required":false,"uniqueItems":false},"countInInterval":{"type":"long","required":false,"uniqueItems":false},"intervalInMilliseconds":{"type":"long","required":false,"uniqueItems":false},"objectType":{"type":"string","required":false,"uniqueItems":false}},"id":"commentSummary","type":"any","required":false,"uniqueItems":false},"wordList":{"properties":{"updatedAt":{"type":"Date","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"username":{"type":"string","required":false,"uniqueItems":false},"permalink":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"numberWordsInList":{"type":"long","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false}},"id":"wordList","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/wordLists.{format}/find/{searchString}","description":"","operations":[{"parameters":[{"name":"searchString","description":"String to search for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches WordList objects by name.","httpMethod":"GET","errorResponses":[{"reason":"Not authenticated.","code":403}],"nickname":"findByName","responseClass":"List[wordList]","notes":"The term supplied is effectively given a wildcard before and after so 'cat' becomes '%cat%'"}]},{"path":"/wordLists.{format}","description":"","operations":[{"parameters":[{"description":"WordList to create","required":false,"dataType":"wordList","allowableValues":[],"allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Creates a WordList.","httpMethod":"POST","errorResponses":[{"reason":"Invalid WordList supplied or mandatory fields are missing.","code":400},{"reason":"Not authenticated.","code":403},{"reason":"WordList owner not found.","code":404}],"nickname":"createWordList","responseClass":"wordList"}]},{"path":"/wordLists.{format}/mostCommentedOn","description":"","operations":[{"parameters":[{"name":"dayInterval","description":"Interval in days","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches a CommentSummary for WordList objects.","httpMethod":"GET","errorResponses":[{"reason":"Not authenticated.","code":403}],"nickname":"findMostCommentedOn","responseClass":"List[commentSummary]","notes":"The CommentSummary is sorted by comment count, descending"}]},{"path":"/wordLists.{format}/containing/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to find lists for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to add words on behalf of","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Fetches WordList objects containing a word.","httpMethod":"GET","errorResponses":[{"reason":"Invalid word or username supplied.","code":400},{"reason":"Not authenticated.","code":403}],"nickname":"findContainingWord","responseClass":"List[wordList]","notes":"Results are scoped to the supplied user."}]},{"path":"/wordLists.{format}/recentLists","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"type","description":"WordListType to filter by","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches recently created WordList objects.","httpMethod":"GET","errorResponses":[{"reason":"Not authenticated.","code":403}],"nickname":"findRecentLists","responseClass":"List[wordList]"}]}],"models1":[{"name":"wordList","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"type","required":false,"allowMultiple":false,"paramType":"string"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"permalink","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"username","required":false,"allowMultiple":false,"paramType":"string"},{"name":"updatedAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"numberWordsInList","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"commentSummary","fields":[{"name":"objectType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"totalCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"objectName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"objectDisplayName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"countInInterval","required":false,"allowMultiple":false,"paramType":"long"},{"name":"intervalInMilliseconds","required":false,"allowMultiple":false,"paramType":"long"}]}],"basePath":"url","swaggerVersion":"1.0"}
1
+ {"resourcePath":"/wordLists","models":{"WordList":{"properties":{"updatedAt":{"type":"Date"},"id":{"type":"long"},"username":{"type":"string"},"permalink":{"type":"string"},"createdAt":{"type":"Date"},"description":{"type":"string"},"userId":{"type":"long"},"name":{"type":"string"},"numberWordsInList":{"type":"long"},"type":{"type":"string"}},"id":"wordList"},"CommentSummary":{"properties":{"objectDisplayName":{"type":"string"},"objectName":{"type":"string"},"totalCount":{"type":"long"},"countInInterval":{"type":"long"},"intervalInMilliseconds":{"type":"long"},"objectType":{"type":"string"}},"id":"commentSummary"}},"apis":[{"path":"/wordLists.{format}/find/{searchString}","description":"","operations":[{"parameters":[{"name":"searchString","description":"String to search for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches WordList objects by name.","responseTypeInternal":"com.wordnik.community.entity.WordList","errorResponses":[{"reason":"Not authenticated.","code":403}],"nickname":"findByName","responseClass":"List[wordList]","notes":"The term supplied is effectively given a wildcard before and after so 'cat' becomes '%cat%'","httpMethod":"GET"}]},{"path":"/wordLists.{format}","description":"","operations":[{"parameters":[{"description":"WordList to create","required":false,"dataType":"wordList","valueTypeInternal":"com.wordnik.community.entity.WordList","allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Creates a WordList.","responseTypeInternal":"com.wordnik.community.entity.WordList","errorResponses":[{"reason":"Invalid WordList supplied or mandatory fields are missing.","code":400},{"reason":"Not authenticated.","code":403},{"reason":"WordList owner not found.","code":404}],"nickname":"createWordList","responseClass":"wordList","httpMethod":"POST"}]},{"path":"/wordLists.{format}/mostCommentedOn","description":"","operations":[{"parameters":[{"name":"dayInterval","description":"Interval in days","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches a CommentSummary for WordList objects.","responseTypeInternal":"com.wordnik.community.model.CommentSummary","errorResponses":[{"reason":"Not authenticated.","code":403}],"nickname":"findMostCommentedOn","responseClass":"List[commentSummary]","notes":"The CommentSummary is sorted by comment count, descending","httpMethod":"GET"}]},{"path":"/wordLists.{format}/containing/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to find lists for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to add words on behalf of","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Fetches WordList objects containing a word.","responseTypeInternal":"com.wordnik.community.entity.WordList","errorResponses":[{"reason":"Invalid word or username supplied.","code":400},{"reason":"Not authenticated.","code":403}],"nickname":"findContainingWord","responseClass":"List[wordList]","notes":"Results are scoped to the supplied user.","httpMethod":"GET"}]},{"path":"/wordLists.{format}/recentLists","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"type","description":"WordListType to filter by","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches recently created WordList objects.","responseTypeInternal":"com.wordnik.community.entity.WordList","errorResponses":[{"reason":"Not authenticated.","code":403}],"nickname":"findRecentLists","responseClass":"List[wordList]","httpMethod":"GET"}]}],"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1","apiVersion":"4.0"}
data/api_docs/words.json CHANGED
@@ -1 +1 @@
1
- {"resourcePath":"/words","models":{"SubscriptionStatus":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"SubscriptionStatus","type":"any","required":false,"uniqueItems":false},"wordOfTheDayList":{"properties":{"subscriptionNamespace":{"type":"string","required":false,"uniqueItems":false},"subscriberCount":{"type":"int","required":false,"uniqueItems":false},"commentCount":{"type":"int","required":false,"uniqueItems":false},"subscriptionIdentifier":{"type":"string","required":false,"uniqueItems":false},"firstItemDate":{"type":"Date","required":false,"uniqueItems":false},"voteCount":{"type":"integer","required":false,"uniqueItems":false},"id":{"type":"string","required":true,"uniqueItems":false},"category":{"type":"string","required":false,"uniqueItems":false},"createdBy":{"type":"string","required":false,"uniqueItems":false},"items":{"type":"array","required":false,"items":{"$ref":"WordOfTheDay","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"voteWeightedAverage":{"type":"float","required":false,"uniqueItems":false},"subscriptionSchedule":{"type":"string","required":false,"uniqueItems":false},"lastItemDate":{"type":"Date","required":false,"uniqueItems":false},"voteAverage":{"type":"float","required":false,"uniqueItems":false},"itemCount":{"type":"int","required":false,"uniqueItems":false},"subscriptionStatus":{"type":"string","required":false,"uniqueItems":false}},"id":"wordOfTheDayList","type":"any","required":false,"uniqueItems":false},"detailedWordUsage":{"properties":{"sentence":{"type":"sentence","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false},"metadata":{"type":"documentMetadata","required":false,"uniqueItems":false}},"id":"detailedWordUsage","type":"any","required":false,"uniqueItems":false},"yearType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"yearType","type":"any","required":false,"uniqueItems":false},"extendedMetadata":{"properties":{"sourceFileSize":{"type":"long","required":false,"uniqueItems":false},"issn":{"type":"string","required":false,"uniqueItems":false},"isbn":{"type":"string","required":false,"uniqueItems":false},"lccn":{"type":"string","required":false,"uniqueItems":false},"documentMetadataId":{"type":"long","required":false,"uniqueItems":false}},"id":"extendedMetadata","type":"any","required":false,"uniqueItems":false},"WordOfTheDay":{"properties":{"id":{"type":"long","required":true,"uniqueItems":false},"parentId":{"type":"string","required":false,"uniqueItems":false},"category":{"type":"string","required":false,"uniqueItems":false},"definition":{"type":"array","required":false,"items":{"$ref":"SimpleDefinition","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"createdBy":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"contentProvider":{"type":"contentProvider","required":false,"uniqueItems":false},"htmlExtra":{"type":"string","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"example":{"type":"array","required":false,"items":{"$ref":"SimpleExample","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"note":{"type":"string","required":false,"uniqueItems":false},"publishDate":{"type":"Date","required":false,"uniqueItems":false}},"id":"WordOfTheDay","type":"any","required":false,"uniqueItems":false},"sentence":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"display":{"type":"string","required":false,"uniqueItems":false},"rating":{"type":"int","required":false,"uniqueItems":false},"documentMetadataId":{"type":"long","required":false,"uniqueItems":false},"scoredWord":{"type":"array","required":false,"items":{"$ref":"scoredWord","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"sentence","type":"any","required":false,"uniqueItems":false},"documentMedium":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"documentMedium","type":"any","required":false,"uniqueItems":false},"frequency":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"year":{"type":"int","required":false,"uniqueItems":false}},"id":"frequency","type":"any","required":false,"uniqueItems":false},"contentType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"contentType","type":"any","required":false,"uniqueItems":false},"documentMetadata":{"properties":{"yearType":{"type":"yearType","required":false,"uniqueItems":false},"expirationDate":{"type":"Date","required":false,"uniqueItems":false},"extendedMetadata":{"type":"extendedMetadata","required":false,"uniqueItems":false},"stats":{"type":"basicDocumentStats","required":false,"uniqueItems":false},"tag":{"type":"array","required":false,"items":{"type":"string","required":false,"uniqueItems":false},"uniqueItems":false},"provider":{"type":"contentProvider","required":false,"uniqueItems":false},"contentType":{"type":"contentType","required":false,"uniqueItems":false},"sourceUrl":{"type":"string","required":false,"uniqueItems":false},"date":{"type":"Date","required":false,"uniqueItems":false},"medium":{"type":"documentMedium","required":false,"uniqueItems":false},"guid":{"type":"string","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"author":{"type":"array","required":false,"items":{"$ref":"author","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"title":{"type":"string","required":false,"uniqueItems":false},"primaryAuthorType":{"type":"authorType","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"classification":{"type":"subjectClassificationType","required":false,"uniqueItems":false},"year":{"type":"integer","required":false,"uniqueItems":false},"primaryAuthor":{"type":"string","required":false,"uniqueItems":false},"rating":{"type":"double","required":false,"uniqueItems":false},"primaryAuthorId":{"type":"long","required":false,"uniqueItems":false}},"id":"documentMetadata","type":"any","required":false,"uniqueItems":false},"author":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"authorType":{"type":"authorType","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"uniqueName":{"type":"string","required":false,"uniqueItems":false}},"id":"author","type":"any","required":false,"uniqueItems":false},"wordSearchResults":{"properties":{"searchResult":{"type":"array","required":false,"items":{"$ref":"WordSearchResult","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"totalResults":{"type":"int","required":false,"uniqueItems":false}},"id":"wordSearchResults","type":"any","required":false,"uniqueItems":false},"SimpleDefinition":{"properties":{"text":{"type":"string","required":false,"uniqueItems":false},"source":{"type":"string","required":false,"uniqueItems":false},"note":{"type":"string","required":false,"uniqueItems":false},"partOfSpeech":{"type":"string","required":false,"uniqueItems":false}},"id":"SimpleDefinition","type":"any","required":false,"uniqueItems":false},"wordObject":{"properties":{"word":{"type":"string","required":false,"uniqueItems":false},"vulgar":{"type":"string","required":false,"uniqueItems":false}},"id":"wordObject","type":"any","required":false,"uniqueItems":false},"wotdListInvitation":{"properties":{"failure":{"type":"array","required":false,"items":{"type":"string","required":false,"uniqueItems":false},"uniqueItems":false},"permalink":{"type":"string","required":false,"uniqueItems":false},"createdBy":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"recipient":{"type":"array","required":false,"items":{"type":"string","required":false,"uniqueItems":false},"uniqueItems":false},"note":{"type":"string","required":false,"uniqueItems":false}},"id":"wotdListInvitation","type":"any","required":false,"uniqueItems":false},"wordFrequency":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"wordFrequency","type":"any","required":false,"uniqueItems":false},"authorType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"authorType","type":"any","required":false,"uniqueItems":false},"definition":{"properties":{"extendedText":{"type":"string","required":false,"uniqueItems":false},"citation":{"type":"array","required":false,"items":{"$ref":"citation","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"text":{"type":"string","required":false,"uniqueItems":false},"sourceDictionary":{"type":"string","required":false,"uniqueItems":false},"exampleUsage":{"type":"array","required":false,"items":{"$ref":"ExampleUsage","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"relWord":{"type":"array","required":false,"items":{"$ref":"related","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"score":{"type":"float","required":false,"uniqueItems":false},"label":{"type":"array","required":false,"items":{"$ref":"Label","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"seqString":{"type":"string","required":false,"uniqueItems":false},"sequence":{"type":"string","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"note":{"type":"array","required":false,"items":{"$ref":"note","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"textPron":{"type":"array","required":false,"items":{"$ref":"textPron","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"partOfSpeech":{"type":"string","required":false,"uniqueItems":false}},"id":"definition","type":"any","required":false,"uniqueItems":false},"WordSearchResult":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"lexicality":{"type":"double","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false}},"id":"WordSearchResult","type":"any","required":false,"uniqueItems":false},"commentSummary":{"properties":{"objectDisplayName":{"type":"string","required":false,"uniqueItems":false},"objectName":{"type":"string","required":false,"uniqueItems":false},"totalCount":{"type":"long","required":false,"uniqueItems":false},"countInInterval":{"type":"long","required":false,"uniqueItems":false},"intervalInMilliseconds":{"type":"long","required":false,"uniqueItems":false},"objectType":{"type":"string","required":false,"uniqueItems":false}},"id":"commentSummary","type":"any","required":false,"uniqueItems":false},"subjectClassificationType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"subjectClassificationType","type":"any","required":false,"uniqueItems":false},"EntrySearchResult":{"properties":{"sourceDictionary":{"type":"string","required":false,"uniqueItems":false},"definition":{"type":"array","required":false,"items":{"$ref":"definition","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"headWord":{"type":"string","required":false,"uniqueItems":false},"entryId":{"type":"long","required":false,"uniqueItems":false}},"id":"EntrySearchResult","type":"any","required":false,"uniqueItems":false},"DefinitionSearchResults":{"properties":{"result":{"type":"array","required":false,"items":{"$ref":"definition","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"totalResults":{"type":"int","required":false,"uniqueItems":false}},"id":"DefinitionSearchResults","type":"any","required":false,"uniqueItems":false},"scoredWord":{"properties":{"position":{"type":"int","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"wordType":{"type":"string","required":false,"uniqueItems":false},"score":{"type":"float","required":false,"uniqueItems":false},"sentenceId":{"type":"long","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"partOfSpeech":{"type":"string","required":false,"uniqueItems":false}},"id":"scoredWord","type":"any","required":false,"uniqueItems":false},"basicDocumentStats":{"properties":{"uniqueBiGramsCount":{"type":"long","required":false,"uniqueItems":false},"wordsCount":{"type":"long","required":false,"uniqueItems":false},"documentsCount":{"type":"long","required":false,"uniqueItems":false},"firstUsedWordsCount":{"type":"long","required":false,"uniqueItems":false},"tokensCount":{"type":"long","required":false,"uniqueItems":false},"sentencesCount":{"type":"long","required":false,"uniqueItems":false},"viableSentencesCount":{"type":"long","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false},"uniqueWordsCount":{"type":"long","required":false,"uniqueItems":false},"key":{"type":"string","required":false,"uniqueItems":false}},"id":"basicDocumentStats","type":"any","required":false,"uniqueItems":false},"contentProvider":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"contentProvider","type":"any","required":false,"uniqueItems":false},"EntrySearchResults":{"properties":{"searchResult":{"type":"array","required":false,"items":{"$ref":"EntrySearchResult","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"totalResults":{"type":"int","required":false,"uniqueItems":false}},"id":"EntrySearchResults","type":"any","required":false,"uniqueItems":false},"example":{"properties":{"exampleId":{"type":"long","required":false,"uniqueItems":false},"title":{"type":"string","required":false,"uniqueItems":false},"text":{"type":"string","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"provider":{"type":"contentProvider","required":false,"uniqueItems":false},"year":{"type":"integer","required":false,"uniqueItems":false},"rating":{"type":"float","required":false,"uniqueItems":false},"documentId":{"type":"long","required":false,"uniqueItems":false},"url":{"type":"string","required":false,"uniqueItems":false}},"id":"example","type":"any","required":false,"uniqueItems":false},"SimpleExample":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"title":{"type":"string","required":false,"uniqueItems":false},"text":{"type":"string","required":false,"uniqueItems":false},"url":{"type":"string","required":false,"uniqueItems":false}},"id":"SimpleExample","type":"any","required":false,"uniqueItems":false},"frequencySummary":{"properties":{"unknownYearCount":{"type":"int","required":false,"uniqueItems":false},"totalCount":{"type":"long","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"frequency":{"type":"array","required":false,"items":{"$ref":"frequency","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"frequencySummary","type":"any","required":false,"uniqueItems":false},"partOfSpeech":{"properties":{"roots":{"type":"array","required":false,"items":{"$ref":"root","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"partOfSpeech","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/words.{format}/search","description":"","operations":[{"parameters":[{"name":"allowRegex","defaultValue":"false","description":"Search term is a Regular Expression","required":false,"dataType":"string","allowableValues":["true | false"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"query","description":"Search term","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"caseSensitive","defaultValue":"true","description":"Search case sensitive","required":false,"dataType":"string","allowableValues":["true | false"],"allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"Only include these comma-delimited parts of speech","required":false,"dataType":"string","allowableValues":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"Exclude these comma-delimited parts of speech","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minCorpusCount","defaultValue":"5","description":"Minimum corpus frequency for terms","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"minDictionaryCount","defaultValue":"1","description":"Minimum number of dictionary entries","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"minLength","defaultValue":"1","description":"Minimum word length","required":false,"dataType":"string","allowableValues":["0 to 1024"],"allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"dataType":"string","allowableValues":["0 to 1024"],"allowMultiple":false,"paramType":"query"},{"name":"minLexicalityRating","defaultValue":"0","description":"Minimum lexicality","required":false,"dataType":"string","allowableValues":["0 to 100"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"maxLexicalityRating","defaultValue":"0","description":"Maximum lexicality","required":false,"dataType":"string","allowableValues":["0 to 100"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":["0 to 1000"],"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":["1 to 1000"],"allowMultiple":false,"paramType":"query"}],"summary":"Searches words.","httpMethod":"GET","errorResponses":[{"reason":"Invalid term supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"searchWords","responseClass":"List[wordFrequency]"}]},{"path":"/words.{format}/wordOfTheDayList/{permalink}","description":"","operations":[{"parameters":[{"name":"permalink","description":"ID of WordOfTheDayList","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"includeAll","description":"Returns future WordOfTheDay items","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches a WordOfTheDayList by ID","httpMethod":"GET","errorResponses":[{"reason":"Invalid id supplied","code":400},{"reason":"WordOfTheDayList not found","code":404}],"nickname":"getWordOfTheDayList","responseClass":"wordOfTheDayList"}]},{"path":"/words.{format}/wordOfTheDay","description":"","operations":[{"parameters":[{"name":"date","description":"Fetches by date in yyyy-MM-dd","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"category","description":"Filters response by category","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"creator","description":"Filters response by username","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns a specific WordOfTheDay","httpMethod":"GET","nickname":"getWordOfTheDay","responseClass":"WordOfTheDay"}]},{"path":"/words.{format}/searchDefinitions","description":"","operations":[{"parameters":[{"name":"query","description":"Search term","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"definedWordSearchTerm","description":"Defined word search term","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"includeSourceDictionaries","description":"Only include these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":["ahd"," century"," wiktionary"," webster"," wordnet"],"allowMultiple":false,"paramType":"query"},{"name":"excludeSourceDictionaries","description":"Exclude these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":["ahd"," century"," wiktionary"," webster"," wordnet"],"allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"Only include these comma-delimited parts of speech","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"Exclude these comma-delimited parts of speech","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minCorpusCount","defaultValue":"5","description":"Minimum corpus frequency for terms","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"minLength","defaultValue":"1","description":"Minimum word length","required":false,"dataType":"string","allowableValues":["0 to 1024"],"allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"dataType":"string","allowableValues":["0 to 1024"],"allowMultiple":false,"paramType":"query"},{"name":"expandTerms","description":"Expand terms","required":false,"dataType":"string","allowableValues":["synonym","hypernym"],"allowMultiple":false,"paramType":"query"},{"name":"wordTypes","description":"Word types","required":false,"dataType":"string","allowableValues":["word","multi-word-unit"],"allowMultiple":false,"paramType":"query"},{"name":"returnWordsOnly","defaultValue":"false","description":"Return words only","required":false,"dataType":"string","allowableValues":["false","true"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"includeTags","defaultValue":"false","description":"Return a closed set of XML tags in response","required":false,"dataType":"string","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"},{"name":"useTagsForRanking","defaultValue":"true","description":"Use user tags, dictionary labels and hypernyms for ranking","required":false,"dataType":"string","allowableValues":["false","true"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"sortBy","description":"Attribute to sort by","required":false,"dataType":"string","allowableValues":["alpha","count","length"],"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Sort direction","required":false,"dataType":"string","allowableValues":["asc","desc"],"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":["0 to 1000"],"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":["1 to 1000"],"allowMultiple":false,"paramType":"query"}],"summary":"Searches definitions.","httpMethod":"GET","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"nickname":"searchDefinitions","responseClass":"DefinitionSearchResults"}]},{"path":"/words.{format}/searchEntries","description":"","operations":[{"parameters":[{"name":"query","description":"Search term","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":["0 to 1000"],"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":["1 to 1000"],"allowMultiple":false,"paramType":"query"}],"summary":"Searches dictionary entries.","httpMethod":"GET","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"nickname":"searchEntries","responseClass":"EntrySearchResults"}]},{"path":"/words.{format}/frequency","description":"","operations":[{"summary":"Fetches corpus-level word frequency","httpMethod":"GET","errorResponses":[{"reason":"No data found.","code":404}],"nickname":"getFrequency","responseClass":"frequencySummary"}]},{"path":"/words.{format}/surfaceForms","description":"","operations":[{"parameters":[{"name":"term","description":"Word to get surface forms for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches surface forms of a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"nickname":"getSurfaceForms","responseClass":"String"}]},{"path":"/words.{format}/id/{id}","description":"","operations":[{"parameters":[{"name":"id","description":"ID of word","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches a word by ID","httpMethod":"GET","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"No word found.","code":404}],"nickname":"getWordById","responseClass":"wordObject","notes":"Deprecated."}]},{"path":"/words.{format}/wordOfTheDay/range","description":"","operations":[{"parameters":[{"name":"category","description":"Filters response by category","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"creator","description":"Filters response by username","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"provider","description":"Filters response by ContentProvider","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns a WordOfTheDay range","httpMethod":"GET","nickname":"getWordOfTheDayRange","responseClass":"List[WordOfTheDay]"}]},{"path":"/words.{format}/canonicalForms","description":"","operations":[{"parameters":[{"name":"term","description":"Word to get canonical forms for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches canonical forms of a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"nickname":"getCanonicalForms","responseClass":"String"}]},{"path":"/words.{format}/search/{query}","description":"","operations":[{"parameters":[{"name":"allowRegex","defaultValue":"false","description":"Search query is a Regular Expression","required":false,"dataType":"string","allowableValues":["true | false"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"query","description":"Search query","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"caseSensitive","defaultValue":"true","description":"Search case sensitive","required":false,"dataType":"string","allowableValues":["true | false"],"allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"Only include these comma-delimited parts of speech","required":false,"dataType":"string","allowableValues":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"Exclude these comma-delimited parts of speech","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minCorpusCount","defaultValue":"5","description":"Minimum corpus frequency for terms","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"minDictionaryCount","defaultValue":"1","description":"Minimum number of dictionary entries","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"minLength","defaultValue":"1","description":"Minimum word length","required":false,"dataType":"string","allowableValues":["0 to 1024"],"allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"dataType":"string","allowableValues":["0 to 1024"],"allowMultiple":false,"paramType":"query"},{"name":"minLexicalityRating","defaultValue":"0","description":"Minimum lexicality","required":false,"dataType":"string","allowableValues":["0 to 100"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"maxLexicalityRating","defaultValue":"0","description":"Maximum lexicality","required":false,"dataType":"string","allowableValues":["0 to 100"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":["0 to 1000"],"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":["1 to 1000"],"allowMultiple":false,"paramType":"query"}],"summary":"Searches words.","httpMethod":"GET","errorResponses":[{"reason":"Invalid query supplied.","code":400}],"nickname":"searchWordsNew","responseClass":"wordSearchResults"}]},{"path":"/words.{format}/randomWords","description":"","operations":[{"parameters":[{"name":"hasDictionaryDef","description":"Only return words with dictionary definitions","required":false,"dataType":"string","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"CSV part-of-speech values to include","required":false,"dataType":"string","allowableValues":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"CSV part-of-speech values to exclude","required":false,"dataType":"string","allowableValues":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"allowMultiple":false,"paramType":"query"},{"name":"minCorpusCount","description":"Minimum corpus frequency for terms (integer)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms (integer)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minDictionaryCount","description":"Minimum dictionary count (integer)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count (integer)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minLength","description":"Minimum word length (characters)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length (characters)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minLexicalityRating","description":"Minimum lexicality","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"maxLexicalityRating","description":"Maximum lexicality","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"sortBy","description":"Attribute to sort by","required":false,"dataType":"string","allowableValues":["alpha","count"],"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Sort direction","required":false,"dataType":"string","allowableValues":["asc","desc"],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns an array of random WordObjects, in the format specified by the URL","httpMethod":"GET","errorResponses":[{"reason":"Invalid term supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"getRandomWords","responseClass":"List[wordObject]"}]},{"path":"/words.{format}/randomWord","description":"","operations":[{"parameters":[{"name":"hasDictionaryDef","defaultValue":"true","description":"Only return words with dictionary definitions","required":false,"dataType":"string","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"CSV part-of-speech values to include","required":false,"dataType":"string","allowableValues":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"CSV part-of-speech values to exclude","required":false,"dataType":"string","allowableValues":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"allowMultiple":false,"paramType":"query"},{"name":"minCorpusCount","description":"Minimum corpus frequency for terms","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minDictionaryCount","description":"Minimum dictionary count","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minLength","description":"Minimum word length","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minLexicalityRating","description":"Minimum lexicality","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"maxLexicalityRating","description":"Maximum lexicality","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns a single random WordObject, in the format specified by the URL","httpMethod":"GET","errorResponses":[{"reason":"No word found.","code":404}],"nickname":"getRandomWord","responseClass":"wordObject"}]},{"path":"/words.{format}/examples","description":"","operations":[{"parameters":[{"description":"Words to fetch examples for","required":false,"dataType":"String[]","allowableValues":[],"allowMultiple":false,"paramType":"body"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches examples for multiple words.","httpMethod":"POST","errorResponses":[{"reason":"Invalid words to search with.","code":400}],"nickname":"getExamplesForWords","responseClass":"List[example]"}]},{"path":"/words.{format}/mostCommentedOn","description":"","operations":[{"parameters":[{"name":"dayInterval","description":"Number of days to consider","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches words most commented on.","httpMethod":"GET","errorResponses":[{"reason":"Invalid time interval.","code":400}],"nickname":"getWordsMostCommentedOn","responseClass":"List[commentSummary]","notes":"Set the dayInterval to determine the time frame."}]},{"path":"/words.{format}/firstUsed/{statsType}/{object}","description":"","operations":[{"parameters":[{"name":"statsType","description":"DocumentStatsType dimension to filter by","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"object","description":"Identifier of DocumentStatsType object","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"detailed","description":"Return detailed data","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches words most commented on.","httpMethod":"GET","errorResponses":[{"reason":"Invalid time interval.","code":400}],"nickname":"getWordsMostCommentedOn","responseClass":"List[detailedWordUsage]","notes":"Set the dayInterval to determine the time frame."}]},{"path":"/words.{format}/wordOfTheDayList/{permalink}/invite","description":"","operations":[{"parameters":[{"name":"permalink","description":"ID of WordOfTheDayList","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Invitation to send","required":false,"dataType":"wotdListInvitation","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Invites users to a WordOfTheDayList","httpMethod":"POST","errorResponses":[{"reason":"User is not eligible to send invitations","code":400},{"reason":"WordOfTheDayList not found.","code":404}],"nickname":"inviteToWordOfTheDayList","responseClass":"ok","notes":"A user can invite up to 20 people in a single day. The users being invited will be checked to see if they have opted out of email communications"}]},{"path":"/words.{format}/wordOfTheDayLists/recent","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches recently created WordOfTheDayLists","httpMethod":"GET","errorResponses":[{"reason":"No WordOfTheDayLists found.","code":404}],"nickname":"getRecentWordOfTheDayLists","responseClass":"List[wordOfTheDayList]"}]},{"path":"/words.{format}/wordOfTheDayList/{permalink}/{specifier}","description":"","operations":[{"parameters":[{"name":"permalink","description":"ID of WordOfTheDayList","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"specifier","description":"Specifier for the item to fetch. Either 'current' or a date.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"includeExtraHtml","description":"Include extra HTML if available","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Fetches a WordOfTheDayList by ID","httpMethod":"GET","errorResponses":[{"reason":"Invalid id supplied","code":400},{"reason":"WordOfTheDayList not found","code":404}],"nickname":"getWordOfTheDayListItem","responseClass":"WordOfTheDay"}]},{"path":"/words.{format}/wordOfTheDayLists","description":"","operations":[{"parameters":[{"name":"containsWord","description":"Lists must contain a specific word","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"subscriberCount","description":"Lists must have the specified number of subscribers","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"itemCount","description":"Lists must have the specified number of items","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"includeAll","description":"Returns future WordOfTheDay items","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches an array of WordOfTheDayList basd on a criteria","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getWordOfTheDayListsContainingWord","responseClass":"List[wordOfTheDayList]"}]},{"path":"/words.{format}/wordOfTheDayLists/subscriptionProcess","description":"","operations":[{"parameters":[{"name":"date","description":"Date string to fetch for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns whether or not a subscription process has been run.","httpMethod":"GET","errorResponses":[{"reason":"Invalid date format supplied.","code":400}],"nickname":"getWordOfTheDayListSubscriptionProcessStatus","responseClass":"String","notes":"Uses the current server time (day resolution) as the default date to check for, optionally a dateString can be supplied for a specific date to check for."}]},{"path":"/words.{format}/wordOfTheDayList/{permalink}/subscription","description":"","operations":[{"parameters":[{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"permalink","description":"ID of WordOfTheDayList","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"medium","description":"Medium to subscribe with","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"description":"Username to subscribe","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Subscribes a user to a WordOfTheDayList","httpMethod":"POST","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not authorized to subscribe","code":403},{"reason":"WordOfTheDayList or User not found","code":404}],"nickname":"subscribeToList","responseClass":"ok"}]},{"path":"/words.{format}/wordOfTheDayLists/{date}","description":"","operations":[{"parameters":[{"name":"date","description":"ID of WordOfTheDayList","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"includeAll","description":"Returns future WordOfTheDay items","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches WordOfTheDay objects for a specific date","httpMethod":"GET","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"WordOfTheDayList or User not found","code":404}],"nickname":"getWordOfTheDayListsForDate","responseClass":"List[WordOfTheDay]"}]}],"models1":[{"name":"EntrySearchResult","fields":[{"name":"definition","required":false,"wrapperName":"definitions","allowMultiple":false,"paramType":"List[definition]"},{"name":"sourceDictionary","required":false,"allowMultiple":false,"paramType":"string"},{"name":"headWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"entryId","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"extendedMetadata","fields":[{"name":"documentMetadataId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"isbn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"issn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"lccn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sourceFileSize","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"commentSummary","fields":[{"name":"objectType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"totalCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"objectName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"objectDisplayName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"countInInterval","required":false,"allowMultiple":false,"paramType":"long"},{"name":"intervalInMilliseconds","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"author","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"authorType","required":false,"allowMultiple":false,"paramType":"authorType"},{"name":"uniqueName","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"wotdListInvitation","fields":[{"name":"createdBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"note","required":false,"allowMultiple":false,"paramType":"string"},{"name":"permalink","required":false,"allowMultiple":false,"paramType":"string"},{"name":"recipient","required":false,"wrapperName":"recipients","allowMultiple":false,"paramType":"List[string]"},{"name":"failure","required":false,"wrapperName":"failures","allowMultiple":false,"paramType":"List[string]"}]},{"name":"wordOfTheDayList","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":true,"allowMultiple":false,"paramType":"string"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"category","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"items","required":false,"allowMultiple":false,"paramType":"List[WordOfTheDay]"},{"name":"subscriberCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"subscriptionStatus","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"commentCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"voteCount","required":false,"allowMultiple":false,"paramType":"integer"},{"name":"voteAverage","required":false,"allowMultiple":false,"paramType":"float"},{"name":"voteWeightedAverage","required":false,"allowMultiple":false,"paramType":"float"},{"name":"itemCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"firstItemDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"lastItemDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"subscriptionSchedule","required":false,"allowMultiple":false,"paramType":"string"},{"name":"subscriptionNamespace","required":false,"allowMultiple":false,"paramType":"string"},{"name":"subscriptionIdentifier","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"example","fields":[{"name":"year","required":false,"allowMultiple":false,"paramType":"integer"},{"name":"provider","required":false,"allowMultiple":false,"paramType":"contentProvider"},{"name":"url","required":false,"allowMultiple":false,"paramType":"string"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"text","required":false,"allowMultiple":false,"paramType":"string"},{"name":"title","required":false,"allowMultiple":false,"paramType":"string"},{"name":"rating","required":false,"allowMultiple":false,"paramType":"float"},{"name":"exampleId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"documentId","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"WordSearchResult","fields":[{"name":"count","required":false,"allowMultiple":false,"paramType":"long"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"lexicality","required":false,"allowMultiple":false,"paramType":"double"}]},{"name":"definition","fields":[{"name":"exampleUsage","required":false,"wrapperName":"exampleUses","allowMultiple":false,"paramType":"List[ExampleUsage]"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"text","required":false,"allowMultiple":false,"paramType":"string"},{"name":"textPron","required":false,"wrapperName":"textProns","allowMultiple":false,"paramType":"List[textPron]"},{"name":"score","required":false,"allowMultiple":false,"paramType":"float"},{"name":"partOfSpeech","required":false,"allowMultiple":false,"paramType":"string"},{"name":"note","required":false,"wrapperName":"notes","allowMultiple":false,"paramType":"List[note]"},{"name":"relWord","required":false,"wrapperName":"relatedWords","allowMultiple":false,"paramType":"List[related]"},{"name":"sourceDictionary","required":false,"allowMultiple":false,"paramType":"string"},{"name":"label","required":false,"wrapperName":"labels","allowMultiple":false,"paramType":"List[Label]"},{"name":"citation","required":false,"wrapperName":"citations","allowMultiple":false,"paramType":"List[citation]"},{"name":"sequence","required":false,"allowMultiple":false,"paramType":"string"},{"name":"seqString","required":false,"allowMultiple":false,"paramType":"string"},{"name":"extendedText","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"documentMedium","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"contentProvider","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"frequency","fields":[{"name":"year","required":false,"allowMultiple":false,"paramType":"int"},{"name":"count","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"authorType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"frequencySummary","fields":[{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"totalCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"frequency","required":false,"allowMultiple":false,"paramType":"List[frequency]"},{"name":"unknownYearCount","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"detailedWordUsage","fields":[{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sentence","required":false,"allowMultiple":false,"paramType":"sentence"},{"name":"metadata","required":false,"allowMultiple":false,"paramType":"documentMetadata"}]},{"name":"scoredWord","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"position","required":false,"allowMultiple":false,"paramType":"int"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"score","required":false,"allowMultiple":false,"paramType":"float"},{"name":"sentenceId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"partOfSpeech","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"SimpleDefinition","fields":[{"name":"text","required":false,"allowMultiple":false,"paramType":"string"},{"name":"partOfSpeech","required":false,"allowMultiple":false,"paramType":"string"},{"name":"note","required":false,"allowMultiple":false,"paramType":"string"},{"name":"source","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"basicDocumentStats","fields":[{"name":"key","required":false,"allowMultiple":false,"paramType":"string"},{"name":"type","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sentencesCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"uniqueWordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"documentsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"tokensCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"firstUsedWordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"viableSentencesCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"uniqueBiGramsCount","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"wordFrequency","fields":[{"name":"count","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"sentence","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"scoredWord","required":false,"wrapperName":"scoredWords","allowMultiple":false,"paramType":"List[scoredWord]"},{"name":"display","required":false,"allowMultiple":false,"paramType":"string"},{"name":"documentMetadataId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"rating","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"wordObject","fields":[{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"vulgar","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"contentType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"yearType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"documentMetadata","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"year","required":false,"allowMultiple":false,"paramType":"integer"},{"name":"contentType","required":false,"allowMultiple":false,"paramType":"contentType"},{"name":"provider","required":false,"allowMultiple":false,"paramType":"contentProvider"},{"name":"tag","required":false,"wrapperName":"tags","allowMultiple":false,"paramType":"List[string]"},{"name":"title","required":false,"allowMultiple":false,"paramType":"string"},{"name":"rating","required":false,"allowMultiple":false,"paramType":"double"},{"name":"medium","required":false,"allowMultiple":false,"paramType":"documentMedium"},{"name":"sourceUrl","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"classification","required":false,"allowMultiple":false,"paramType":"subjectClassificationType"},{"name":"date","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"yearType","required":false,"allowMultiple":false,"paramType":"yearType"},{"name":"primaryAuthor","required":false,"allowMultiple":false,"paramType":"string"},{"name":"primaryAuthorType","required":false,"allowMultiple":false,"paramType":"authorType"},{"name":"primaryAuthorId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"guid","required":false,"allowMultiple":false,"paramType":"string"},{"name":"extendedMetadata","required":false,"allowMultiple":false,"paramType":"extendedMetadata"},{"name":"author","required":false,"wrapperName":"authors","allowMultiple":false,"paramType":"List[author]"},{"name":"expirationDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"stats","required":false,"allowMultiple":false,"paramType":"basicDocumentStats"}]},{"name":"partOfSpeech","fields":[{"name":"roots","required":false,"allowMultiple":false,"paramType":"List[root]"}]},{"name":"subjectClassificationType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"wordSearchResults","fields":[{"name":"totalResults","required":false,"allowMultiple":false,"paramType":"int"},{"name":"searchResult","required":false,"wrapperName":"searchResults","allowMultiple":false,"paramType":"List[WordSearchResult]"}]},{"name":"WordOfTheDay","fields":[{"name":"id","required":true,"allowMultiple":false,"paramType":"long"},{"name":"category","required":false,"allowMultiple":false,"paramType":"string"},{"name":"example","required":false,"wrapperName":"examples","allowMultiple":false,"paramType":"List[SimpleExample]"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"definition","required":false,"wrapperName":"definitions","allowMultiple":false,"paramType":"List[SimpleDefinition]"},{"name":"contentProvider","required":false,"allowMultiple":false,"paramType":"contentProvider"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"publishDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"parentId","required":false,"allowMultiple":false,"paramType":"string"},{"name":"note","required":false,"allowMultiple":false,"paramType":"string"},{"name":"htmlExtra","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"DefinitionSearchResults","fields":[{"name":"totalResults","required":false,"allowMultiple":false,"paramType":"int"},{"name":"result","required":false,"wrapperName":"results","allowMultiple":false,"paramType":"List[definition]"}]},{"name":"SubscriptionStatus","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"EntrySearchResults","fields":[{"name":"totalResults","required":false,"allowMultiple":false,"paramType":"int"},{"name":"searchResult","required":false,"wrapperName":"searchResults","allowMultiple":false,"paramType":"List[EntrySearchResult]"}]},{"name":"SimpleExample","fields":[{"name":"url","required":false,"allowMultiple":false,"paramType":"string"},{"name":"text","required":false,"allowMultiple":false,"paramType":"string"},{"name":"title","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"}]}],"basePath":"url","swaggerVersion":"1.0"}
1
+ {"resourcePath":"/words","models":{"SubscriptionStatus":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"SubscriptionStatus"},"DocumentMetadata":{"properties":{"yearType":{"type":"yearType"},"expirationDate":{"type":"Date"},"extendedMetadata":{"type":"extendedMetadata"},"tag":{"type":"array","items":{"type":"string"}},"stats":{"type":"basicDocumentStats"},"provider":{"type":"contentProvider"},"contentType":{"type":"contentType"},"sourceUrl":{"type":"string"},"date":{"type":"Date"},"medium":{"type":"documentMedium"},"guid":{"type":"string"},"id":{"type":"long"},"author":{"type":"array","items":{"$ref":"author"}},"title":{"type":"string"},"primaryAuthorType":{"type":"authorType"},"createdAt":{"type":"Date"},"classification":{"type":"subjectClassificationType"},"year":{"type":"integer"},"primaryAuthor":{"type":"string"},"rating":{"type":"double"},"primaryAuthorId":{"type":"long"}},"id":"documentMetadata"},"WordSearchResult":{"properties":{"count":{"type":"long"},"lexicality":{"type":"double"},"word":{"type":"string"}},"id":"WordSearchResult"},"WordOfTheDayList":{"properties":{"subscriptionNamespace":{"type":"string"},"subscriberCount":{"type":"int"},"commentCount":{"type":"int"},"subscriptionIdentifier":{"type":"string"},"firstItemDate":{"type":"Date"},"voteCount":{"type":"integer"},"id":{"type":"string","required":true},"category":{"type":"string"},"createdBy":{"type":"string"},"items":{"type":"array","items":{"$ref":"WordOfTheDay"}},"description":{"type":"string"},"createdAt":{"type":"Date"},"name":{"type":"string"},"voteWeightedAverage":{"type":"float"},"subscriptionSchedule":{"type":"string"},"lastItemDate":{"type":"Date"},"voteAverage":{"type":"float"},"itemCount":{"type":"int"},"subscriptionStatus":{"type":"string"}},"id":"wordOfTheDayList"},"WordOfTheDay":{"properties":{"id":{"type":"long","required":true},"parentId":{"type":"string"},"category":{"type":"string"},"definition":{"type":"array","items":{"$ref":"SimpleDefinition"}},"createdBy":{"type":"string"},"createdAt":{"type":"Date"},"contentProvider":{"type":"contentProvider"},"htmlExtra":{"type":"string"},"word":{"type":"string"},"example":{"type":"array","items":{"$ref":"SimpleExample"}},"note":{"type":"string"},"publishDate":{"type":"Date"}},"id":"WordOfTheDay"},"DetailedWordUsage":{"properties":{"sentence":{"type":"sentence"},"wordstring":{"type":"string"},"metadata":{"type":"documentMetadata"}},"id":"detailedWordUsage"},"EntrySearchResult":{"properties":{"sourceDictionary":{"type":"string"},"definition":{"type":"array","items":{"$ref":"definition"}},"headWord":{"type":"string"},"entryId":{"type":"long"}},"id":"EntrySearchResult"},"DefinitionSearchResults":{"properties":{"result":{"type":"array","items":{"$ref":"definition"}},"totalResults":{"type":"int"}},"id":"DefinitionSearchResults"},"WordObject":{"properties":{"word":{"type":"string"},"vulgar":{"type":"string"}},"id":"wordObject"},"ScoredWord":{"properties":{"position":{"type":"int"},"id":{"type":"long"},"wordType":{"type":"string"},"score":{"type":"float"},"sentenceId":{"type":"long"},"word":{"type":"string"},"partOfSpeech":{"type":"string"}},"id":"scoredWord"},"CommentSummary":{"properties":{"objectDisplayName":{"type":"string"},"objectName":{"type":"string"},"totalCount":{"type":"long"},"countInInterval":{"type":"long"},"intervalInMilliseconds":{"type":"long"},"objectType":{"type":"string"}},"id":"commentSummary"},"WordSearchResults":{"properties":{"searchResult":{"type":"array","items":{"$ref":"WordSearchResult"}},"totalResults":{"type":"int"}},"id":"wordSearchResults"},"Example":{"properties":{"exampleId":{"type":"long"},"title":{"type":"string"},"text":{"type":"string"},"word":{"type":"string"},"provider":{"type":"contentProvider"},"year":{"type":"integer"},"rating":{"type":"float"},"documentId":{"type":"long"},"url":{"type":"string"}},"id":"example"},"WordFrequency":{"properties":{"count":{"type":"long"},"wordstring":{"type":"string"}},"id":"wordFrequency"},"WotdListInvitation":{"properties":{"failure":{"type":"array","items":{"type":"string"}},"permalink":{"type":"string"},"createdBy":{"type":"string"},"createdAt":{"type":"Date"},"recipient":{"type":"array","items":{"type":"string"}},"note":{"type":"string"}},"id":"wotdListInvitation"},"SimpleDefinition":{"properties":{"text":{"type":"string"},"source":{"type":"string"},"note":{"type":"string"},"partOfSpeech":{"type":"string"}},"id":"SimpleDefinition"},"Sentence":{"properties":{"id":{"type":"long"},"display":{"type":"string"},"rating":{"type":"int"},"documentMetadataId":{"type":"long"},"scoredWord":{"type":"array","items":{"$ref":"scoredWord"}}},"id":"sentence"},"EntrySearchResults":{"properties":{"searchResult":{"type":"array","items":{"$ref":"EntrySearchResult"}},"totalResults":{"type":"int"}},"id":"EntrySearchResults"},"ContentProvider":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"contentProvider"},"SimpleExample":{"properties":{"id":{"type":"long"},"title":{"type":"string"},"text":{"type":"string"},"url":{"type":"string"}},"id":"SimpleExample"},"Definition":{"properties":{"extendedText":{"type":"string"},"citation":{"type":"array","items":{"$ref":"citation"}},"text":{"type":"string"},"sourceDictionary":{"type":"string"},"exampleUsage":{"type":"array","items":{"$ref":"ExampleUsage"}},"relWord":{"type":"array","items":{"$ref":"related"}},"score":{"type":"float"},"label":{"type":"array","items":{"$ref":"Label"}},"seqString":{"type":"string"},"dictionaryAttribution":{"type":"string"},"sequence":{"type":"string"},"word":{"type":"string"},"note":{"type":"array","items":{"$ref":"note"}},"textPron":{"type":"array","items":{"$ref":"textPron"}},"partOfSpeech":{"type":"string"}},"id":"definition"},"PartOfSpeech":{"properties":{"roots":{"type":"array","items":{"$ref":"root"}}},"id":"partOfSpeech"}},"apis":[{"path":"/words.{format}/search","description":"","operations":[{"parameters":[{"name":"allowRegex","defaultValue":"false","description":"Search term is a Regular Expression","required":false,"dataType":"string","allowableValues":{"values":["true","false"],"valueType":"LIST"},"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"query","description":"Search term","required":true,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"caseSensitive","defaultValue":"true","description":"Search case sensitive","required":false,"dataType":"string","allowableValues":{"values":["true","false"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"Only include these comma-delimited parts of speech","required":false,"dataType":"string","allowableValues":{"values":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"Exclude these comma-delimited parts of speech","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minCorpusCount","defaultValue":"5","description":"Minimum corpus frequency for terms","required":false,"dataType":"string","allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"dataType":"string","allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"minDictionaryCount","defaultValue":"1","description":"Minimum number of dictionary entries","required":false,"dataType":"string","allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count","required":false,"dataType":"string","allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"minLength","defaultValue":"1","description":"Minimum word length","required":false,"dataType":"string","allowableValues":{"max":1024.0,"min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"dataType":"string","allowableValues":{"max":1024.0,"min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"minLexicalityRating","defaultValue":"0","description":"Minimum lexicality","required":false,"dataType":"string","allowableValues":{"max":100.0,"min":0.0,"valueType":"RANGE"},"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"maxLexicalityRating","defaultValue":"0","description":"Maximum lexicality","required":false,"dataType":"string","allowableValues":{"max":100.0,"min":0.0,"valueType":"RANGE"},"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":{"max":1000.0,"min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":{"max":1000.0,"min":1.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"}],"summary":"Searches words.","responseTypeInternal":"com.wordnik.corpus.stats.entity.WordFrequency","errorResponses":[{"reason":"Invalid term supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"searchWords","responseClass":"List[wordFrequency]","httpMethod":"GET"}]},{"path":"/words.{format}/wordOfTheDayList/{permalink}","description":"","operations":[{"parameters":[{"name":"permalink","description":"ID of WordOfTheDayList","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"includeAll","description":"Returns future WordOfTheDay items","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches a WordOfTheDayList by ID","responseTypeInternal":"com.wordnik.corpus.updated.entity.WordOfTheDayList","errorResponses":[{"reason":"Invalid id supplied","code":400},{"reason":"WordOfTheDayList not found","code":404}],"nickname":"getWordOfTheDayList","responseClass":"wordOfTheDayList","httpMethod":"GET"}]},{"path":"/words.{format}/wordOfTheDay","description":"","operations":[{"parameters":[{"name":"date","description":"Fetches by date in yyyy-MM-dd","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"category","description":"Filters response by category","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"creator","description":"Filters response by username","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns a specific WordOfTheDay","responseTypeInternal":"com.wordnik.community.entity.WordOfTheDay","nickname":"getWordOfTheDay","responseClass":"WordOfTheDay","httpMethod":"GET"}]},{"path":"/words.{format}/searchEntries","description":"","operations":[{"parameters":[{"name":"query","description":"Search term","required":true,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":{"max":1000.0,"min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":{"max":1000.0,"min":1.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"}],"summary":"Searches dictionary entries.","responseTypeInternal":"com.wordnik.index.entry.EntrySearchResults","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"nickname":"searchEntries","responseClass":"EntrySearchResults","httpMethod":"GET"}]},{"path":"/words.{format}/searchDefinitions","description":"","operations":[{"parameters":[{"name":"query","description":"Search term","required":true,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"definedWordSearchTerm","description":"Defined word search term","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"includeSourceDictionaries","description":"Only include these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":{"values":["ahd"," century"," wiktionary"," webster"," wordnet"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"excludeSourceDictionaries","description":"Exclude these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":{"values":["ahd"," century"," wiktionary"," webster"," wordnet"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"Only include these comma-delimited parts of speech","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"Exclude these comma-delimited parts of speech","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minCorpusCount","defaultValue":"5","description":"Minimum corpus frequency for terms","required":false,"dataType":"string","allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"dataType":"string","allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"minLength","defaultValue":"1","description":"Minimum word length","required":false,"dataType":"string","allowableValues":{"max":1024.0,"min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"dataType":"string","allowableValues":{"max":1024.0,"min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"expandTerms","description":"Expand terms","required":false,"dataType":"string","allowableValues":{"values":["synonym","hypernym"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"wordTypes","description":"Word types","required":false,"dataType":"string","allowableValues":{"values":["word","multi-word-unit"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"returnWordsOnly","defaultValue":"false","description":"Return words only","required":false,"dataType":"string","allowableValues":{"values":["false","true"],"valueType":"LIST"},"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"includeTags","defaultValue":"false","description":"Return a closed set of XML tags in response","required":false,"dataType":"string","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"useTagsForRanking","defaultValue":"true","description":"Use user tags, dictionary labels and hypernyms for ranking","required":false,"dataType":"string","allowableValues":{"values":["false","true"],"valueType":"LIST"},"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"sortBy","description":"Attribute to sort by","required":false,"dataType":"string","allowableValues":{"values":["alpha","count","length"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Sort direction","required":false,"dataType":"string","allowableValues":{"values":["asc","desc"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":{"max":1000.0,"min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":{"max":1000.0,"min":1.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"}],"summary":"Searches definitions.","responseTypeInternal":"com.wordnik.index.definition.DefinitionSearchResults","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"nickname":"searchDefinitions","responseClass":"DefinitionSearchResults","httpMethod":"GET"}]},{"path":"/words.{format}/surfaceForms","description":"","operations":[{"parameters":[{"name":"term","description":"Word to get surface forms for.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches surface forms of a word","responseTypeInternal":"String","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"nickname":"getSurfaceForms","responseClass":"String","httpMethod":"GET"}]},{"path":"/words.{format}/wordOfTheDay/range","description":"","operations":[{"parameters":[{"name":"category","description":"Filters response by category","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"creator","description":"Filters response by username","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"provider","description":"Filters response by ContentProvider","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns a WordOfTheDay range","responseTypeInternal":"com.wordnik.community.entity.WordOfTheDay","nickname":"getWordOfTheDayRange","responseClass":"List[WordOfTheDay]","httpMethod":"GET"}]},{"path":"/words.{format}/canonicalForms","description":"","operations":[{"parameters":[{"name":"term","description":"Word to get canonical forms for.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches canonical forms of a word","responseTypeInternal":"String","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"nickname":"getCanonicalForms","responseClass":"String","httpMethod":"GET"}]},{"path":"/words.{format}/search/{query}","description":"","operations":[{"parameters":[{"name":"allowRegex","defaultValue":"false","description":"Search query is a Regular Expression","required":false,"dataType":"string","allowableValues":{"values":["true","false"],"valueType":"LIST"},"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"query","description":"Search query","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"caseSensitive","defaultValue":"true","description":"Search case sensitive","required":false,"dataType":"string","allowableValues":{"values":["true","false"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"Only include these comma-delimited parts of speech","required":false,"dataType":"string","allowableValues":{"values":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"Exclude these comma-delimited parts of speech","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minCorpusCount","defaultValue":"5","description":"Minimum corpus frequency for terms","required":false,"dataType":"string","allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"dataType":"string","allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"minDictionaryCount","defaultValue":"1","description":"Minimum number of dictionary entries","required":false,"dataType":"string","allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count","required":false,"dataType":"string","allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"minLength","defaultValue":"1","description":"Minimum word length","required":false,"dataType":"string","allowableValues":{"max":1024.0,"min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"dataType":"string","allowableValues":{"max":1024.0,"min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"minLexicalityRating","defaultValue":"0","description":"Minimum lexicality","required":false,"dataType":"string","allowableValues":{"max":100.0,"min":0.0,"valueType":"RANGE"},"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"maxLexicalityRating","defaultValue":"0","description":"Maximum lexicality","required":false,"dataType":"string","allowableValues":{"max":100.0,"min":0.0,"valueType":"RANGE"},"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":{"max":1000.0,"min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":{"max":1000.0,"min":1.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"}],"summary":"Searches words.","responseTypeInternal":"com.wordnik.index.word.WordSearchResults","errorResponses":[{"reason":"Invalid query supplied.","code":400}],"nickname":"searchWordsNew","responseClass":"wordSearchResults","httpMethod":"GET"}]},{"path":"/words.{format}/randomWords","description":"","operations":[{"parameters":[{"name":"hasDictionaryDef","description":"Only return words with dictionary definitions","required":false,"dataType":"string","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"CSV part-of-speech values to include","required":false,"dataType":"string","allowableValues":{"values":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"CSV part-of-speech values to exclude","required":false,"dataType":"string","allowableValues":{"values":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"minCorpusCount","description":"Minimum corpus frequency for terms (integer)","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms (integer)","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minDictionaryCount","description":"Minimum dictionary count (integer)","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count (integer)","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minLength","description":"Minimum word length (characters)","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length (characters)","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minLexicalityRating","description":"Minimum lexicality","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"maxLexicalityRating","description":"Maximum lexicality","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"sortBy","description":"Attribute to sort by","required":false,"dataType":"string","allowableValues":{"values":["alpha","count"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Sort direction","required":false,"dataType":"string","allowableValues":{"values":["asc","desc"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns an array of random WordObjects, in the format specified by the URL","responseTypeInternal":"com.wordnik.corpus.entity.Word","errorResponses":[{"reason":"Invalid term supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"getRandomWords","responseClass":"List[wordObject]","httpMethod":"GET"}]},{"path":"/words.{format}/randomWord","description":"","operations":[{"parameters":[{"name":"hasDictionaryDef","defaultValue":"true","description":"Only return words with dictionary definitions","required":false,"dataType":"string","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"CSV part-of-speech values to include","required":false,"dataType":"string","allowableValues":{"values":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"CSV part-of-speech values to exclude","required":false,"dataType":"string","allowableValues":{"values":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"minCorpusCount","description":"Minimum corpus frequency for terms","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minDictionaryCount","description":"Minimum dictionary count","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minLength","description":"Minimum word length","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minLexicalityRating","description":"Minimum lexicality","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"maxLexicalityRating","description":"Maximum lexicality","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns a single random WordObject, in the format specified by the URL","responseTypeInternal":"com.wordnik.corpus.entity.Word","errorResponses":[{"reason":"No word found.","code":404}],"nickname":"getRandomWord","responseClass":"wordObject","httpMethod":"GET"}]},{"path":"/words.{format}/examples","description":"","operations":[{"parameters":[{"description":"Words to fetch examples for","required":false,"dataType":"String[]","allowMultiple":false,"paramType":"body"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches examples for multiple words.","responseTypeInternal":"com.wordnik.corpus.model.Example","errorResponses":[{"reason":"Invalid words to search with.","code":400}],"nickname":"getExamplesForWords","responseClass":"List[example]","httpMethod":"POST"}]},{"path":"/words.{format}/mostCommentedOn","description":"","operations":[{"parameters":[{"name":"dayInterval","description":"Number of days to consider","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches words most commented on.","responseTypeInternal":"com.wordnik.community.model.CommentSummary","errorResponses":[{"reason":"Invalid time interval.","code":400}],"nickname":"getWordsMostCommentedOn","responseClass":"List[commentSummary]","notes":"Set the dayInterval to determine the time frame.","httpMethod":"GET"}]},{"path":"/words.{format}/firstUsed/{statsType}/{object}","description":"","operations":[{"parameters":[{"name":"statsType","description":"DocumentStatsType dimension to filter by","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"object","description":"Identifier of DocumentStatsType object","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"detailed","description":"Return detailed data","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches words most commented on.","responseTypeInternal":"com.wordnik.corpus.stats.entity.DetailedWordUsage","errorResponses":[{"reason":"Invalid time interval.","code":400}],"nickname":"getWordsMostCommentedOn","responseClass":"List[detailedWordUsage]","notes":"Set the dayInterval to determine the time frame.","httpMethod":"GET"}]},{"path":"/words.{format}/wordOfTheDayList/{permalink}/invite","description":"","operations":[{"parameters":[{"name":"permalink","description":"ID of WordOfTheDayList","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Invitation to send","required":false,"dataType":"wotdListInvitation","valueTypeInternal":"com.wordnik.community.entity.WordOfTheDayListInvitation","allowMultiple":false,"paramType":"body"}],"summary":"Invites users to a WordOfTheDayList","responseTypeInternal":"ok","errorResponses":[{"reason":"User is not eligible to send invitations","code":400},{"reason":"WordOfTheDayList not found.","code":404}],"nickname":"inviteToWordOfTheDayList","responseClass":"ok","notes":"A user can invite up to 20 people in a single day. The users being invited will be checked to see if they have opted out of email communications","httpMethod":"POST"}]},{"path":"/words.{format}/wordOfTheDayLists/recent","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches recently created WordOfTheDayLists","responseTypeInternal":"com.wordnik.corpus.updated.entity.WordOfTheDayList","errorResponses":[{"reason":"No WordOfTheDayLists found.","code":404}],"nickname":"getRecentWordOfTheDayLists","responseClass":"List[wordOfTheDayList]","httpMethod":"GET"}]},{"path":"/words.{format}/wordOfTheDayList/{permalink}/{specifier}","description":"","operations":[{"parameters":[{"name":"permalink","description":"ID of WordOfTheDayList","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"specifier","description":"Specifier for the item to fetch. Either 'current' or a date.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"includeExtraHtml","description":"Include extra HTML if available","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Fetches a WordOfTheDayList by ID","responseTypeInternal":"com.wordnik.community.entity.WordOfTheDay","errorResponses":[{"reason":"Invalid id supplied","code":400},{"reason":"WordOfTheDayList not found","code":404}],"nickname":"getWordOfTheDayListItem","responseClass":"WordOfTheDay","httpMethod":"GET"}]},{"path":"/words.{format}/wordOfTheDayLists","description":"","operations":[{"parameters":[{"name":"containsWord","description":"Lists must contain a specific word","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"subscriberCount","description":"Lists must have the specified number of subscribers","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"itemCount","description":"Lists must have the specified number of items","required":true,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"includeAll","description":"Returns future WordOfTheDay items","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches an array of WordOfTheDayList basd on a criteria","responseTypeInternal":"com.wordnik.corpus.updated.entity.WordOfTheDayList","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getWordOfTheDayListsContainingWord","responseClass":"List[wordOfTheDayList]","httpMethod":"GET"}]},{"path":"/words.{format}/wordOfTheDayLists/subscriptionProcess","description":"","operations":[{"parameters":[{"name":"date","description":"Date string to fetch for.","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns whether or not a subscription process has been run.","responseTypeInternal":"String","errorResponses":[{"reason":"Invalid date format supplied.","code":400}],"nickname":"getWordOfTheDayListSubscriptionProcessStatus","responseClass":"String","notes":"Uses the current server time (day resolution) as the default date to check for, optionally a dateString can be supplied for a specific date to check for.","httpMethod":"GET"}]},{"path":"/words.{format}/wordOfTheDayList/{permalink}/subscription","description":"","operations":[{"parameters":[{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"},{"name":"permalink","description":"ID of WordOfTheDayList","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"medium","description":"Medium to subscribe with","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"description":"Username to subscribe","required":false,"dataType":"string","allowMultiple":false,"paramType":"body"}],"summary":"Subscribes a user to a WordOfTheDayList","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not authorized to subscribe","code":403},{"reason":"WordOfTheDayList or User not found","code":404}],"nickname":"subscribeToList","responseClass":"ok","httpMethod":"POST"}]},{"path":"/words.{format}/wordOfTheDayLists/{date}","description":"","operations":[{"parameters":[{"name":"date","description":"ID of WordOfTheDayList","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"includeAll","description":"Returns future WordOfTheDay items","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches WordOfTheDay objects for a specific date","responseTypeInternal":"com.wordnik.community.entity.WordOfTheDay","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"WordOfTheDayList or User not found","code":404}],"nickname":"getWordOfTheDayListsForDate","responseClass":"List[WordOfTheDay]","httpMethod":"GET"}]}],"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1","apiVersion":"4.0"}
data/lib/wordnik/resource_modules/account.rb CHANGED
@@ -57,32 +57,6 @@ module AccountMethods
57
57
  request_only ? request : request.response.body
58
58
  end
59
59
 
60
- # Logs out a user
61
- #
62
- def logout(*args)
63
- http_method = :get
64
- path = '/account/logout'
65
-
66
- # Ruby turns all key-value arguments at the end into a single hash
67
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
68
- # becomes {:limit => 10, :part_of_speech => 'verb'}
69
- last_arg = args.pop if args.last.is_a?(Hash)
70
- last_arg = args.pop if args.last.is_a?(Array)
71
- last_arg ||= {}
72
-
73
- # Look for a kwarg called :request_only, whose presence indicates
74
- # that we want the request itself back, not the response body
75
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
76
- request_only = true
77
- last_arg.delete(:request_only)
78
- end
79
-
80
- params = last_arg
81
- body ||= {}
82
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
83
- request_only ? request : request.response.body
84
- end
85
-
86
60
  # Fetches WordList objects for the logged-in user.
87
61
  #
88
62
  def get_word_lists_for_current_user(*args)
data/lib/wordnik/resource_modules/corpus.rb CHANGED
@@ -188,32 +188,6 @@ module CorpusMethods
188
188
  request_only ? request : request.response.body
189
189
  end
190
190
 
191
- # Receives info on phrases which should be captured
192
- #
193
- def get_punctuation_factor(body, *args)
194
- http_method = :post
195
- path = '/corpus/phraseFeedback'
196
-
197
- # Ruby turns all key-value arguments at the end into a single hash
198
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
199
- # becomes {:limit => 10, :part_of_speech => 'verb'}
200
- last_arg = args.pop if args.last.is_a?(Hash)
201
- last_arg = args.pop if args.last.is_a?(Array)
202
- last_arg ||= {}
203
-
204
- # Look for a kwarg called :request_only, whose presence indicates
205
- # that we want the request itself back, not the response body
206
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
207
- request_only = true
208
- last_arg.delete(:request_only)
209
- end
210
-
211
- params = last_arg
212
- body ||= {}
213
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
214
- request_only ? request : request.response.body
215
- end
216
-
217
191
  # Returns document-level stats.
218
192
  #
219
193
  def get_document_stats(*args)
@@ -266,33 +240,6 @@ module CorpusMethods
266
240
  request_only ? request : request.response.body
267
241
  end
268
242
 
269
- # Returns word relationships.
270
- #
271
- def get_dym(wordstring, *args)
272
- http_method = :get
273
- path = '/corpus/dymInternal/{wordstring}'
274
- path.sub!('{wordstring}', wordstring.to_s)
275
-
276
- # Ruby turns all key-value arguments at the end into a single hash
277
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
278
- # becomes {:limit => 10, :part_of_speech => 'verb'}
279
- last_arg = args.pop if args.last.is_a?(Hash)
280
- last_arg = args.pop if args.last.is_a?(Array)
281
- last_arg ||= {}
282
-
283
- # Look for a kwarg called :request_only, whose presence indicates
284
- # that we want the request itself back, not the response body
285
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
286
- request_only = true
287
- last_arg.delete(:request_only)
288
- end
289
-
290
- params = last_arg
291
- body ||= {}
292
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
293
- request_only ? request : request.response.body
294
- end
295
-
296
243
  # Returns recently listed words.
297
244
  #
298
245
  def get_recent_listed_words(*args)
data/lib/wordnik/resource_modules/{partners.rb → glossary.rb} RENAMED
@@ -1,41 +1,14 @@
1
1
  # HEY HACKER! THIS IS AN AUTO-GENERATED FILE.
2
2
  # So don't bother editing it. To see how it's built, take a look at the Rakefile
3
3
 
4
- module PartnersMethods
4
+ module GlossaryMethods
5
5
 
6
- # Creates a glossary for the Content Provider.
6
+ # Fetches GlossaryEntry objects for the specified Glossary. The definitions will come as per the dictionary source order. The first definition can be used to give quick overview of the word. If exact match is found, first record from the search result will be the exact match. First record will also have all the data needed to display definition, pronunciation and example usages. if it is exact match.
7
7
  #
8
- def create_glossary(contentProvider, body, *args)
9
- http_method = :post
10
- path = '/partners/{contentProvider}/glossaries'
11
- path.sub!('{contentProvider}', contentProvider.to_s)
12
-
13
- # Ruby turns all key-value arguments at the end into a single hash
14
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
15
- # becomes {:limit => 10, :part_of_speech => 'verb'}
16
- last_arg = args.pop if args.last.is_a?(Hash)
17
- last_arg = args.pop if args.last.is_a?(Array)
18
- last_arg ||= {}
19
-
20
- # Look for a kwarg called :request_only, whose presence indicates
21
- # that we want the request itself back, not the response body
22
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
23
- request_only = true
24
- last_arg.delete(:request_only)
25
- end
26
-
27
- params = last_arg
28
- body ||= {}
29
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
30
- request_only ? request : request.response.body
31
- end
32
-
33
- # Fetches glossaries for the specified Provider.
34
- #
35
- def get_glossaries(contentProvider, *args)
8
+ def get_glossary_entries(permalinkId, *args)
36
9
  http_method = :get
37
- path = '/partners/{contentProvider}/glossaries'
38
- path.sub!('{contentProvider}', contentProvider.to_s)
10
+ path = '/glossary/{permalinkId}/search'
11
+ path.sub!('{permalinkId}', permalinkId.to_s)
39
12
 
40
13
  # Ruby turns all key-value arguments at the end into a single hash
41
14
  # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
@@ -57,12 +30,11 @@ module PartnersMethods
57
30
  request_only ? request : request.response.body
58
31
  end
59
32
 
60
- # Fetches a glossary for the specified Provider.
33
+ # Publishes a Glossary.
61
34
  #
62
- def get_glossary(contentProvider, permalinkId, *args)
63
- http_method = :get
64
- path = '/partners/{contentProvider}/glossary/{permalinkId}'
65
- path.sub!('{contentProvider}', contentProvider.to_s)
35
+ def publish_glossary(permalinkId, *args)
36
+ http_method = :post
37
+ path = '/glossary/{permalinkId}/publish'
66
38
  path.sub!('{permalinkId}', permalinkId.to_s)
67
39
 
68
40
  # Ruby turns all key-value arguments at the end into a single hash
@@ -85,12 +57,11 @@ module PartnersMethods
85
57
  request_only ? request : request.response.body
86
58
  end
87
59
 
88
- # Updates a Glossaryfor the specified Provider.
60
+ # Creates a new version of a Glossary.
89
61
  #
90
- def update_glossary(contentProvider, permalinkId, body, *args)
91
- http_method = :put
92
- path = '/partners/{contentProvider}/glossary/{permalinkId}'
93
- path.sub!('{contentProvider}', contentProvider.to_s)
62
+ def create_version(permalinkId, *args)
63
+ http_method = :post
64
+ path = '/glossary/{permalinkId}/clone'
94
65
  path.sub!('{permalinkId}', permalinkId.to_s)
95
66
 
96
67
  # Ruby turns all key-value arguments at the end into a single hash
@@ -113,12 +84,11 @@ module PartnersMethods
113
84
  request_only ? request : request.response.body
114
85
  end
115
86
 
116
- # Deletes a single Glossary.
87
+ # Adds GlossaryEntry objects for the specified Glossary.
117
88
  #
118
- def delete_glossary(contentProvider, permalinkId, *args)
119
- http_method = :delete
120
- path = '/partners/{contentProvider}/glossary/{permalinkId}'
121
- path.sub!('{contentProvider}', contentProvider.to_s)
89
+ def add_glossary_entry(permalinkId, body, *args)
90
+ http_method = :post
91
+ path = '/glossary/{permalinkId}/entries'
122
92
  path.sub!('{permalinkId}', permalinkId.to_s)
123
93
 
124
94
  # Ruby turns all key-value arguments at the end into a single hash
@@ -141,13 +111,13 @@ module PartnersMethods
141
111
  request_only ? request : request.response.body
142
112
  end
143
113
 
144
- # Fetches GlossaryEntry objects for the specified Glossary.
114
+ # Removes a GlossaryEntry object from the specified Glossary.
145
115
  #
146
- def get_glossary_entries(contentProvider, permalinkId, *args)
147
- http_method = :get
148
- path = '/partners/{contentProvider}/glossary/{permalinkId}/entries'
149
- path.sub!('{contentProvider}', contentProvider.to_s)
116
+ def delete_glossary_entry(permalinkId, word, *args)
117
+ http_method = :delete
118
+ path = '/glossary/{permalinkId}/entries/{word}'
150
119
  path.sub!('{permalinkId}', permalinkId.to_s)
120
+ path.sub!('{word}', word.to_s)
151
121
 
152
122
  # Ruby turns all key-value arguments at the end into a single hash
153
123
  # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
@@ -169,12 +139,11 @@ module PartnersMethods
169
139
  request_only ? request : request.response.body
170
140
  end
171
141
 
172
- # Adds GlossaryEntry objects for the specified Glossary.
142
+ # Removes a GlossaryEntry object from the specified Glossary.
173
143
  #
174
- def add_glossary_entry(contentProvider, permalinkId, body, *args)
144
+ def delete_glossary_entries(permalinkId, body, *args)
175
145
  http_method = :post
176
- path = '/partners/{contentProvider}/glossary/{permalinkId}/entries'
177
- path.sub!('{contentProvider}', contentProvider.to_s)
146
+ path = '/glossary/{permalinkId}/deleteEntries'
178
147
  path.sub!('{permalinkId}', permalinkId.to_s)
179
148
 
180
149
  # Ruby turns all key-value arguments at the end into a single hash
@@ -197,12 +166,11 @@ module PartnersMethods
197
166
  request_only ? request : request.response.body
198
167
  end
199
168
 
200
- # Publishes a Glossary.
169
+ # Fetches a random GlossaryEntry object for the specified Glossary.
201
170
  #
202
- def publish_glossary(contentProvider, permalinkId, *args)
203
- http_method = :post
204
- path = '/partners/{contentProvider}/glossary/{permalinkId}/publish'
205
- path.sub!('{contentProvider}', contentProvider.to_s)
171
+ def get_random_glossary_entry(permalinkId, *args)
172
+ http_method = :get
173
+ path = '/glossary/{permalinkId}/randomEntry'
206
174
  path.sub!('{permalinkId}', permalinkId.to_s)
207
175
 
208
176
  # Ruby turns all key-value arguments at the end into a single hash
@@ -225,12 +193,11 @@ module PartnersMethods
225
193
  request_only ? request : request.response.body
226
194
  end
227
195
 
228
- # Creates a new version of a Glossary.
196
+ # Fetches the GlossaryEntry object for the specified word in the Glossary.
229
197
  #
230
- def create_version(contentProvider, permalinkId, *args)
231
- http_method = :post
232
- path = '/partners/{contentProvider}/glossary/{permalinkId}/clone'
233
- path.sub!('{contentProvider}', contentProvider.to_s)
198
+ def get_glossary_entry(permalinkId, *args)
199
+ http_method = :get
200
+ path = '/glossary/{permalinkId}/entry'
234
201
  path.sub!('{permalinkId}', permalinkId.to_s)
235
202
 
236
203
  # Ruby turns all key-value arguments at the end into a single hash
@@ -253,12 +220,11 @@ module PartnersMethods
253
220
  request_only ? request : request.response.body
254
221
  end
255
222
 
256
- # Removes a GlossaryEntry object from the specified Glossary.
223
+ # Fetches examples for the Glossary entry
257
224
  #
258
- def delete_glossary_entry(contentProvider, permalinkId, word, *args)
259
- http_method = :delete
260
- path = '/partners/{contentProvider}/glossary/{permalinkId}/entries/{word}'
261
- path.sub!('{contentProvider}', contentProvider.to_s)
225
+ def get_glossary_entry_examples(permalinkId, word, *args)
226
+ http_method = :get
227
+ path = '/glossary/{permalinkId}/{word}/examples'
262
228
  path.sub!('{permalinkId}', permalinkId.to_s)
263
229
  path.sub!('{word}', word.to_s)
264
230
 
@@ -282,13 +248,14 @@ module PartnersMethods
282
248
  request_only ? request : request.response.body
283
249
  end
284
250
 
285
- # Removes a GlossaryEntry object from the specified Glossary.
251
+ # Fetches audio pronunciation for the given id.
286
252
  #
287
- def delete_glossary_entries(contentProvider, permalinkId, body, *args)
288
- http_method = :post
289
- path = '/partners/{contentProvider}/glossary/{permalinkId}/deleteEntries'
290
- path.sub!('{contentProvider}', contentProvider.to_s)
253
+ def get_audio_file(permalinkId, word, pronId, *args)
254
+ http_method = :get
255
+ path = '/glossary/{permalinkId}/{word}/pronunciation/{pronId}'
291
256
  path.sub!('{permalinkId}', permalinkId.to_s)
257
+ path.sub!('{word}', word.to_s)
258
+ path.sub!('{pronId}', pronId.to_s)
292
259
 
293
260
  # Ruby turns all key-value arguments at the end into a single hash
294
261
  # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
data/lib/wordnik/resource_modules/system.rb CHANGED
@@ -29,11 +29,12 @@ module SystemMethods
29
29
  request_only ? request : request.response.body
30
30
  end
31
31
 
32
- # Returns system-wide statistics for the platform.
32
+ # Returns weighted terms related to the input word
33
33
  #
34
- def get_stats(*args)
34
+ def get_related_words(word, *args)
35
35
  http_method = :get
36
- path = '/system/stats'
36
+ path = '/system/{word}/related'
37
+ path.sub!('{word}', word.to_s)
37
38
 
38
39
  # Ruby turns all key-value arguments at the end into a single hash
39
40
  # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
@@ -55,11 +56,11 @@ module SystemMethods
55
56
  request_only ? request : request.response.body
56
57
  end
57
58
 
58
- # Returns weighted terms related to the input word
59
+ # Returns a word with attributes
59
60
  #
60
61
  def get_related_words(word, *args)
61
62
  http_method = :get
62
- path = '/system/{word}/related'
63
+ path = '/system/{word}'
63
64
  path.sub!('{word}', word.to_s)
64
65
 
65
66
  # Ruby turns all key-value arguments at the end into a single hash
@@ -82,12 +83,11 @@ module SystemMethods
82
83
  request_only ? request : request.response.body
83
84
  end
84
85
 
85
- # Returns a word with attributes
86
+ # Returns a graph response for the supplied terms
86
87
  #
87
- def get_related_words(word, *args)
88
+ def get_word_by_id(*args)
88
89
  http_method = :get
89
- path = '/system/{word}'
90
- path.sub!('{word}', word.to_s)
90
+ path = '/system/graph'
91
91
 
92
92
  # Ruby turns all key-value arguments at the end into a single hash
93
93
  # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
@@ -109,11 +109,11 @@ module SystemMethods
109
109
  request_only ? request : request.response.body
110
110
  end
111
111
 
112
- # Returns a graph response for the supplied terms
112
+ # Gets an Audio File ID for recording.
113
113
  #
114
- def get_word_by_id(*args)
114
+ def get_audio_record_id(*args)
115
115
  http_method = :get
116
- path = '/system/graph'
116
+ path = '/system/audioRecordId'
117
117
 
118
118
  # Ruby turns all key-value arguments at the end into a single hash
119
119
  # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
@@ -135,11 +135,13 @@ module SystemMethods
135
135
  request_only ? request : request.response.body
136
136
  end
137
137
 
138
- # Gets an Audio File ID for recording.
138
+ # Sets duration of an Audio File
139
139
  #
140
- def get_audio_record_id(*args)
141
- http_method = :get
142
- path = '/system/audioRecordId'
140
+ def set_audio_duration(audioFileId, duration, *args)
141
+ http_method = :post
142
+ path = '/system/audioDuration'
143
+ path.sub!('{audioFileId}', audioFileId.to_s)
144
+ path.sub!('{duration}', duration.to_s)
143
145
 
144
146
  # Ruby turns all key-value arguments at the end into a single hash
145
147
  # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
@@ -161,13 +163,11 @@ module SystemMethods
161
163
  request_only ? request : request.response.body
162
164
  end
163
165
 
164
- # Sets duration of an Audio File
166
+ # Returns system-wide statistics for the platform.
165
167
  #
166
- def set_audio_duration(audioFileId, duration, *args)
167
- http_method = :post
168
- path = '/system/audioDuration'
169
- path.sub!('{audioFileId}', audioFileId.to_s)
170
- path.sub!('{duration}', duration.to_s)
168
+ def get_stats(*args)
169
+ http_method = :get
170
+ path = '/system/stats'
171
171
 
172
172
  # Ruby turns all key-value arguments at the end into a single hash
173
173
  # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')