Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Synced with latest swagger resources; bumped version to 4.07

  • Loading branch information...
commit 07a20de8c1ffef38604e128dbc2bb2818658eeff 1 parent 175d975
@zeke zeke authored
Showing with 54 additions and 683 deletions.
  1. +1 −1  api_docs/account.json
  2. +1 −1  api_docs/analytics.json
  3. +1 −1  api_docs/corpus.json
  4. +1 −1  api_docs/document.json
  5. +1 −1  api_docs/feeds.json
  6. +0 −1  api_docs/glossary.json
  7. +1 −1  api_docs/health.json
  8. +1 −0  api_docs/partner.json
  9. +1 −0  api_docs/partners.json
  10. +1 −1  api_docs/suggest.json
  11. +1 −1  api_docs/system.json
  12. +1 −1  api_docs/tag.json
  13. +1 −1  api_docs/user.json
  14. +1 −1  api_docs/users.json
  15. +1 −1  api_docs/word.json
  16. +1 −1  api_docs/wordList.json
  17. +1 −1  api_docs/wordLists.json
  18. +1 −1  api_docs/words.json
  19. +0 −26 lib/wordnik/resource_modules/account.rb
  20. +3 −56 lib/wordnik/resource_modules/corpus.rb
  21. +0 −278 lib/wordnik/resource_modules/glossary.rb
  22. +0 −108 lib/wordnik/resource_modules/system.rb
  23. +26 −0 lib/wordnik/resource_modules/users.rb
  24. +0 −137 lib/wordnik/resource_modules/word.rb
  25. +0 −28 lib/wordnik/resource_modules/word_lists.rb
  26. +6 −32 lib/wordnik/resource_modules/words.rb
  27. +1 −1  lib/wordnik/version.rb
  28. +1 −1  spec/resource_spec.rb
View
2  api_docs/account.json
@@ -1 +1 @@
-{"resourcePath":"/account","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":"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"}]}],"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","required":true},"username":{"type":"string"},"permalink":{"type":"string"},"lastActivityAt":{"type":"Date"},"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"},"String":{"properties":{"name":{"type":"string"},"ordinal":{"type":"int"}},"id":"string"},"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"}},"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1-SNAPSHOT","apiVersion":"4.0"}
+{"resourcePath":"/account","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","httpMethod":"GET","responseTypeInternal":"com.wordnik.security.model.AuthenticationToken","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","allowMultiple":false,"paramType":"path"},{"description":"The user's password","required":true,"dataType":"string","allowMultiple":false,"paramType":"body"}],"summary":"Authenticates a user","httpMethod":"POST","responseTypeInternal":"com.wordnik.security.model.AuthenticationToken","errorResponses":[{"reason":"Account not available.","code":403},{"reason":"User not found.","code":404}],"nickname":"authenticatePost","responseClass":"AuthenticationToken"}]},{"path":"/account.{format}/forgotPassword/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Authenticates a User","httpMethod":"GET","responseTypeInternal":"String","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","allowMultiple":false,"paramType":"path"}],"summary":"Fetches a User by code","httpMethod":"GET","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"}]},{"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.","httpMethod":"POST","responseTypeInternal":"com.wordnik.resource.ApiResponse","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","allowMultiple":false,"paramType":"header"}],"summary":"Regenerates an API Token. Currently not supported or tested.","httpMethod":"GET","responseTypeInternal":"ok","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":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.","httpMethod":"GET","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"}]},{"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","httpMethod":"POST","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."}]},{"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","httpMethod":"GET","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."}]},{"path":"/account.{format}/activate","description":"","operations":[{"parameters":[{"description":"Activation Code","required":true,"dataType":"string","allowMultiple":false,"paramType":"body"}],"summary":"Activates an account.","httpMethod":"POST","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"}]},{"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","httpMethod":"GET","responseTypeInternal":"com.wordnik.resource.ApiResponse","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","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","httpMethod":"GET","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."}]},{"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","httpMethod":"GET","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."}]},{"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","httpMethod":"GET","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."}]},{"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.","httpMethod":"GET","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."}]}],"apiVersion":"4.0","swaggerVersion":"1.1-SNAPSHOT","basePath":"http://api.wordnik.com/v4","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"},"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"}}}
View
2  api_docs/analytics.json
@@ -1 +1 @@
-{"resourcePath":"/analytics","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"}]}],"models":{"WordHitsCollection":{"properties":{"com$wordnik$analytics$model$WordHitsCollection$$wordHitsList":{"type":"array","items":{"$ref":"wordHits"}},"wordHitsList":{"type":"array","items":{"$ref":"wordHits"}}},"id":"wordHitsCollection"},"WordHits":{"properties":{"count":{"type":"int"},"timeSeconds":{"type":"long"},"month":{"type":"int"},"word":{"type":"string"},"year":{"type":"int"},"hour":{"type":"int"},"day":{"type":"int","required":true},"week":{"type":"int"}},"id":"wordHits"}},"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1-SNAPSHOT","apiVersion":"4.0"}
+{"resourcePath":"/analytics","apis":[{"path":"/analytics.{format}/top","description":"","operations":[{"parameters":[{"name":"namespace","defaultValue":"site.word","description":"The namespace for which to return hits","required":false,"allowableValues":{"values":["site.word"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"year","description":"Year","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"month","description":"Month","required":false,"allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"week","description":"Week","required":false,"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"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"day","description":"Day","required":false,"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"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"hour","description":"Hour","required":false,"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"},"dataType":"string","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","httpMethod":"GET","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)."}]},{"path":"/analytics.{format}/trending","description":"","operations":[{"parameters":[{"name":"namespace","defaultValue":"site.word","description":"The namespace for which to return hits","required":false,"allowableValues":{"values":["site.word"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"year","description":"Year","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"month","description":"Month","required":false,"allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"week","description":"Week","required":false,"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"},"dataType":"string","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","httpMethod":"GET","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)."}]},{"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,"allowableValues":{"values":["site.word"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"year","description":"Year","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"month","description":"Month","required":false,"allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"week","description":"Week","required":false,"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"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"day","description":"Day","required":false,"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"},"dataType":"string","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","httpMethod":"GET","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)"}]}],"apiVersion":"4.0","swaggerVersion":"1.1-SNAPSHOT","basePath":"http://api.wordnik.com/v4","models":{"WordHitsCollection":{"properties":{"com$wordnik$analytics$model$WordHitsCollection$$wordHitsList":{"type":"array","items":{"$ref":"wordHits"}},"wordHitsList":{"type":"array","items":{"$ref":"wordHits"}}},"id":"wordHitsCollection"},"WordHits":{"properties":{"count":{"type":"int"},"timeSeconds":{"type":"long"},"month":{"type":"int"},"word":{"type":"string"},"year":{"type":"int"},"hour":{"type":"int"},"day":{"type":"int","required":true},"week":{"type":"int"}},"id":"wordHits"}}}
View
2  api_docs/corpus.json
@@ -1 +1 @@
-{"resourcePath":"/corpus","apis":[{"path":"/corpus.{format}/recentViews","description":"","operations":[{"parameters":[{"name":"limit","defaultValue":"5","description":"Limits results","required":false,"dataType":"string","allowableValues":{"max":10000.0,"min":1.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"humanOnly","defaultValue":"false","description":"Returns results only from human visitors","required":false,"dataType":"string","allowableValues":{"values":["false","true"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"sortByFrequency","defaultValue":"false","description":"Sorts results by frequency","required":false,"dataType":"string","allowableValues":{"values":["false","true"],"valueType":"LIST"},"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}/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}/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}/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}/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}/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":"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"}]}],"models":{"Long":{"properties":{"value":{"type":"long"}},"id":"long"},"ContextualLookupResponse":{"properties":{"lookupExamples":{"type":"array","items":{"$ref":"lookupExample"}},"wordstring":{"type":"string"}},"id":"contextualLookupResponse"},"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"},"WordResult":{"properties":{"count":{"type":"long"},"wordstring":{"type":"string"}},"id":"wordResult"},"WordFrequency":{"properties":{"count":{"type":"long"},"wordstring":{"type":"string"}},"id":"wordFrequency"},"Sentence":{"properties":{"hasScoredWords":{"type":"boolean"},"id":{"type":"long"},"scoredWords":{"type":"array","items":{"$ref":"scoredWord"}},"display":{"type":"string"},"rating":{"type":"int"},"documentMetadataId":{"type":"long"}},"id":"sentence"},"WordListingHistory":{"properties":{"listingCount":{"type":"long"},"wordString":{"type":"string"}},"id":"wordListingHistory"},"BasicWordUsage":{"properties":{"sentenceId":{"type":"long"},"year":{"type":"integer"},"wordstring":{"type":"string"},"documentId":{"type":"long"}},"id":"basicWordUsage"},"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"},"WordView":{"properties":{"id":{"type":"long","required":true},"callingClass":{"type":"string"},"environment":{"type":"string"},"sessionId":{"type":"string"},"createdAt":{"type":"Date"},"callingMethod":{"type":"string"},"userId":{"type":"long"},"serverIp":{"type":"string"},"word":{"type":"string"},"userGuid":{"type":"string"}},"id":"wordView"},"ScoredWord":{"properties":{"position":{"type":"int"},"id":{"type":"long"},"docTermCount":{"type":"int"},"lemma":{"type":"string"},"wordType":{"type":"string"},"score":{"type":"float"},"sentenceId":{"type":"long"},"word":{"type":"string"},"stopword":{"type":"boolean"},"baseWordScore":{"type":"double"},"partOfSpeech":{"type":"string"}},"id":"scoredWord"},"LookupExample":{"properties":{"sourceName":{"type":"string"},"uRL":{"type":"string"},"exampleString":{"type":"string"}},"id":"lookupExample"}},"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1-SNAPSHOT","apiVersion":"4.0"}
+{"resourcePath":"/corpus","apis":[{"path":"/corpus.{format}/recentViews","description":"","operations":[{"parameters":[{"name":"limit","defaultValue":"5","description":"Limits results","required":false,"allowableValues":{"max":10000.0,"min":1.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"humanOnly","defaultValue":"false","description":"Returns results only from human visitors","required":false,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sortByFrequency","defaultValue":"false","description":"Sorts results by frequency","required":false,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches recent views from the website","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.model.WordResult","nickname":"getRecentViews","responseClass":"List[wordResult]"}]},{"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","httpMethod":"GET","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]"}]},{"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","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.stats.entity.DictionaryStats","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","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","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.stats.entity.BasicWordUsage","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","responseTypeInternal":"com.wordnik.system.model.LongResult","nickname":"getTotalDocumentCount","responseClass":"long"}]},{"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.","httpMethod":"POST","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."}]},{"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","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.stats.entity.WordFrequency","errorResponses":[{"reason":"No corpus frequency data available.","code":400}],"nickname":"getCorpusWordFrequencies","responseClass":"List[wordFrequency]"}]},{"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.","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.stats.entity.BasicDocumentStats","errorResponses":[{"reason":"Invalid stats type supplied.","code":400}],"nickname":"getDocumentStats","responseClass":"basicDocumentStats"}]},{"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.","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.WordListingHistory","nickname":"getRecentListedWords","responseClass":"List[wordListingHistory]"}]},{"path":"/corpus.{format}/phraseFeedback","description":"","operations":[{"parameters":[{"description":"Phrase to store.","required":false,"dataType":"string","allowMultiple":false,"paramType":"body"}],"summary":"Receives info on phrases which should be captured","httpMethod":"POST","responseTypeInternal":"com.wordnik.corpus.entity.Sentence","errorResponses":[{"reason":"Invalid phrase supplied.","code":400}],"nickname":"getPunctuationFactor","responseClass":"List[sentence]"}]},{"path":"/corpus.{format}/totalWordCount","description":"","operations":[{"summary":"Returns the count of tokens in the Corpus.","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.LongResult","nickname":"getTotalTokensCount","responseClass":"long"}]},{"path":"/corpus.{format}/sentenceCount","description":"","operations":[{"summary":"Returns the count of sentences in the Corpus.","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.LongResult","nickname":"getTotalSentencesCount","responseClass":"long"}]}],"apiVersion":"4.0","swaggerVersion":"1.1-SNAPSHOT","basePath":"http://api.wordnik.com/v4","models":{"Long":{"properties":{"value":{"type":"long"}},"id":"long"},"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"},"WordResult":{"properties":{"count":{"type":"long"},"wordstring":{"type":"string"}},"id":"wordResult"},"WordFrequency":{"properties":{"count":{"type":"long"},"wordstring":{"type":"string"}},"id":"wordFrequency"},"Sentence":{"properties":{"hasScoredWords":{"type":"boolean"},"id":{"type":"long"},"scoredWords":{"type":"array","items":{"$ref":"scoredWord"}},"display":{"type":"string"},"rating":{"type":"int"},"documentMetadataId":{"type":"long"}},"id":"sentence"},"WordListingHistory":{"properties":{"listingCount":{"type":"long"},"wordString":{"type":"string"}},"id":"wordListingHistory"},"BasicWordUsage":{"properties":{"sentenceId":{"type":"long"},"year":{"type":"integer"},"wordstring":{"type":"string"},"documentId":{"type":"long"}},"id":"basicWordUsage"},"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"},"ScoredWord":{"properties":{"position":{"type":"int"},"id":{"type":"long"},"docTermCount":{"type":"int"},"lemma":{"type":"string"},"wordType":{"type":"string"},"score":{"type":"float"},"sentenceId":{"type":"long"},"word":{"type":"string"},"stopword":{"type":"boolean"},"baseWordScore":{"type":"double"},"partOfSpeech":{"type":"string"}},"id":"scoredWord"}}}
View
2  api_docs/document.json
@@ -1 +1 @@
-{"resourcePath":"/document","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"}]}],"models":{"DocumentMetadata":{"properties":{"tags":{"type":"array","items":{"type":"string"}},"yearType":{"type":"yearType"},"expirationDate":{"type":"Date"},"extendedMetadata":{"type":"extendedMetadata"},"stats":{"type":"basicDocumentStats"},"provider":{"type":"contentProvider"},"contentType":{"type":"contentType"},"sourceUrl":{"type":"string"},"date":{"type":"Date"},"medium":{"type":"documentMedium"},"guid":{"type":"string"},"id":{"type":"long"},"authors":{"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":{"hasSentences":{"type":"boolean"},"bigramFrequencies":{"type":"array","items":{"$ref":"biGramFrequency"}},"allScoredWords":{"type":"array","items":{"$ref":"scoredWord"}},"sentences":{"type":"array","items":{"$ref":"sentence"}},"wordFrequencies":{"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"},"docTermCount":{"type":"int"},"lemma":{"type":"string"},"wordType":{"type":"string"},"score":{"type":"float"},"sentenceId":{"type":"long"},"word":{"type":"string"},"stopword":{"type":"boolean"},"baseWordScore":{"type":"double"},"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":{"hasScoredWords":{"type":"boolean"},"id":{"type":"long"},"scoredWords":{"type":"array","items":{"$ref":"scoredWord"}},"display":{"type":"string"},"rating":{"type":"int"},"documentMetadataId":{"type":"long"}},"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"}},"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1-SNAPSHOT","apiVersion":"4.0"}
+{"resourcePath":"/document","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.","httpMethod":"GET","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]"}]},{"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.","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.document.entity.DocumentModel","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":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.","httpMethod":"GET","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]"}]},{"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.","httpMethod":"GET","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"}]},{"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.","httpMethod":"GET","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"}]}],"apiVersion":"4.0","swaggerVersion":"1.1-SNAPSHOT","basePath":"http://api.wordnik.com/v4","models":{"DocumentMetadata":{"properties":{"tags":{"type":"array","items":{"type":"string"}},"yearType":{"type":"yearType"},"expirationDate":{"type":"Date"},"extendedMetadata":{"type":"extendedMetadata"},"stats":{"type":"basicDocumentStats"},"provider":{"type":"contentProvider"},"contentType":{"type":"contentType"},"sourceUrl":{"type":"string"},"date":{"type":"Date"},"medium":{"type":"documentMedium"},"guid":{"type":"string"},"id":{"type":"long"},"authors":{"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":{"hasSentences":{"type":"boolean"},"bigramFrequencies":{"type":"array","items":{"$ref":"biGramFrequency"}},"allScoredWords":{"type":"array","items":{"$ref":"scoredWord"}},"sentences":{"type":"array","items":{"$ref":"sentence"}},"wordFrequencies":{"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"},"docTermCount":{"type":"int"},"lemma":{"type":"string"},"wordType":{"type":"string"},"score":{"type":"float"},"sentenceId":{"type":"long"},"word":{"type":"string"},"stopword":{"type":"boolean"},"baseWordScore":{"type":"double"},"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":{"hasScoredWords":{"type":"boolean"},"id":{"type":"long"},"scoredWords":{"type":"array","items":{"$ref":"scoredWord"}},"display":{"type":"string"},"rating":{"type":"int"},"documentMetadataId":{"type":"long"}},"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"}}}
View
2  api_docs/feeds.json
@@ -1 +1 @@
-{"resourcePath":"/feeds","apis":[{"path":"/feeds.{format}/pronunciations","description":"","operations":[{"parameters":[{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns recent pronunciations","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","nickname":"getRecentPronunciations","responseClass":"rss","httpMethod":"GET"}]},{"path":"/feeds.{format}/wordOfTheDay","description":"","operations":[{"parameters":[{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns the word-of-the-day","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","errorResponses":[{"reason":"No word of the day available","code":404}],"nickname":"getWordOfTheDay","responseClass":"rss","httpMethod":"GET"}]},{"path":"/feeds.{format}/people/{username}/commentsBy","description":"","operations":[{"parameters":[{"name":"username","description":"username","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns comments made by the specified user","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","errorResponses":[{"reason":"Invalid username supplied.","code":400}],"nickname":"getCommentsByUser","responseClass":"rss","httpMethod":"GET"}]},{"path":"/feeds.{format}/people/{username}/commentsOn","description":"","operations":[{"parameters":[{"name":"username","description":"username","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns comments made on the specified user","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","errorResponses":[{"reason":"Invalid username supplied.","code":400}],"nickname":"getCommentsOnUser","responseClass":"rss","httpMethod":"GET"}]},{"path":"/feeds.{format}/favorites","description":"","operations":[{"parameters":[{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns recently favorited words","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","nickname":"getRecentFavorites","responseClass":"rss","httpMethod":"GET"}]},{"path":"/feeds.{format}/people/{username}/lists","description":"","operations":[{"parameters":[{"name":"username","description":"username","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns lists for the specified user","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","errorResponses":[{"reason":"Invalid username supplied.","code":400}],"nickname":"getUserLists","responseClass":"rss","httpMethod":"GET"}]},{"path":"/feeds.{format}/people/{username}/favorites","description":"","operations":[{"parameters":[{"name":"username","description":"username","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns favorites for the specified user","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","errorResponses":[{"reason":"Invalid username supplied.","code":400}],"nickname":"getUserFavorites","responseClass":"rss","httpMethod":"GET"}]},{"path":"/feeds.{format}/lookups","description":"","operations":[{"parameters":[{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns recent lookups","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","nickname":"getRecentLookups","responseClass":"rss","httpMethod":"GET"}]},{"path":"/feeds.{format}/lists","description":"","operations":[{"parameters":[{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns recent lists","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","nickname":"getRecentUserLists","responseClass":"rss","httpMethod":"GET"}]},{"path":"/feeds.{format}/lists/{permalinkId}/comments","description":"","operations":[{"parameters":[{"name":"permalinkId","description":"permalinkId","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns comments on the specified list","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","nickname":"getUserListComments","responseClass":"rss","httpMethod":"GET"}]},{"path":"/feeds.{format}/lists/{permalinkId}","description":"","operations":[{"parameters":[{"name":"permalinkId","description":"permalinkId","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns the specified wordList","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","nickname":"getUserList","responseClass":"rss","httpMethod":"GET"}]}],"models":{"Rss":{"properties":{"channel":{"type":"Channel"}},"id":"rss"},"Channel":{"properties":{"title":{"type":"string"},"description":{"type":"string"},"link":{"type":"string"},"item":{"type":"array","items":{"$ref":"Item"}},"generator":{"type":"string"}},"id":"Channel"},"Item":{"properties":{"guid":{"type":"tony"},"pubDate":{"type":"Date"},"title":{"type":"string"},"description":{"type":"string"},"link":{"type":"string"}},"id":"Item"}},"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1-SNAPSHOT","apiVersion":"4.0"}
+{"resourcePath":"/feeds","apis":[{"path":"/feeds.{format}/pronunciations","description":"","operations":[{"parameters":[{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns recent pronunciations","httpMethod":"GET","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","nickname":"getRecentPronunciations","responseClass":"rss"}]},{"path":"/feeds.{format}/wordOfTheDay","description":"","operations":[{"parameters":[{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns the word-of-the-day","httpMethod":"GET","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","errorResponses":[{"reason":"No word of the day available","code":404}],"nickname":"getWordOfTheDay","responseClass":"rss"}]},{"path":"/feeds.{format}/people/{username}/commentsBy","description":"","operations":[{"parameters":[{"name":"username","description":"username","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns comments made by the specified user","httpMethod":"GET","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","errorResponses":[{"reason":"Invalid username supplied.","code":400}],"nickname":"getCommentsByUser","responseClass":"rss"}]},{"path":"/feeds.{format}/people/{username}/commentsOn","description":"","operations":[{"parameters":[{"name":"username","description":"username","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns comments made on the specified user","httpMethod":"GET","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","errorResponses":[{"reason":"Invalid username supplied.","code":400}],"nickname":"getCommentsOnUser","responseClass":"rss"}]},{"path":"/feeds.{format}/favorites","description":"","operations":[{"parameters":[{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns recently favorited words","httpMethod":"GET","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","nickname":"getRecentFavorites","responseClass":"rss"}]},{"path":"/feeds.{format}/people/{username}/lists","description":"","operations":[{"parameters":[{"name":"username","description":"username","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns lists for the specified user","httpMethod":"GET","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","errorResponses":[{"reason":"Invalid username supplied.","code":400}],"nickname":"getUserLists","responseClass":"rss"}]},{"path":"/feeds.{format}/people/{username}/favorites","description":"","operations":[{"parameters":[{"name":"username","description":"username","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns favorites for the specified user","httpMethod":"GET","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","errorResponses":[{"reason":"Invalid username supplied.","code":400}],"nickname":"getUserFavorites","responseClass":"rss"}]},{"path":"/feeds.{format}/lookups","description":"","operations":[{"parameters":[{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns recent lookups","httpMethod":"GET","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","nickname":"getRecentLookups","responseClass":"rss"}]},{"path":"/feeds.{format}/lists","description":"","operations":[{"parameters":[{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns recent lists","httpMethod":"GET","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","nickname":"getRecentUserLists","responseClass":"rss"}]},{"path":"/feeds.{format}/lists/{permalinkId}/comments","description":"","operations":[{"parameters":[{"name":"permalinkId","description":"permalinkId","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"limit","description":"limit","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns comments on the specified list","httpMethod":"GET","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","nickname":"getUserListComments","responseClass":"rss"}]},{"path":"/feeds.{format}/lists/{permalinkId}","description":"","operations":[{"parameters":[{"name":"permalinkId","description":"permalinkId","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns the specified wordList","httpMethod":"GET","responseTypeInternal":"com.wordnik.resource.model.RSSFeed","nickname":"getUserList","responseClass":"rss"}]}],"apiVersion":"4.0","swaggerVersion":"1.1-SNAPSHOT","basePath":"http://api.wordnik.com/v4","models":{"Rss":{"properties":{"channel":{"type":"Channel"}},"id":"rss"},"Channel":{"properties":{"title":{"type":"string"},"description":{"type":"string"},"link":{"type":"string"},"item":{"type":"array","items":{"$ref":"Item"}},"generator":{"type":"string"}},"id":"Channel"},"Item":{"properties":{"guid":{"type":"tony"},"pubDate":{"type":"Date"},"title":{"type":"string"},"description":{"type":"string"},"link":{"type":"string"}},"id":"Item"}}}
View
1  api_docs/glossary.json
@@ -1 +0,0 @@
-{"resourcePath":"/glossary","apis":[{"path":"/glossary.{format}/{permalinkId}","description":"","operations":[{"parameters":[{"name":"permalinkId","description":"Permalink of Glossary to fetch.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"version","description":"Version to fetch","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches a glossary.","responseTypeInternal":"com.wordnik.community.entity.Glossary","errorResponses":[{"reason":"Invalid Permalink ID supplied.","code":404}],"nickname":"getGlossary","responseClass":"Glossary","httpMethod":"GET"},{"parameters":[{"name":"permalinkId","description":"Permalink of Glossary to fetch.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"version","description":"Version to fetch","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"description":"Updated Glossary","required":false,"dataType":"Glossary","valueTypeInternal":"Glossary","allowMultiple":false,"paramType":"body"}],"summary":"Updates a Glossary.","responseTypeInternal":"com.wordnik.community.entity.Glossary","errorResponses":[{"reason":"Invalid Permalink ID supplied.","code":404}],"nickname":"updateGlossary","responseClass":"Glossary","httpMethod":"PUT"},{"parameters":[{"name":"permalinkId","description":"Permalink of Glossary to delete.","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"version","description":"Version to delete","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Deletes the Glossary.","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid Permalink ID supplied.","code":404}],"nickname":"deleteGlossary","responseClass":"ok","httpMethod":"DELETE"}]},{"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":"Array[com.wordnik.community.entity.GlossaryEntry]","valueTypeInternal":"com.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}/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/{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":"Array[com.wordnik.resource.StringValue]","valueTypeInternal":"com.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}/entries/{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":"List[example]","httpMethod":"GET"}]}],"models":{"GlossaryStatus":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"glossaryStatus"},"GlossaryEntry":{"properties":{"audioFiles":{"type":"array","items":{"$ref":"audioFile"}},"definitions":{"type":"array","items":{"$ref":"definition"}},"glossaryId":{"type":"long"},"examples":{"type":"array","items":{"$ref":"example"}},"wordstring":{"type":"string"}},"id":"GlossaryEntry"},"Glossary":{"properties":{"status":{"type":"glossaryStatus"},"permalinkId":{"type":"string"},"partnerId":{"type":"string"},"totalEntries":{"type":"int"},"version":{"type":"double"},"id":{"type":"long"},"updatedAt":{"type":"Date"},"draft":{"type":"boolean"},"archived":{"type":"boolean"},"description":{"type":"string"},"createdAt":{"type":"Date"},"name":{"type":"string"},"publishedDate":{"type":"Date"},"published":{"type":"boolean"}},"id":"Glossary"},"Example":{"properties":{"id":{"type":"long"},"exampleId":{"type":"long"},"title":{"type":"string"},"text":{"type":"string"},"score":{"type":"scoredWord"},"sentence":{"type":"sentence"},"word":{"type":"string"},"provider":{"type":"contentProvider"},"year":{"type":"integer"},"rating":{"type":"float"},"documentId":{"type":"long"},"url":{"type":"string"}},"id":"example"},"Sentence":{"properties":{"hasScoredWords":{"type":"boolean"},"id":{"type":"long"},"scoredWords":{"type":"array","items":{"$ref":"scoredWord"}},"display":{"type":"string"},"rating":{"type":"int"},"documentMetadataId":{"type":"long"}},"id":"sentence"},"ContentProvider":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"contentProvider"},"AudioFile":{"properties":{"attributionUrl":{"type":"string"},"commentCount":{"type":"int"},"voteCount":{"type":"integer"},"fileUrl":{"type":"string"},"audioType":{"type":"string"},"id":{"type":"long","required":true},"duration":{"type":"double"},"attributionText":{"type":"string"},"createdBy":{"type":"string"},"description":{"type":"string"},"createdAt":{"type":"Date"},"voteWeightedAverage":{"type":"float"},"voteAverage":{"type":"float"},"word":{"type":"string"}},"id":"audioFile"},"StringValue":{"properties":{"word":{"type":"string"}},"id":"StringValue"},"ScoredWord":{"properties":{"position":{"type":"int"},"id":{"type":"long"},"docTermCount":{"type":"int"},"lemma":{"type":"string"},"wordType":{"type":"string"},"score":{"type":"float"},"sentenceId":{"type":"long"},"word":{"type":"string"},"stopword":{"type":"boolean"},"baseWordScore":{"type":"double"},"partOfSpeech":{"type":"string"}},"id":"scoredWord"},"Definition":{"properties":{"extendedText":{"type":"string"},"text":{"type":"string"},"sourceDictionary":{"type":"string"},"citations":{"type":"array","items":{"$ref":"citation"}},"labels":{"type":"array","items":{"$ref":"Label"}},"score":{"type":"float"},"exampleUses":{"type":"array","items":{"$ref":"ExampleUsage"}},"attributionUrl":{"type":"string"},"seqString":{"type":"string"},"attributionText":{"type":"string"},"relatedWords":{"type":"array","items":{"$ref":"related"}},"word":{"type":"string"},"notes":{"type":"array","items":{"$ref":"note"}},"textProns":{"type":"array","items":{"$ref":"textPron"}},"partOfSpeech":{"type":"string"}},"id":"definition"}},"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1-SNAPSHOT","apiVersion":"4.0"}
View
2  api_docs/health.json
@@ -1 +1 @@
-{"resourcePath":"/health","apis":[{"path":"/health.{format}/version","description":"","operations":[{"summary":"Returns version of the server","responseTypeInternal":"com.wordnik.resource.endpoint.health.VersionModel","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getVersion","responseClass":"serverVersion","httpMethod":"GET"}]},{"path":"/health.{format}/profile","description":"","operations":[{"parameters":[{"name":"filter","description":"Filter to sort by","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sortBy","defaultValue":"name","description":"Field to sort by","required":false,"dataType":"string","allowableValues":{"values":["name","count","totalDuration","minDuration","avgDuration","maxDuration"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","defaultValue":"asc","description":"Sort direction","required":false,"dataType":"string","allowableValues":{"values":["asc","desc"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"reset","description":"Resets the profile information","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Gets current profile info","responseTypeInternal":"com.wordnik.util.ProfileCounter","nickname":"getProfile","responseClass":"profileItem","httpMethod":"GET"}]}],"models":{"ProfileItem":{"properties":{"minDuration":{"type":"long"},"totalDuration":{"type":"long"},"count":{"type":"long"},"name":{"type":"string"},"avgDuration":{"type":"double"},"hitRate":{"type":"double"},"maxDuration":{"type":"long"},"lastResetTime":{"type":"long"}},"id":"profileItem"},"ServiceVersion":{"properties":{"number":{"type":"string"},"serviceName":{"type":"string"}},"id":"ServiceVersion"},"ServerVersion":{"properties":{"serviceName":{"type":"string"},"version":{"type":"string"}},"id":"serverVersion"}},"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1-SNAPSHOT","apiVersion":"4.0"}
+{"resourcePath":"/health","apis":[{"path":"/health.{format}/version","description":"","operations":[{"summary":"Returns version of the server","httpMethod":"GET","responseTypeInternal":"com.wordnik.resource.endpoint.health.VersionModel","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getVersion","responseClass":"serverVersion"}]},{"path":"/health.{format}/profile","description":"","operations":[{"parameters":[{"name":"filter","description":"Filter to sort by","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sortBy","defaultValue":"name","description":"Field to sort by","required":false,"allowableValues":{"values":["name","count","totalDuration","minDuration","avgDuration","maxDuration"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sortOrder","defaultValue":"asc","description":"Sort direction","required":false,"allowableValues":{"values":["asc","desc"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"reset","description":"Resets the profile information","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Gets current profile info","httpMethod":"GET","responseTypeInternal":"com.wordnik.util.ProfileCounter","nickname":"getProfile","responseClass":"profileItem"}]}],"apiVersion":"4.0","swaggerVersion":"1.1-SNAPSHOT","basePath":"http://api.wordnik.com/v4","models":{"ProfileItem":{"properties":{"minDuration":{"type":"long"},"totalDuration":{"type":"long"},"count":{"type":"long"},"name":{"type":"string"},"avgDuration":{"type":"double"},"hitRate":{"type":"double"},"maxDuration":{"type":"long"},"lastResetTime":{"type":"long"}},"id":"profileItem"},"ServiceVersion":{"properties":{"number":{"type":"string"},"serviceName":{"type":"string"}},"id":"ServiceVersion"},"ServerVersion":{"properties":{"serviceName":{"type":"string"},"version":{"type":"string"}},"id":"serverVersion"}}}
View
1  api_docs/partner.json
@@ -0,0 +1 @@
+{"resourcePath":"/partner","apiVersion":"4.0","swaggerVersion":"1.1-SNAPSHOT","basePath":"http://api.wordnik.com/v4"}
View
1  api_docs/partners.json
@@ -0,0 +1 @@
+{"resourcePath":"/partners","apiVersion":"4.0","swaggerVersion":"1.1-SNAPSHOT","basePath":"http://api.wordnik.com/v4"}
View
2  api_docs/suggest.json
@@ -1 +1 @@
-{"resourcePath":"/suggest","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"}]}],"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"}},"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1-SNAPSHOT","apiVersion":"4.0"}
+{"resourcePath":"/suggest","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.","httpMethod":"GET","responseTypeInternal":"com.wordnik.resource.SearchResult","errorResponses":[{"reason":"Invalid Word Fragment supplied.","code":400}],"nickname":"getTagSuggestions","responseClass":"searchResult"}]}],"apiVersion":"4.0","swaggerVersion":"1.1-SNAPSHOT","basePath":"http://api.wordnik.com/v4","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"}}}
View
2  api_docs/system.json
@@ -1 +1 @@
-{"resourcePath":"/system","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}/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"}]},{"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.route.RouteResponse","errorResponses":[{"reason":"Invalid query.","code":400},{"reason":"No data found.","code":404}],"nickname":"getWordById","responseClass":"graph","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"}]}],"models":{"Long":{"properties":{"value":{"type":"long"}},"id":"long"},"Word":{"properties":{"numericProperties":{"type":"Map[string,object]"},"word":{"type":"string"},"stringProperties":{"type":"Map[string,string]"}},"id":"word"},"WordStats":{"properties":{"wordsListedCount":{"type":"long"},"externalApiCallsCount":{"type":"long"},"favoritesCount":{"type":"long"},"wordViewCount":{"type":"long"},"sentencesCount":{"type":"long"},"tokensCount":{"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"},"Graph":{"properties":{"elements":{"type":"array","items":{"$ref":"element"}}},"id":"graph"},"RelatedWord":{"properties":{"relationship":{"type":"string"},"weight":{"type":"double"},"word":{"type":"string"}},"id":"relatedWord"},"Element":{"properties":{"id":{"type":"string","required":true},"weight":{"type":"float"},"type":{"type":"string"}},"id":"element"}},"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1-SNAPSHOT","apiVersion":"4.0"}
+{"resourcePath":"/system","apis":[{"path":"/system.{format}/providers","description":"","operations":[{"summary":"Returns all defined ContentProviders.","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.document.model.ContentProvider","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","responseTypeInternal":"com.wordnik.system.model.SystemStats","nickname":"getStats","responseClass":"List[wordStats]"}]},{"path":"/system.{format}/audioRecordId","description":"","operations":[{"summary":"Gets an Audio File ID for recording.","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.LongResult","nickname":"getAudioRecordId","responseClass":"long"}]}],"apiVersion":"4.0","swaggerVersion":"1.1-SNAPSHOT","basePath":"http://api.wordnik.com/v4","models":{"Long":{"properties":{"value":{"type":"long"}},"id":"long"},"WordStats":{"properties":{"wordsListedCount":{"type":"long"},"externalApiCallsCount":{"type":"long"},"favoritesCount":{"type":"long"},"wordViewCount":{"type":"long"},"sentencesCount":{"type":"long"},"tokensCount":{"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"}}}
View
2  api_docs/tag.json
@@ -1 +1 @@
-{"resourcePath":"/tag","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"}]}],"models":{"WordObject":{"properties":{"id":{"type":"long","required":true},"word":{"type":"string"},"vulgar":{"type":"string"}},"id":"wordObject"}},"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1-SNAPSHOT","apiVersion":"4.0"}
+{"resourcePath":"/tag","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.","httpMethod":"GET","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]"}]}],"apiVersion":"4.0","swaggerVersion":"1.1-SNAPSHOT","basePath":"http://api.wordnik.com/v4","models":{"WordObject":{"properties":{"id":{"type":"long","required":true},"word":{"type":"string"},"vulgar":{"type":"string"}},"id":"wordObject"}}}
View
2  api_docs/user.json
@@ -1 +1 @@
-{"resourcePath":"/user","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":"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":"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":"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":"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":"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":"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":"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":"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":"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","defaultValue":"created_at","description":"Sort order","required":false,"dataType":"string","allowableValues":{"values":["created_at"],"valueType":"LIST"},"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":"com.wordnik.community.entity.UgcSummaryStats","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"}]}],"models":{"SubscriptionStatus":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"SubscriptionStatus"},"AudioObject":{"properties":{"recordId":{"type":"string"},"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"},"audioFileId":{"type":"long"},"streamPath":{"type":"string"},"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":{"subscriberCount":{"type":"int"},"commentCount":{"type":"int"},"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"},"createdBy":{"type":"string"},"createdAt":{"type":"Date"},"contentProvider":{"type":"contentProvider"},"htmlExtra":{"type":"string"},"word":{"type":"string"},"definitions":{"type":"array","items":{"$ref":"definition"}},"examples":{"type":"array","items":{"$ref":"example"}},"note":{"type":"string"},"publishDate":{"type":"Date"}},"id":"WordOfTheDay"},"UserTagHistory":{"properties":{"id":{"type":"long"},"wordId":{"type":"string"},"tagDate":{"type":"Date"},"tag":{"type":"string"},"userId":{"type":"long"},"tagId":{"type":"long"},"wordstring":{"type":"string"}},"id":"userTagHistory"},"WordObject":{"properties":{"id":{"type":"long","required":true},"word":{"type":"string"},"vulgar":{"type":"string"}},"id":"wordObject"},"RecentLookup":{"properties":{"createdAt":{"type":"Date"},"wordstring":{"type":"string"}},"id":"recentLookup"},"Example":{"properties":{"id":{"type":"long"},"title":{"type":"string"},"text":{"type":"string"},"url":{"type":"string"}},"id":"example"},"Tag":{"properties":{"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","required":true},"username":{"type":"string"},"permalink":{"type":"string"},"lastActivityAt":{"type":"Date"},"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"},"commentedBy":{"type":"string"},"commentedById":{"type":"long"},"objectType":{"type":"string"}},"id":"comment"},"SubscriptionItem":{"properties":{"createdAt":{"type":"Date"},"name":{"type":"string"},"medium":{"type":"string"}},"id":"SubscriptionItem"},"String":{"properties":{"name":{"type":"string"},"ordinal":{"type":"int"}},"id":"string"},"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"},"Definition":{"properties":{"com$wordnik$corpus$pos$traits$PartOfSpeech$$returnMode":{"type":"int"},"com$wordnik$corpus$pos$traits$PartOfSpeech$$posString":{"type":"string"},"text":{"type":"string"},"source":{"type":"string"},"com$wordnik$corpus$pos$traits$PartOfSpeech$$pos":{"type":"partOfSpeech"},"note":{"type":"string"},"partOfSpeechObj":{"type":"partOfSpeech"},"partOfSpeech":{"type":"string"}},"id":"definition"},"PartOfSpeech":{"properties":{"roots":{"type":"array","items":{"$ref":"root"}},"storageAbbr":{"type":"array","items":{"type":"string"}},"allCategories":{"type":"array","items":{"$ref":"category"}}},"id":"partOfSpeech"}},"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1-SNAPSHOT","apiVersion":"4.0"}
+{"resourcePath":"/user","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","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.updated.entity.WordOfTheDayList","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","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","httpMethod":"POST","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."},{"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","httpMethod":"PUT","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"}]},{"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","httpMethod":"DELETE","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"},{"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","httpMethod":"PUT","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"}]},{"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","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.user.entity.UserProfile","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getUserProfile","responseClass":"UserProfile"},{"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","httpMethod":"PUT","responseTypeInternal":"ok","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 or email to get UserTrackingInfo","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns a user's tracking info","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.user.entity.UserTrackingInfo","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 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","httpMethod":"PUT","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"},{"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","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.user.entity.User","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found","code":404}],"nickname":"getUser","responseClass":"user"},{"parameters":[{"name":"username","description":"Username or email to delete User object","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Deletes a User","httpMethod":"DELETE","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"}]},{"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","httpMethod":"PUT","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"}]},{"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","httpMethod":"DELETE","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"}]},{"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","httpMethod":"GET","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"}]},{"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,"allowableValues":{"values":["alpha","createDate","editDate"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sortOrder","defaultValue":"desc","description":"Direction to sort","required":false,"allowableValues":{"values":["asc","desc"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Gets WordLists for a User.","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.WordList","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":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Gets the count of WordLists for a User.","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.LongResult","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 or email to fetch UserSettings object","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns a user's settings","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.user.entity.UserSettings","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getUserSettings","responseClass":"UserSettings"},{"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","httpMethod":"PUT","responseTypeInternal":"ok","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 or email to fetch API Key for","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns the API key for the specified user","httpMethod":"GET","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"}]},{"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","httpMethod":"POST","responseTypeInternal":"com.wordnik.community.entity.Comment","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":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","httpMethod":"PUT","responseTypeInternal":"com.wordnik.community.entity.Comment","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":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","httpMethod":"DELETE","responseTypeInternal":"ok","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":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","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.Comment","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":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns a count of Comments on a user","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.LongResult","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":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Returns a count of Comments by a user","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.LongResult","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":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","defaultValue":"created_at","description":"Sort order","required":false,"allowableValues":{"values":["created_at"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns Comments by a user","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.Comment","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":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","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.Comment","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":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","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.UgcSummaryStats","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getUgcSummaryForUser","responseClass":"com.wordnik.community.entity.UgcSummaryStats"}]},{"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.","httpMethod":"GET","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]"}]},{"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.","httpMethod":"GET","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]"}]},{"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.","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.LongResult","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":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches all subscriptions for a User.","httpMethod":"GET","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]"}]},{"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.","httpMethod":"POST","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"},{"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.","httpMethod":"DELETE","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"}]},{"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.","httpMethod":"GET","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]"}]},{"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.","httpMethod":"GET","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"}]},{"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,"allowableValues":{"values":["public","private"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches Favorite WordLists for a user.","httpMethod":"GET","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]"}]},{"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.","httpMethod":"GET","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"}]},{"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.","httpMethod":"GET","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]"},{"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.","httpMethod":"DELETE","responseTypeInternal":"com.wordnik.community.entity.UserWordLookupHistoryItem","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":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches the total search count for a User.","httpMethod":"GET","responseTypeInternal":"Long","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":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.","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.AudioPron","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":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches the total search count for a User.","httpMethod":"GET","responseTypeInternal":"Long","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"nickname":"getUserActivityStream","responseClass":"Long"}]}],"apiVersion":"4.0","swaggerVersion":"1.1-SNAPSHOT","basePath":"http://api.wordnik.com/v4","models":{"SubscriptionStatus":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"SubscriptionStatus"},"AudioObject":{"properties":{"recordId":{"type":"string"},"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"},"audioFileId":{"type":"long"},"streamPath":{"type":"string"},"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":{"subscriberCount":{"type":"int"},"commentCount":{"type":"int"},"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"},"createdBy":{"type":"string"},"createdAt":{"type":"Date"},"contentProvider":{"type":"contentProvider"},"htmlExtra":{"type":"string"},"word":{"type":"string"},"definitions":{"type":"array","items":{"$ref":"definition"}},"examples":{"type":"array","items":{"$ref":"example"}},"note":{"type":"string"},"publishDate":{"type":"Date"}},"id":"WordOfTheDay"},"UserTagHistory":{"properties":{"id":{"type":"long"},"wordId":{"type":"string"},"tagDate":{"type":"Date"},"tag":{"type":"string"},"userId":{"type":"long"},"tagId":{"type":"long"},"wordstring":{"type":"string"}},"id":"userTagHistory"},"WordObject":{"properties":{"id":{"type":"long","required":true},"word":{"type":"string"},"vulgar":{"type":"string"}},"id":"wordObject"},"RecentLookup":{"properties":{"createdAt":{"type":"Date"},"wordstring":{"type":"string"}},"id":"recentLookup"},"Example":{"properties":{"id":{"type":"long"},"title":{"type":"string"},"text":{"type":"string"},"url":{"type":"string"}},"id":"example"},"Tag":{"properties":{"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","required":true},"username":{"type":"string"},"permalink":{"type":"string"},"lastActivityAt":{"type":"Date"},"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"},"commentedBy":{"type":"string"},"commentedById":{"type":"long"},"objectType":{"type":"string"}},"id":"comment"},"SubscriptionItem":{"properties":{"createdAt":{"type":"Date"},"name":{"type":"string"},"medium":{"type":"string"}},"id":"SubscriptionItem"},"String":{"properties":{"name":{"type":"string"},"ordinal":{"type":"int"}},"id":"string"},"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"},"Definition":{"properties":{"com$wordnik$corpus$pos$traits$PartOfSpeech$$returnMode":{"type":"int"},"com$wordnik$corpus$pos$traits$PartOfSpeech$$posString":{"type":"string"},"text":{"type":"string"},"source":{"type":"string"},"com$wordnik$corpus$pos$traits$PartOfSpeech$$pos":{"type":"partOfSpeech"},"note":{"type":"string"},"partOfSpeechObj":{"type":"partOfSpeech"},"partOfSpeech":{"type":"string"}},"id":"definition"},"PartOfSpeech":{"properties":{"roots":{"type":"array","items":{"$ref":"root"}},"storageAbbr":{"type":"array","items":{"type":"string"}},"allCategories":{"type":"array","items":{"$ref":"category"}}},"id":"partOfSpeech"}}}
View
2  api_docs/users.json
@@ -1 +1 @@
-{"resourcePath":"/users","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":"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","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":{"max":500.0,"min":1.0,"valueType":"RANGE"},"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"}]}],"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"},"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"},"audioFileId":{"type":"long"},"streamPath":{"type":"string"},"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"},"commentedBy":{"type":"string"},"commentedById":{"type":"long"},"objectType":{"type":"string"}},"id":"comment"},"WordObject":{"properties":{"id":{"type":"long","required":true},"word":{"type":"string"},"vulgar":{"type":"string"}},"id":"wordObject"}},"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1-SNAPSHOT","apiVersion":"4.0"}
+{"resourcePath":"/users","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","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.AudioPron","nickname":"getRecentPronunciations","responseClass":"List[audioObject]"}]},{"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","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.user.entity.User","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":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches a User by Facebook ID","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.user.entity.User","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","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","httpMethod":"POST","responseTypeInternal":"com.wordnik.system.user.entity.User","errorResponses":[{"reason":"Invalid User or User parameters supplied.","code":400}],"nickname":"createUser","responseClass":"user"}]},{"path":"/users.{format}/favorites","description":"","operations":[{"parameters":[{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"allowableValues":{"max":500.0,"min":1.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches recent Favorite Word objects.","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.entity.Word","nickname":"getRecentFavorites","responseClass":"List[wordObject]"}]},{"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","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.Comment","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","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","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.user.entity.UserSummary","nickname":"getUsersWhoListedMostWords","responseClass":"List[UserSummary]"}]},{"path":"/users.{format}/find","description":"","operations":[{"parameters":[{"name":"includeAllAccounts","description":"Include cancelled and closed accounts","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"createdAfter","description":"Find users after this date, yyyy-MM-dd format","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"isSubscribedToWotd","defaultValue":"true","description":"Filter by WOTD list","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":"Finds users by activity criteria","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.user.entity.User","nickname":"findUsersByCriteria","responseClass":"List[user]"}]}],"apiVersion":"4.0","swaggerVersion":"1.1-SNAPSHOT","basePath":"http://api.wordnik.com/v4","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"},"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"},"audioFileId":{"type":"long"},"streamPath":{"type":"string"},"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"},"commentedBy":{"type":"string"},"commentedById":{"type":"long"},"objectType":{"type":"string"}},"id":"comment"},"WordObject":{"properties":{"id":{"type":"long","required":true},"word":{"type":"string"},"vulgar":{"type":"string"}},"id":"wordObject"}}}
View
2  api_docs/word.json
1 addition, 1 deletion not shown
View
2  api_docs/wordList.json
@@ -1 +1 @@
-{"resourcePath":"/wordList","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":"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":"Array[com.wordnik.resource.StringValue]","valueTypeInternal":"com.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.ListedWord","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":"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":"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":"Array[com.wordnik.resource.StringValue]","valueTypeInternal":"com.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"}]}],"models":{"Long":{"properties":{"value":{"type":"long"}},"id":"long"},"WordList":{"properties":{"updatedAt":{"type":"Date"},"id":{"type":"long","required":true},"username":{"type":"string"},"permalink":{"type":"string"},"lastActivityAt":{"type":"Date"},"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"},"String":{"properties":{"name":{"type":"string"},"ordinal":{"type":"int"}},"id":"string"},"Tag":{"properties":{"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"},"commentedBy":{"type":"string"},"commentedById":{"type":"long"},"objectType":{"type":"string"}},"id":"comment"},"WordListWord":{"properties":{"id":{"type":"long","required":true},"username":{"type":"string"},"createdAt":{"type":"Date"},"numberCommentsOnWord":{"type":"long"},"userId":{"type":"long"},"word":{"type":"string"},"numberLists":{"type":"long"}},"id":"wordListWord"},"StringValue":{"properties":{"word":{"type":"string"}},"id":"StringValue"}},"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1-SNAPSHOT","apiVersion":"4.0"}
+{"resourcePath":"/wordList","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","httpMethod":"PUT","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"},{"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","httpMethod":"DELETE","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"},{"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","httpMethod":"GET","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"}]},{"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":"Array[StringValue]","valueTypeInternal":"com.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","httpMethod":"POST","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"},{"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,"allowableValues":{"values":["createDate","alpha"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sortOrder","defaultValue":"desc","description":"Direction to sort","required":false,"allowableValues":{"values":["asc","desc"],"valueType":"LIST"},"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":"populateWordActivity","description":"If set to false word activity info (comment count and number of word list where word is used) will not be populated. Defaut value is true","required":false,"dataType":"string","paramAccess":"internal","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","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.ListedWord","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":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","httpMethod":"GET","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"}]},{"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","httpMethod":"POST","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"},{"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","httpMethod":"DELETE","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"}]},{"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","httpMethod":"GET","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]"}]},{"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","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.LongResult","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":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","httpMethod":"POST","responseTypeInternal":"ok","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":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","httpMethod":"DELETE","responseTypeInternal":"ok","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":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","httpMethod":"GET","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]"}]},{"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","httpMethod":"POST","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"},{"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","httpMethod":"PUT","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"}]},{"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","httpMethod":"GET","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"},{"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","httpMethod":"DELETE","responseTypeInternal":"ok","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":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches WordList Comment count","httpMethod":"GET","responseTypeInternal":"com.wordnik.system.model.LongResult","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","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":"Array[StringValue]","valueTypeInternal":"com.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","httpMethod":"POST","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"}]},{"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","httpMethod":"GET","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"}]}],"apiVersion":"4.0","swaggerVersion":"1.1-SNAPSHOT","basePath":"http://api.wordnik.com/v4","models":{"Long":{"properties":{"value":{"type":"long"}},"id":"long"},"WordList":{"properties":{"updatedAt":{"type":"Date"},"id":{"type":"long","required":true},"username":{"type":"string"},"permalink":{"type":"string"},"lastActivityAt":{"type":"Date"},"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"},"String":{"properties":{"name":{"type":"string"},"ordinal":{"type":"int"}},"id":"string"},"Tag":{"properties":{"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"},"commentedBy":{"type":"string"},"commentedById":{"type":"long"},"objectType":{"type":"string"}},"id":"comment"},"WordListWord":{"properties":{"id":{"type":"long","required":true},"username":{"type":"string"},"createdAt":{"type":"Date"},"numberCommentsOnWord":{"type":"long"},"userId":{"type":"long"},"word":{"type":"string"},"numberLists":{"type":"long"}},"id":"wordListWord"},"StringValue":{"properties":{"word":{"type":"string"}},"id":"StringValue"}}}
View
2  api_docs/wordLists.json
@@ -1 +1 @@
-{"resourcePath":"/wordLists","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":"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"}]}],"models":{"WordList":{"properties":{"updatedAt":{"type":"Date"},"id":{"type":"long","required":true},"username":{"type":"string"},"permalink":{"type":"string"},"lastActivityAt":{"type":"Date"},"createdAt":{"type":"Date"},"description":{"type":"string"},"userId":{"type":"long"},"name":{"type":"string"},"numberWordsInList":{"type":"long"},"type":{"type":"string"}},"id":"wordList"},"String":{"properties":{"name":{"type":"string"},"ordinal":{"type":"int"}},"id":"string"},"CommentSummary":{"properties":{"objectDisplayName":{"type":"string"},"totalCount":{"type":"long"},"objectName":{"type":"string"},"countInInterval":{"type":"long"},"intervalInMilliseconds":{"type":"long"},"objectType":{"type":"string"}},"id":"commentSummary"}},"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1-SNAPSHOT","apiVersion":"4.0"}
+{"resourcePath":"/wordLists","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.","httpMethod":"GET","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%'"}]},{"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.","httpMethod":"POST","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"}]},{"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.","httpMethod":"GET","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"}]},{"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.","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.WordList","errorResponses":[{"reason":"Not authenticated.","code":403}],"nickname":"findRecentLists","responseClass":"List[wordList]"}]}],"apiVersion":"4.0","swaggerVersion":"1.1-SNAPSHOT","basePath":"http://api.wordnik.com/v4","models":{"WordList":{"properties":{"updatedAt":{"type":"Date"},"id":{"type":"long","required":true},"username":{"type":"string"},"permalink":{"type":"string"},"lastActivityAt":{"type":"Date"},"createdAt":{"type":"Date"},"description":{"type":"string"},"userId":{"type":"long"},"name":{"type":"string"},"numberWordsInList":{"type":"long"},"type":{"type":"string"}},"id":"wordList"},"String":{"properties":{"name":{"type":"string"},"ordinal":{"type":"int"}},"id":"string"},"CommentSummary":{"properties":{"objectDisplayName":{"type":"string"},"totalCount":{"type":"long"},"objectName":{"type":"string"},"countInInterval":{"type":"long"},"intervalInMilliseconds":{"type":"long"},"objectType":{"type":"string"}},"id":"commentSummary"}}}
View
2  api_docs/words.json
@@ -1 +1 @@
-{"resourcePath":"/words","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 for words returned","required":false,"dataType":"string","allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"allowMultiple":false,"paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary definition 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","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","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":"Array[java.lang.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":"wotdListInvitation","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"}]}],"models":{"SubscriptionStatus":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"SubscriptionStatus"},"DocumentMetadata":{"properties":{"tags":{"type":"array","items":{"type":"string"}},"yearType":{"type":"yearType"},"expirationDate":{"type":"Date"},"extendedMetadata":{"type":"extendedMetadata"},"stats":{"type":"basicDocumentStats"},"provider":{"type":"contentProvider"},"contentType":{"type":"contentType"},"sourceUrl":{"type":"string"},"date":{"type":"Date"},"medium":{"type":"documentMedium"},"guid":{"type":"string"},"id":{"type":"long"},"authors":{"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"},"WordOfTheDayList":{"properties":{"subscriberCount":{"type":"int"},"commentCount":{"type":"int"},"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"},"createdBy":{"type":"string"},"createdAt":{"type":"Date"},"contentProvider":{"type":"contentProvider"},"htmlExtra":{"type":"string"},"word":{"type":"string"},"definitions":{"type":"array","items":{"$ref":"definition"}},"examples":{"type":"array","items":{"$ref":"example"}},"note":{"type":"string"},"publishDate":{"type":"Date"}},"id":"WordOfTheDay"},"WordObject":{"properties":{"id":{"type":"long","required":true},"word":{"type":"string"},"vulgar":{"type":"string"}},"id":"wordObject"},"WordSearchResults":{"properties":{"searchResults":{"type":"array","items":{"$ref":"WordSearchResult"}},"totalResults":{"type":"int"}},"id":"wordSearchResults"},"Example":{"properties":{"id":{"type":"long"},"title":{"type":"string"},"text":{"type":"string"},"url":{"type":"string"}},"id":"example"},"TextPron":{"properties":{"raw":{"type":"string"},"rawType":{"type":"string"}},"id":"textPron"},"WordSearchResult":{"properties":{"count":{"type":"long"},"lexicality":{"type":"double"},"word":{"type":"string"}},"id":"WordSearchResult"},"DetailedWordUsage":{"properties":{"sentence":{"type":"sentence"},"wordstring":{"type":"string"},"metadata":{"type":"documentMetadata"}},"id":"detailedWordUsage"},"EntrySearchResult":{"properties":{"sourceDictionary":{"type":"string"},"headWord":{"type":"string"},"definitions":{"type":"array","items":{"$ref":"definition"}},"entryId":{"type":"long"}},"id":"EntrySearchResult"},"Note":{"properties":{"appliesTo":{"type":"array","items":{"type":"string"}},"value":{"type":"string"}},"id":"note"},"DefinitionSearchResults":{"properties":{"results":{"type":"array","items":{"$ref":"definition"}},"totalResults":{"type":"int"}},"id":"DefinitionSearchResults"},"Related":{"properties":{"words":{"type":"array","items":{"type":"string"}}},"id":"related"},"ScoredWord":{"properties":{"position":{"type":"int"},"id":{"type":"long"},"docTermCount":{"type":"int"},"lemma":{"type":"string"},"wordType":{"type":"string"},"score":{"type":"float"},"sentenceId":{"type":"long"},"word":{"type":"string"},"stopword":{"type":"boolean"},"baseWordScore":{"type":"double"},"partOfSpeech":{"type":"string"}},"id":"scoredWord"},"Citation":{"properties":{"cite":{"type":"string"},"source":{"type":"string"}},"id":"citation"},"CommentSummary":{"properties":{"objectDisplayName":{"type":"string"},"totalCount":{"type":"long"},"objectName":{"type":"string"},"countInInterval":{"type":"long"},"intervalInMilliseconds":{"type":"long"},"objectType":{"type":"string"}},"id":"commentSummary"},"Category":{"properties":{"id":{"type":"long","required":true},"name":{"type":"string"}},"id":"category"},"WordFrequency":{"properties":{"count":{"type":"long"},"wordstring":{"type":"string"}},"id":"wordFrequency"},"Root":{"properties":{"id":{"type":"long","required":true},"name":{"type":"string"},"categories":{"type":"array","items":{"$ref":"category"}}},"id":"root"},"Sentence":{"properties":{"hasScoredWords":{"type":"boolean"},"id":{"type":"long"},"scoredWords":{"type":"array","items":{"$ref":"scoredWord"}},"display":{"type":"string"},"rating":{"type":"int"},"documentMetadataId":{"type":"long"}},"id":"sentence"},"EntrySearchResults":{"properties":{"searchResults":{"type":"array","items":{"$ref":"EntrySearchResult"}},"totalResults":{"type":"int"}},"id":"EntrySearchResults"},"ContentProvider":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"contentProvider"},"Label":{"properties":{"text":{"type":"string"}},"id":"Label"},"Definition":{"properties":{"com$wordnik$corpus$pos$traits$PartOfSpeech$$returnMode":{"type":"int"},"com$wordnik$corpus$pos$traits$PartOfSpeech$$posString":{"type":"string"},"text":{"type":"string"},"source":{"type":"string"},"com$wordnik$corpus$pos$traits$PartOfSpeech$$pos":{"type":"partOfSpeech"},"note":{"type":"string"},"partOfSpeechObj":{"type":"partOfSpeech"},"partOfSpeech":{"type":"string"}},"id":"definition"},"PartOfSpeech":{"properties":{"roots":{"type":"array","items":{"$ref":"root"}},"storageAbbr":{"type":"array","items":{"type":"string"}},"allCategories":{"type":"array","items":{"$ref":"category"}}},"id":"partOfSpeech"}},"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1-SNAPSHOT","apiVersion":"4.0"}
+{"resourcePath":"/words","apis":[{"path":"/words.{format}/search","description":"","operations":[{"parameters":[{"name":"allowRegex","defaultValue":"false","description":"Search term is a Regular Expression","required":false,"allowableValues":{"values":["true","false"],"valueType":"LIST"},"dataType":"string","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,"allowableValues":{"values":["true","false"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"Only include these comma-delimited parts of speech","required":false,"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"},"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,"allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minDictionaryCount","defaultValue":"1","description":"Minimum number of dictionary entries for words returned","required":false,"allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary definition count","required":false,"allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minLength","defaultValue":"1","description":"Minimum word length","required":false,"allowableValues":{"max":1024.0,"min":0.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"allowableValues":{"max":1024.0,"min":0.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minLexicalityRating","defaultValue":"0","description":"Minimum lexicality","required":false,"allowableValues":{"max":100.0,"min":0.0,"valueType":"RANGE"},"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"maxLexicalityRating","defaultValue":"0","description":"Maximum lexicality","required":false,"allowableValues":{"max":100.0,"min":0.0,"valueType":"RANGE"},"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"allowableValues":{"max":1000.0,"min":0.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"allowableValues":{"max":1000.0,"min":1.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Searches words.","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.stats.entity.WordFrequency","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":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","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.updated.entity.WordOfTheDayList","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","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","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.WordOfTheDay","nickname":"getWordOfTheDay","responseClass":"WordOfTheDay"}]},{"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,"allowableValues":{"values":["ahd"," century"," wiktionary"," webster"," wordnet"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"excludeSourceDictionaries","description":"Exclude these comma-delimited source dictionaries","required":false,"allowableValues":{"values":["ahd"," century"," wiktionary"," webster"," wordnet"],"valueType":"LIST"},"dataType":"string","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,"allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minLength","defaultValue":"1","description":"Minimum word length","required":false,"allowableValues":{"max":1024.0,"min":0.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"allowableValues":{"max":1024.0,"min":0.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"expandTerms","description":"Expand terms","required":false,"allowableValues":{"values":["synonym","hypernym"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"wordTypes","description":"Word types","required":false,"allowableValues":{"values":["word","multi-word-unit"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"returnWordsOnly","defaultValue":"false","description":"Return words only","required":false,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"includeTags","defaultValue":"false","description":"Return a closed set of XML tags in response","required":false,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"useTagsForRanking","defaultValue":"true","description":"Use user tags, dictionary labels and hypernyms for ranking","required":false,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"sortBy","description":"Attribute to sort by","required":false,"allowableValues":{"values":["alpha","count","length"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Sort direction","required":false,"allowableValues":{"values":["asc","desc"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"allowableValues":{"max":1000.0,"min":0.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"allowableValues":{"max":1000.0,"min":1.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Searches definitions.","httpMethod":"GET","responseTypeInternal":"com.wordnik.index.definition.DefinitionSearchResults","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"nickname":"searchDefinitions","responseClass":"DefinitionSearchResults"}]},{"path":"/words.{format}/frequency","description":"","operations":[{"summary":"Fetches corpus-level word frequency","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.entity.FrequencySummary","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","allowMultiple":false,"paramType":"query"}],"summary":"Fetches surface forms of a word","httpMethod":"GET","responseTypeInternal":"String","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"nickname":"getSurfaceForms","responseClass":"String"}]},{"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","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.WordOfTheDay","nickname":"getWordOfTheDayRange","responseClass":"List[WordOfTheDay]"}]},{"path":"/words.{format}/search/{query}","description":"","operations":[{"parameters":[{"name":"allowRegex","defaultValue":"false","description":"Search query is a Regular Expression","required":false,"allowableValues":{"values":["true","false"],"valueType":"LIST"},"dataType":"string","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,"allowableValues":{"values":["true","false"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"Only include these comma-delimited parts of speech","required":false,"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"},"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,"allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minDictionaryCount","defaultValue":"1","description":"Minimum number of dictionary entries","required":false,"allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count","required":false,"allowableValues":{"max":"Infinity","min":0.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minLength","defaultValue":"1","description":"Minimum word length","required":false,"allowableValues":{"max":1024.0,"min":0.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"allowableValues":{"max":1024.0,"min":0.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"minLexicalityRating","defaultValue":"0","description":"Minimum lexicality","required":false,"allowableValues":{"max":100.0,"min":0.0,"valueType":"RANGE"},"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"maxLexicalityRating","defaultValue":"0","description":"Maximum lexicality","required":false,"allowableValues":{"max":100.0,"min":0.0,"valueType":"RANGE"},"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"allowableValues":{"max":1000.0,"min":0.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"allowableValues":{"max":1000.0,"min":1.0,"valueType":"RANGE"},"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Searches words.","httpMethod":"GET","responseTypeInternal":"com.wordnik.index.word.WordSearchResults","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,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"CSV part-of-speech values to include","required":false,"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"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"CSV part-of-speech values to exclude","required":false,"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"},"dataType":"string","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,"allowableValues":{"values":["alpha","count"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Sort direction","required":false,"allowableValues":{"values":["asc","desc"],"valueType":"LIST"},"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 an array of random WordObjects","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.entity.Word","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,"allowableValues":{"values":["false","true"],"valueType":"LIST"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"CSV part-of-speech values to include","required":false,"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"},"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"CSV part-of-speech values to exclude","required":false,"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"},"dataType":"string","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","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.entity.Word","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":"Array[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.","httpMethod":"POST","responseTypeInternal":"com.wordnik.corpus.model.Example","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","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.","httpMethod":"GET","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."}]},{"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.","httpMethod":"GET","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."}]},{"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","httpMethod":"POST","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"}]},{"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","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.updated.entity.WordOfTheDayList","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":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","httpMethod":"GET","responseTypeInternal":"com.wordnik.community.entity.WordOfTheDay","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","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","httpMethod":"GET","responseTypeInternal":"com.wordnik.corpus.updated.entity.WordOfTheDayList","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","allowMultiple":false,"paramType":"query"}],"summary":"Returns whether or not a subscription process has been run.","httpMethod":"GET","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."}]},{"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","httpMethod":"POST","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"}]},{"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","httpMethod":"GET","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]"}]}],"apiVersion":"4.0","swaggerVersion":"1.1-SNAPSHOT","basePath":"http://api.wordnik.com/v4","models":{"SubscriptionStatus":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"SubscriptionStatus"},"DocumentMetadata":{"properties":{"tags":{"type":"array","items":{"type":"string"}},"yearType":{"type":"yearType"},"expirationDate":{"type":"Date"},"extendedMetadata":{"type":"extendedMetadata"},"stats":{"type":"basicDocumentStats"},"provider":{"type":"contentProvider"},"contentType":{"type":"contentType"},"sourceUrl":{"type":"string"},"date":{"type":"Date"},"medium":{"type":"documentMedium"},"guid":{"type":"string"},"id":{"type":"long"},"authors":{"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":{"subscriberCount":{"type":"int"},"commentCount":{"type":"int"},"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"},"createdBy":{"type":"string"},"createdAt":{"type":"Date"},"contentProvider":{"type":"contentProvider"},"htmlExtra":{"type":"string"},"word":{"type":"string"},"definitions":{"type":"array","items":{"$ref":"definition"}},"examples":{"type":"array","items":{"$ref":"example"}},"note":{"type":"string"},"publishDate":{"type":"Date"}},"id":"WordOfTheDay"},"DetailedWordUsage":{"properties":{"sentence":{"type":"sentence"},"wordstring":{"type":"string"},"metadata":{"type":"documentMetadata"}},"id":"detailedWordUsage"},"DefinitionSearchResults":{"properties":{"results":{"type":"array","items":{"$ref":"definition"}},"totalResults":{"type":"int"}},"id":"DefinitionSearchResults"},"WordObject":{"properties":{"id":{"type":"long","required":true},"word":{"type":"string"},"vulgar":{"type":"string"}},"id":"wordObject"},"ScoredWord":{"properties":{"position":{"type":"int"},"id":{"type":"long"},"docTermCount":{"type":"int"},"lemma":{"type":"string"},"wordType":{"type":"string"},"score":{"type":"float"},"sentenceId":{"type":"long"},"word":{"type":"string"},"stopword":{"type":"boolean"},"baseWordScore":{"type":"double"},"partOfSpeech":{"type":"string"}},"id":"scoredWord"},"CommentSummary":{"properties":{"objectDisplayName":{"type":"string"},"totalCount":{"type":"long"},"objectName":{"type":"string"},"countInInterval":{"type":"long"},"intervalInMilliseconds":{"type":"long"},"objectType":{"type":"string"}},"id":"commentSummary"},"WordSearchResults":{"properties":{"searchResults":{"type":"array","items":{"$ref":"WordSearchResult"}},"totalResults":{"type":"int"}},"id":"wordSearchResults"},"Example":{"properties":{"id":{"type":"long"},"title":{"type":"string"},"text":{"type":"string"},"url":{"type":"string"}},"id":"example"},"WordFrequency":{"properties":{"count":{"type":"long"},"wordstring":{"type":"string"}},"id":"wordFrequency"},"WotdListInvitation":{"properties":{"failures":{"type":"array","items":{"type":"string"}},"permalink":{"type":"string"},"createdBy":{"type":"string"},"recipients":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"Date"},"note":{"type":"string"}},"id":"wotdListInvitation"},"Sentence":{"properties":{"hasScoredWords":{"type":"boolean"},"id":{"type":"long"},"scoredWords":{"type":"array","items":{"$ref":"scoredWord"}},"display":{"type":"string"},"rating":{"type":"int"},"documentMetadataId":{"type":"long"}},"id":"sentence"},"ContentProvider":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"contentProvider"},"Frequency":{"properties":{"count":{"type":"long"},"year":{"type":"int"}},"id":"frequency"},"FrequencySummary":{"properties":{"unknownYearCount":{"type":"int"},"totalCount":{"type":"long"},"frequencyString":{"type":"string"},"word":{"type":"string"},"frequency":{"type":"array","items":{"$ref":"frequency"}}},"id":"frequencySummary"},"Definition":{"properties":{"com$wordnik$corpus$pos$traits$PartOfSpeech$$returnMode":{"type":"int"},"com$wordnik$corpus$pos$traits$PartOfSpeech$$posString":{"type":"string"},"text":{"type":"string"},"source":{"type":"string"},"com$wordnik$corpus$pos$traits$PartOfSpeech$$pos":{"type":"partOfSpeech"},"note":{"type":"string"},"partOfSpeechObj":{"type":"partOfSpeech"},"partOfSpeech":{"type":"string"}},"id":"definition"},"PartOfSpeech":{"properties":{"roots":{"type":"array","items":{"$ref":"root"}},"storageAbbr":{"type":"array","items":{"type":"string"}},"allCategories":{"type":"array","items":{"$ref":"category"}}},"id":"partOfSpeech"}}}
View
26 lib/wordnik/resource_modules/account.rb
@@ -57,32 +57,6 @@ def authenticate_post(username, body, *args)
request_only ? request : request.response.body
end
- # Fetches WordList objects for the logged-in user.
- #
- def get_word_lists_for_current_user(*args)
- http_method = :get
- path = '/account/wordLists'
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
# Authenticates a User
#
def get_forgot_password(username, *args)
View
59 lib/wordnik/resource_modules/corpus.rb
@@ -188,32 +188,6 @@ def get_corpus_word_frequencies(*args)
request_only ? request : request.response.body
end
- # Fetches views from the website
- #
- def get_views(*args)
- http_method = :get
- path = '/corpus/views'
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
# Returns document-level stats.
#
def get_document_stats(*args)
@@ -266,38 +240,11 @@ def get_recent_listed_words(*args)
request_only ? request : request.response.body
end
- # Mock method to return Contextual Lookup info.
- # Internal Only
- #
- def get_mock_contextual_lookup_info(*args)
- http_method = :get
- path = '/corpus/contextualLookup'
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
- # Fetches ContextualLookup info.
+ # Receives info on phrases which should be captured
#
- def get_contextual_lookup_info(*args)
+ def get_punctuation_factor(body, *args)
http_method = :post
- path = '/corpus/contextualLookup'
+ path = '/corpus/phraseFeedback'
# Ruby turns all key-value arguments at the end into a single hash
# e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
View
278 lib/wordnik/resource_modules/glossary.rb
@@ -1,278 +0,0 @@
-# HEY HACKER! THIS IS AN AUTO-GENERATED FILE.
-# So don't bother editing it. To see how it's built, take a look at the Rakefile
-
-module GlossaryMethods
-
- # Fetches a glossary.
- #
- def get_glossary(permalinkId, *args)
- http_method = :get
- path = '/glossary/{permalinkId}'
- path.sub!('{permalinkId}', permalinkId.to_s)
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
- # Updates a Glossary.
- #
- def update_glossary(permalinkId, body, *args)
- http_method = :put
- path = '/glossary/{permalinkId}'
- path.sub!('{permalinkId}', permalinkId.to_s)
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
- # Deletes the Glossary.
- #
- def delete_glossary(permalinkId, *args)
- http_method = :delete
- path = '/glossary/{permalinkId}'
- path.sub!('{permalinkId}', permalinkId.to_s)
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
- # Adds GlossaryEntry objects for the specified Glossary.
- #
- def add_glossary_entry(permalinkId, body, *args)
- http_method = :post
- path = '/glossary/{permalinkId}/entries'
- path.sub!('{permalinkId}', permalinkId.to_s)
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
- # Publishes a Glossary.
- #
- def publish_glossary(permalinkId, *args)
- http_method = :post
- path = '/glossary/{permalinkId}/publish'
- path.sub!('{permalinkId}', permalinkId.to_s)
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
- # Creates a new version of a Glossary.
- #
- def create_version(permalinkId, *args)
- http_method = :post
- path = '/glossary/{permalinkId}/clone'
- path.sub!('{permalinkId}', permalinkId.to_s)
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
- # Removes a GlossaryEntry object from the specified Glossary.
- #
- def delete_glossary_entry(permalinkId, word, *args)
- http_method = :delete
- path = '/glossary/{permalinkId}/entries/{word}'
- path.sub!('{permalinkId}', permalinkId.to_s)
- path.sub!('{word}', word.to_s)
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
- # Removes a GlossaryEntry object from the specified Glossary.
- #
- def delete_glossary_entries(permalinkId, body, *args)
- http_method = :post
- path = '/glossary/{permalinkId}/deleteEntries'
- path.sub!('{permalinkId}', permalinkId.to_s)
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
- # Fetches a random GlossaryEntry object for the specified Glossary.
- #
- def get_random_glossary_entry(permalinkId, *args)
- http_method = :get
- path = '/glossary/{permalinkId}/randomEntry'
- path.sub!('{permalinkId}', permalinkId.to_s)
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
- # Fetches examples for the Glossary entry
- #
- def get_glossary_entry_examples(permalinkId, word, *args)
- http_method = :get
- path = '/glossary/{permalinkId}/entries/{word}/examples'
- path.sub!('{permalinkId}', permalinkId.to_s)
- path.sub!('{word}', word.to_s)
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
-end
View
108 lib/wordnik/resource_modules/system.rb
@@ -55,86 +55,6 @@ def get_stats(*args)
request_only ? request : request.response.body
end
- # Returns weighted terms related to the input word
- #
- def get_related_words(word, *args)
- http_method = :get
- path = '/system/{word}/related'
- path.sub!('{word}', word.to_s)
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
- # Returns a word with attributes
- #
- def get_related_words(word, *args)
- http_method = :get
- path = '/system/{word}'
- path.sub!('{word}', word.to_s)
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
- # Returns a graph response for the supplied terms
- #
- def get_word_by_id(*args)
- http_method = :get
- path = '/system/graph'
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
# Gets an Audio File ID for recording.
#
def get_audio_record_id(*args)
@@ -161,32 +81,4 @@ def get_audio_record_id(*args)
request_only ? request : request.response.body
end
- # Sets duration of an Audio File
- #
- def set_audio_duration(audioFileId, duration, *args)
- http_method = :post
- path = '/system/audioDuration'
- path.sub!('{audioFileId}', audioFileId.to_s)
- path.sub!('{duration}', duration.to_s)
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
end
View
26 lib/wordnik/resource_modules/users.rb
@@ -187,4 +187,30 @@ def get_users_who_listed_most_words(*args)
request_only ? request : request.response.body
end
+ # Finds users by activity criteria
+ #
+ def find_users_by_criteria(*args)
+ http_method = :get
+ path = '/users/find'
+
+ # Ruby turns all key-value arguments at the end into a single hash
+ # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
+ # becomes {:limit => 10, :part_of_speech => 'verb'}
+ last_arg = args.pop if args.last.is_a?(Hash)
+ last_arg = args.pop if args.last.is_a?(Array)
+ last_arg ||= {}
+
+ # Look for a kwarg called :request_only, whose presence indicates
+ # that we want the request itself back, not the response body
+ if last_arg.is_a?(Hash) && last_arg[:request_only].present?
+ request_only = true
+ last_arg.delete(:request_only)
+ end
+
+ params = last_arg
+ body ||= {}
+ request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
+ request_only ? request : request.response.body
+ end
+
end
View
137 lib/wordnik/resource_modules/word.rb
@@ -84,33 +84,6 @@ def get_examples_post(word, body, *args)
request_only ? request : request.response.body
end
- # Adds a Relationship Map to a word
- #
- def add_word_form(word, body, *args)
- http_method = :post
- path = '/word/{word}/wordForms'
- path.sub!('{word}', word.to_s)
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
# Returns other forms of a word
#
def get_word_forms(word, *args)
@@ -138,33 +111,6 @@ def get_word_forms(word, *args)
request_only ? request : request.response.body
end
- # Deletes a relationship from a word
- #
- def delete_word_form(word, *args)
- http_method = :delete
- path = '/word/{word}/wordForms'
- path.sub!('{word}', word.to_s)
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
# Given a word as a string, returns the WordObject that represents it
#
def get_word(word, *args)
@@ -273,62 +219,6 @@ def get_top_example(word, *args)
request_only ? request : request.response.body
end
- # Returns definitions for a word based on the sentence in which it is found
- # Use the offset parameter when the word occurs more than once in the sentence
- #
- def contextual_lookup(word, *args)
- http_method = :get
- path = '/word/{word}/contextualLookup'
- path.sub!('{word}', word.to_s)
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
- # Returns definitions for a word based on the sentence in which it is found
- # Use the offset parameter when the word occurs more than once in the sentence
- #
- def contextual_lookup_post(word, body, *args)
- http_method = :post
- path = '/word/{word}/contextualLookup'
- path.sub!('{word}', word.to_s)
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
# Returns the number of times a word has been viewed
#
def get_lookup_count(word, *args)
@@ -410,33 +300,6 @@ def get_related_words(word, *args)
request_only ? request : request.response.body
end
- # Adds relationships to the Word Graph
- #
- def add_related_words(word, body, *args)
- http_method = :post
- path = '/word/{word}/relatedWords'
- path.sub!('{word}', word.to_s)
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
# Returns WordLists containing a word
#
def get_listed_in(word, *args)
View
28 lib/wordnik/resource_modules/word_lists.rb
@@ -84,34 +84,6 @@ def find_most_commented_on(*args)
request_only ? request : request.response.body
end
- # Fetches WordList objects containing a word.
- # Results are scoped to the supplied user.
- #
- def find_containing_word(word, *args)
- http_method = :get
- path = '/wordLists/containing/{word}'
- path.sub!('{word}', word.to_s)
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
# Fetches recently created WordList objects.
#
def find_recent_lists(*args)
View
38 lib/wordnik/resource_modules/words.rb
@@ -82,11 +82,11 @@ def get_word_of_the_day(*args)
request_only ? request : request.response.body
end
- # Searches dictionary entries.
+ # Searches definitions.
#
- def search_entries(*args)
+ def search_definitions(*args)
http_method = :get
- path = '/words/searchEntries'
+ path = '/words/searchDefinitions'
# Ruby turns all key-value arguments at the end into a single hash
# e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
@@ -108,11 +108,11 @@ def search_entries(*args)
request_only ? request : request.response.body
end
- # Searches definitions.
+ # Fetches corpus-level word frequency
#
- def search_definitions(*args)
+ def get_frequency(*args)
http_method = :get
- path = '/words/searchDefinitions'
+ path = '/words/frequency'
# Ruby turns all key-value arguments at the end into a single hash
# e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
@@ -186,32 +186,6 @@ def get_word_of_the_day_range(*args)
request_only ? request : request.response.body
end
- # Fetches canonical forms of a word
- #
- def get_canonical_forms(*args)
- http_method = :get
- path = '/words/canonicalForms'
-
- # Ruby turns all key-value arguments at the end into a single hash
- # e.g. Wordnik.word.get_examples('dingo', :limit => 10, :part_of_speech => 'verb')
- # becomes {:limit => 10, :part_of_speech => 'verb'}
- last_arg = args.pop if args.last.is_a?(Hash)
- last_arg = args.pop if args.last.is_a?(Array)
- last_arg ||= {}
-
- # Look for a kwarg called :request_only, whose presence indicates
- # that we want the request itself back, not the response body
- if last_arg.is_a?(Hash) && last_arg[:request_only].present?
- request_only = true
- last_arg.delete(:request_only)
- end
-
- params = last_arg
- body ||= {}
- request = Wordnik::Request.new(http_method, path, :params => params, :body => body)
- request_only ? request : request.response.body
- end
-
# Searches words.
#
def search_words_new(query, *args)
View
2  lib/wordnik/version.rb
@@ -1,5 +1,5 @@
module Wordnik
- VERSION = "4.06.15"
+ VERSION = "4.07"
end
View
2  spec/resource_spec.rb
@@ -25,7 +25,7 @@
it "defines a method for each operation nickname" do
@resource.public_methods.should include(:get_word)
@resource.public_methods.should include(:get_definitions)
- @resource.public_methods.should include(:contextual_lookup_post)
+ @resource.public_methods.should include(:get_word_of_the_day)
@resource.public_methods.should_not include(:get_busy)
end

0 comments on commit 07a20de

Please sign in to comment.
Something went wrong with that request. Please try again.