Permalink
Browse files

Regenerated dynamic methods via `rake swagger`; bumped version.

  • Loading branch information...
1 parent b67d43e commit 498375e0e5bff882249ee8288a80cd34ecf1ce9f @zeke zeke committed Sep 22, 2011
View
6 Rakefile
@@ -15,9 +15,9 @@ task :swagger do
# Configure default input values..
settings = {
:scheme => 'http',
- :host => 'localhost:8001',
- :base_path => "/admin/api",
- :api_key => 'b39ee8d5f05d0f566a0080b4c310ceddf5dc5f7606a616f53',
+ :host => 'beta.wordnik.com',
+ :base_path => "/v4",
+ :api_key => '',
}
# Ask user for each setting, using the defaults where user input is blank
View
2 api_docs/account.json
@@ -1 +1 @@
-{"resourcePath":"/account","models":{"ApiTokenStatus":{"properties":{"token":{"type":"string","required":false,"uniqueItems":false},"resetsInMillis":{"type":"long","required":false,"uniqueItems":false},"remainingCalls":{"type":"long","required":false,"uniqueItems":false},"expiresInMillis":{"type":"long","required":false,"uniqueItems":false},"totalRequests":{"type":"long","required":false,"uniqueItems":false}},"id":"ApiTokenStatus","type":"any","required":false,"uniqueItems":false},"AuthenticationToken":{"properties":{"token":{"type":"string","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"userSignature":{"type":"string","required":false,"uniqueItems":false}},"id":"AuthenticationToken","type":"any","required":false,"uniqueItems":false},"ApiResponse":{"properties":{"message":{"type":"string","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false}},"id":"ApiResponse","type":"any","required":false,"uniqueItems":false},"UserHandle":{"properties":{"webService":{"type":"int","required":false,"uniqueItems":false},"handle":{"type":"string","required":false,"uniqueItems":false}},"id":"UserHandle","type":"any","required":false,"uniqueItems":false},"UserSettings":{"properties":{"bossURL":{"type":"string","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false}},"id":"UserSettings","type":"any","required":false,"uniqueItems":false},"UserTrackingInfo":{"properties":{"signupDate":{"type":"Date","required":false,"uniqueItems":false},"lastLoginDate":{"type":"Date","required":false,"uniqueItems":false},"noOfLogins":{"type":"int","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"lastUpdatedDate":{"type":"Date","required":false,"uniqueItems":false},"signupIPAddress":{"type":"string","required":false,"uniqueItems":false}},"id":"UserTrackingInfo","type":"any","required":false,"uniqueItems":false},"UserProfile":{"properties":{"lastName":{"type":"string","required":false,"uniqueItems":false},"mostFavoriteWord":{"type":"string","required":false,"uniqueItems":false},"location":{"type":"string","required":false,"uniqueItems":false},"seekingWord":{"type":"string","required":false,"uniqueItems":false},"leastFavoriteWord":{"type":"string","required":false,"uniqueItems":false},"onomaTopoeiaWord":{"type":"string","required":false,"uniqueItems":false},"siteUrl":{"type":"string","required":false,"uniqueItems":false},"bio":{"type":"string","required":false,"uniqueItems":false},"userHandles":{"type":"array","required":false,"items":{"$ref":"UserHandle","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"youWord":{"type":"string","required":false,"uniqueItems":false},"firstName":{"type":"string","required":false,"uniqueItems":false},"siteName":{"type":"string","required":false,"uniqueItems":false}},"id":"UserProfile","type":"any","required":false,"uniqueItems":false},"apiApplication":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"userName":{"type":"string","required":false,"uniqueItems":false},"approvalState":{"type":"ApiApprovalState","required":false,"uniqueItems":false},"comment":{"type":"string","required":false,"uniqueItems":false}},"id":"apiApplication","type":"any","required":false,"uniqueItems":false},"ApiApprovalState":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"ApiApprovalState","type":"any","required":false,"uniqueItems":false},"user":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"email":{"type":"string","required":false,"uniqueItems":false},"status":{"type":"int","required":false,"uniqueItems":false},"faceBookId":{"type":"string","required":false,"uniqueItems":false},"userName":{"type":"string","required":false,"uniqueItems":false},"displayName":{"type":"string","required":false,"uniqueItems":false},"password":{"type":"string","required":false,"uniqueItems":false}},"id":"user","type":"any","required":false,"uniqueItems":false},"wordList":{"properties":{"updatedAt":{"type":"Date","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"username":{"type":"string","required":false,"uniqueItems":false},"permalink":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"numberWordsInList":{"type":"long","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false}},"id":"wordList","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/account.{format}/authenticate/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"A confirmed Wordnik username","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"password","description":"The user's password","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Authenticates a User","httpMethod":"GET","errorResponses":[{"reason":"Account not available.","code":403},{"reason":"User not found.","code":404}],"nickname":"authenticate","responseClass":"AuthenticationToken"},{"parameters":[{"name":"username","description":"A confirmed Wordnik username","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"The user's password","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Authenticates a user","httpMethod":"POST","errorResponses":[{"reason":"Account not available.","code":403},{"reason":"User not found.","code":404}],"nickname":"authenticatePost","responseClass":"AuthenticationToken"}]},{"path":"/account.{format}/logout","description":"","operations":[{"parameters":[{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Logs out a user","httpMethod":"GET","nickname":"logout","responseClass":"ok"}]},{"path":"/account.{format}/wordLists","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches WordList objects for the logged-in user.","httpMethod":"GET","errorResponses":[{"reason":"Not authenticated.","code":403},{"reason":"User account not found.","code":404}],"nickname":"getWordListsForCurrentUser","responseClass":"List[wordList]"}]},{"path":"/account.{format}/forgotPassword/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Authenticates a User","httpMethod":"GET","errorResponses":[{"reason":"User is Facebook Connected","code":400},{"reason":"User not found","code":404}],"nickname":"getForgotPassword","responseClass":"String"}]},{"path":"/account.{format}/resetPassword/{hashcode}","description":"","operations":[{"parameters":[{"name":"hashcode","description":"Password reset code","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches a User by code","httpMethod":"GET","errorResponses":[{"reason":"Invalid code supplied","code":400},{"reason":"User not found or code invalid.","code":404}],"nickname":"resetPassword","responseClass":"user"}]},{"path":"/account.{format}/apiAccountApplication","description":"","operations":[{"parameters":[{"description":"API Application Info","required":true,"dataType":"apiApplication","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Creates an API account application.","httpMethod":"POST","errorResponses":[{"reason":"Account not available.","code":403},{"reason":"User not found.","code":404}],"nickname":"createApiAccount","responseClass":"ApiResponse"}]},{"path":"/account.{format}/regenerateApiToken","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Regenerates an API Token. Currently not supported or tested.","httpMethod":"GET","errorResponses":[{"reason":"Invalid token supplied.","code":400}],"nickname":"createApiAccount","responseClass":"ok"}]},{"path":"/account.{format}/apiTokenStatus","description":"","operations":[{"parameters":[{"name":"api_key","description":"Wordnik authentication token","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"api_key","description":"Wordnik authentication token","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns usage statistics for the API account.","httpMethod":"GET","errorResponses":[{"reason":"No token supplied.","code":400},{"reason":"No API account with supplied token.","code":404}],"nickname":"getApiTokenStatus","responseClass":"ApiTokenStatus"}]},{"path":"/account.{format}/logVisit","description":"","operations":[{"parameters":[{"name":"userId","description":"User ID to track data for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"userGuid","description":"User's persistent GUID","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"userSessionId","description":"User's session ID","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"userIpAddress","description":"User IP address","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"serverIp","description":"Server IP address","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Logs a VisitAction for the user","httpMethod":"POST","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"logVisitForUser","responseClass":"Stirng","notes":"Requires a valid auth_token to be set."}]},{"path":"/account.{format}/activationCode/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns an activation code given a username","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"getActivationCodeForUser","responseClass":"String","notes":"If an activation code is not available, will return null."}]},{"path":"/account.{format}/activate","description":"","operations":[{"parameters":[{"description":"Activation Code","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Activates an account.","httpMethod":"POST","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"No activation code found.","code":404}],"nickname":"activateUser","responseClass":"user"}]},{"path":"/account.{format}/usernameAvailable/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns an ApiResponse indicating whether or not a username is available","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"getUsernameAvailable","responseClass":"ApiResponse"}]},{"path":"/account.{format}/user","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Returns the logged-in User","httpMethod":"GET","errorResponses":[{"reason":"Not logged in.","code":403},{"reason":"User not found.","code":404}],"nickname":"getLoggedInUser","responseClass":"user","notes":"Requires a valid auth_token to be set."}]},{"path":"/account.{format}/profile","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Returns profile info for the logged-in user","httpMethod":"GET","errorResponses":[{"reason":"Not logged in.","code":403},{"reason":"User not found.","code":404}],"nickname":"getLoggedInUserProfile","responseClass":"UserProfile","notes":"Requires a valid auth_token to be set."}]},{"path":"/account.{format}/settings","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Returns logged-in User Settings","httpMethod":"GET","errorResponses":[{"reason":"Not logged in.","code":403},{"reason":"User not found.","code":404}],"nickname":"getLoggedInUserSettings","responseClass":"UserSettings","notes":"Requires a valid auth_token to be set."}]},{"path":"/account.{format}/trackingInfo","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Returns logged-in User TrackingInfo.","httpMethod":"GET","errorResponses":[{"reason":"Not logged in.","code":403},{"reason":"User not found.","code":404}],"nickname":"getLoggedInUserTrackingInfo","responseClass":"UserTrackingInfo","notes":"Requires a valid auth_token to be set."}]}],"models1":[{"name":"ApiResponse","fields":[{"name":"message","required":false,"allowMultiple":false,"paramType":"string"},{"name":"type","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"UserProfile","fields":[{"name":"location","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"firstName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"lastName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"bio","required":false,"allowMultiple":false,"paramType":"string"},{"name":"siteUrl","required":false,"allowMultiple":false,"paramType":"string"},{"name":"leastFavoriteWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"mostFavoriteWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"onomaTopoeiaWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"seekingWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"youWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userHandles","required":false,"allowMultiple":false,"paramType":"List[UserHandle]"},{"name":"siteName","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"ApiApprovalState","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"wordList","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"type","required":false,"allowMultiple":false,"paramType":"string"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"permalink","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"username","required":false,"allowMultiple":false,"paramType":"string"},{"name":"updatedAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"numberWordsInList","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"UserHandle","fields":[{"name":"webService","required":false,"allowMultiple":false,"paramType":"int"},{"name":"handle","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"UserSettings","fields":[{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"bossURL","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"ApiTokenStatus","fields":[{"name":"token","required":false,"allowMultiple":false,"paramType":"string"},{"name":"expiresInMillis","required":false,"allowMultiple":false,"paramType":"long"},{"name":"totalRequests","required":false,"allowMultiple":false,"paramType":"long"},{"name":"remainingCalls","required":false,"allowMultiple":false,"paramType":"long"},{"name":"resetsInMillis","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"UserTrackingInfo","fields":[{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"noOfLogins","required":false,"allowMultiple":false,"paramType":"int"},{"name":"signupDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"signupIPAddress","required":false,"allowMultiple":false,"paramType":"string"},{"name":"lastUpdatedDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"lastLoginDate","required":false,"allowMultiple":false,"paramType":"Date"}]},{"name":"apiApplication","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"comment","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"userName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"approvalState","required":false,"allowMultiple":false,"paramType":"ApiApprovalState"}]},{"name":"AuthenticationToken","fields":[{"name":"token","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"userSignature","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"user","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"displayName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"status","required":false,"allowMultiple":false,"paramType":"int"},{"name":"password","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"email","required":false,"allowMultiple":false,"paramType":"string"},{"name":"faceBookId","required":false,"allowMultiple":false,"paramType":"string"}]}],"basePath":"url","swaggerVersion":"1.0"}
+{"resourcePath":"/account","models":{"ApiTokenStatus":{"properties":{"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"},"user":{"properties":{"id":{"type":"long"},"email":{"type":"string"},"status":{"type":"int"},"faceBookId":{"type":"string"},"userName":{"type":"string"},"displayName":{"type":"string"},"password":{"type":"string"}},"id":"user"},"wordList":{"properties":{"updatedAt":{"type":"Date"},"id":{"type":"long"},"username":{"type":"string"},"permalink":{"type":"string"},"createdAt":{"type":"Date"},"description":{"type":"string"},"userId":{"type":"long"},"name":{"type":"string"},"numberWordsInList":{"type":"long"},"type":{"type":"string"}},"id":"wordList"}},"apis":[{"path":"/account.{format}/authenticate/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"A confirmed Wordnik username","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"password","description":"The user's password","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Authenticates a User","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","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"The user's password","required":true,"dataType":"string","allowableValues":[],"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","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches WordList objects for the logged-in user.","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}/regenerateApiToken","description":"","operations":[{"parameters":[{"name":"api_key","description":"API Key","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Regenerates an API Token. Currently not supported or tested.","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":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"api_key","description":"Wordnik authentication token","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns usage statistics for the API account.","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}/usernameAvailable/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns an ApiResponse indicating whether or not a username is available","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","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Returns the logged-in User","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"}]}],"basePath":"url","swaggerVersion":"1.0"}
View
1 api_docs/analytics.json
@@ -1 +0,0 @@
-{"resourcePath":"/analytics","models":{"wordHitsCollection":{"properties":{"wordHitsList":{"type":"array","required":false,"items":{"$ref":"wordHits","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"wordHitsCollection","type":"any","required":false,"uniqueItems":false},"wordHits":{"properties":{"timeMillis":{"type":"long","required":false,"uniqueItems":false}},"id":"wordHits","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/analytics.{format}/top","description":"","operations":[{"parameters":[{"name":"namespace","defaultValue":"site.word","description":"The namespace for which to return hits","required":false,"dataType":"string","allowableValues":["site.word"],"allowMultiple":false,"paramType":"query"},{"name":"year","description":"Year","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"month","description":"Month","required":false,"dataType":"string","allowableValues":["1","2","3","4","5","6","7","8","9","10","11","12"],"allowMultiple":false,"paramType":"query"},{"name":"week","description":"Week","required":false,"dataType":"string","allowableValues":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31","32","33","34","35","36","37","38","39","40","41","42","43","44","45","46","47","48","49","50","51","52"],"allowMultiple":false,"paramType":"query"},{"name":"day","description":"Day","required":false,"dataType":"string","allowableValues":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31"],"allowMultiple":false,"paramType":"query"},{"name":"hour","description":"Hour","required":false,"dataType":"string","allowableValues":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24"],"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Number of results to skip by","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"50","description":"Number of results to fetch","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns top hits over a year, month, week, day or hour","httpMethod":"GET","errorResponses":[{"reason":"Invalid time resolution specified","code":400}],"nickname":"getTopHits","responseClass":"wordHitsCollection","notes":"If no time resolution parameters are passed, it returns top hits for this week. To fetch top hits for a year, pass only the year. To fetch top hits for a month, pass (year and month). To fetch top hits for a week, pass (year and week). To fetch top hits for a day, pass (year, month and day). To fetch top hits for an hour, pass (year, month, day and hour)."}]},{"path":"/analytics.{format}/trending","description":"","operations":[{"parameters":[{"name":"namespace","defaultValue":"site.word","description":"The namespace for which to return hits","required":false,"dataType":"string","allowableValues":["site.word"],"allowMultiple":false,"paramType":"query"},{"name":"year","description":"Year","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"month","description":"Month","required":false,"dataType":"string","allowableValues":["1","2","3","4","5","6","7","8","9","10","11","12"],"allowMultiple":false,"paramType":"query"},{"name":"week","description":"Week","required":false,"dataType":"string","allowableValues":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31","32","33","34","35","36","37","38","39","40","41","42","43","44","45","46","47","48","49","50","51","52"],"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Number of results to skip by","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"50","description":"Number of results to fetch","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns words which were trending on a given week or month","httpMethod":"GET","errorResponses":[{"reason":"Invalid time resolution specified","code":400}],"nickname":"getTrendingHits","responseClass":"wordHitsCollection","notes":"If no time resolution parameters are passed, it returns trending hits for this week.\nTo fetch trending hits for a month, pass (year and month). To fetch trending hits for a week, pass (year and week)."}]},{"path":"/analytics.{format}/word/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"Word","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"namespace","defaultValue":"site.word","description":"The namespace for which to return hits","required":false,"dataType":"string","allowableValues":["site.word"],"allowMultiple":false,"paramType":"query"},{"name":"year","description":"Year","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"month","description":"Month","required":false,"dataType":"string","allowableValues":["1","2","3","4","5","6","7","8","9","10","11","12"],"allowMultiple":false,"paramType":"query"},{"name":"week","description":"Week","required":false,"dataType":"string","allowableValues":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31","32","33","34","35","36","37","38","39","40","41","42","43","44","45","46","47","48","49","50","51","52"],"allowMultiple":false,"paramType":"query"},{"name":"day","description":"Day","required":false,"dataType":"string","allowableValues":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24","25","26","27","28","29","30","31"],"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Number of results to skip by","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"50","description":"Number of results to fetch","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns hits a word received in a given year, month, week or day","httpMethod":"GET","errorResponses":[{"reason":"Invalid time resolution specified","code":400}],"nickname":"getWordHits","responseClass":"wordHitsCollection","notes":"If no time resolution parameters are passed, it returns hits the word received this week. To fetch word hits for a year, pass only the year. To fetch word hits for a month, pass (year and month). To fetch word hits for a week, pass (year and week). To fetch word hits for a day, pass (year, month and day)"}]}],"models1":[{"name":"wordHits","fields":[{"name":"timeMillis","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"wordHitsCollection","fields":[{"name":"wordHitsList","required":false,"wrapperName":"wordHitsList","allowMultiple":false,"paramType":"List[wordHits]"}]}],"basePath":"url","swaggerVersion":"1.0"}
View
2 api_docs/corpus.json
@@ -1 +1 @@
-{"resourcePath":"/corpus","models":{"wordView":{"properties":{"id":{"type":"long","required":true,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false}},"id":"wordView","type":"any","required":false,"uniqueItems":false},"basicWordUsage":{"properties":{"sentenceId":{"type":"long","required":false,"uniqueItems":false},"year":{"type":"integer","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false},"documentId":{"type":"long","required":false,"uniqueItems":false}},"id":"basicWordUsage","type":"any","required":false,"uniqueItems":false},"dictionaryStats":{"properties":{"dictionaryName":{"type":"string","required":false,"uniqueItems":false},"exampleCount":{"type":"int","required":false,"uniqueItems":false},"defintionCount":{"type":"int","required":false,"uniqueItems":false},"relationshipLinks":{"type":"Map[string,integer]","required":false,"uniqueItems":false},"textPronunciationCount":{"type":"int","required":false,"uniqueItems":false},"wordCount":{"type":"int","required":false,"uniqueItems":false},"wordsWithRelationship":{"type":"Map[string,integer]","required":false,"uniqueItems":false}},"id":"dictionaryStats","type":"any","required":false,"uniqueItems":false},"punctuationFactor":{"properties":{"periodCount":{"type":"long","required":false,"uniqueItems":false},"exclamationPointCount":{"type":"long","required":false,"uniqueItems":false},"wordId":{"type":"long","required":false,"uniqueItems":false},"questionMarkCount":{"type":"long","required":false,"uniqueItems":false},"totalCount":{"type":"long","required":false,"uniqueItems":false}},"id":"punctuationFactor","type":"any","required":false,"uniqueItems":false},"wordListingHistory":{"properties":{"wordId":{"type":"long","required":false,"uniqueItems":false},"listingCount":{"type":"long","required":false,"uniqueItems":false},"wordString":{"type":"string","required":false,"uniqueItems":false}},"id":"wordListingHistory","type":"any","required":false,"uniqueItems":false},"sentence":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"display":{"type":"string","required":false,"uniqueItems":false},"rating":{"type":"int","required":false,"uniqueItems":false},"documentMetadataId":{"type":"long","required":false,"uniqueItems":false},"scoredWord":{"type":"array","required":false,"items":{"$ref":"scoredWord","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"sentence","type":"any","required":false,"uniqueItems":false},"long":{"properties":{"value":{"type":"long","required":false,"uniqueItems":false}},"id":"long","type":"any","required":false,"uniqueItems":false},"basicDocumentStats":{"properties":{"uniqueBiGramsCount":{"type":"long","required":false,"uniqueItems":false},"wordsCount":{"type":"long","required":false,"uniqueItems":false},"documentsCount":{"type":"long","required":false,"uniqueItems":false},"firstUsedWordsCount":{"type":"long","required":false,"uniqueItems":false},"tokensCount":{"type":"long","required":false,"uniqueItems":false},"sentencesCount":{"type":"long","required":false,"uniqueItems":false},"viableSentencesCount":{"type":"long","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false},"uniqueWordsCount":{"type":"long","required":false,"uniqueItems":false},"key":{"type":"string","required":false,"uniqueItems":false}},"id":"basicDocumentStats","type":"any","required":false,"uniqueItems":false},"scoredWord":{"properties":{"position":{"type":"int","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"wordType":{"type":"string","required":false,"uniqueItems":false},"score":{"type":"float","required":false,"uniqueItems":false},"sentenceId":{"type":"long","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"partOfSpeech":{"type":"string","required":false,"uniqueItems":false}},"id":"scoredWord","type":"any","required":false,"uniqueItems":false},"wordResult":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"wordResult","type":"any","required":false,"uniqueItems":false},"lookupExample":{"properties":{"sourceName":{"type":"string","required":false,"uniqueItems":false},"uRL":{"type":"string","required":false,"uniqueItems":false},"exampleString":{"type":"string","required":false,"uniqueItems":false}},"id":"lookupExample","type":"any","required":false,"uniqueItems":false},"suggestion":{"properties":{"type":{"type":"int","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"suggestion","type":"any","required":false,"uniqueItems":false},"contextualLookupResponse":{"properties":{"examples":{"type":"array","required":false,"items":{"$ref":"lookupExample","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"contextualLookupResponse","type":"any","required":false,"uniqueItems":false},"wordFrequency":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"wordFrequency","type":"any","required":false,"uniqueItems":false},"relationshipMap":{"properties":{"sourceWordstring":{"type":"string","required":false,"uniqueItems":false},"suggestion":{"type":"array","required":false,"items":{"$ref":"suggestion","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"relationshipMap","type":"any","required":false,"uniqueItems":false},"contextualLookupRequest":{"properties":{"partnerId":{"type":"string","required":false,"uniqueItems":false},"documentTitle":{"type":"string","required":false,"uniqueItems":false},"contextString":{"type":"string","required":false,"uniqueItems":false},"sourceUrl":{"type":"string","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false},"metadataId":{"type":"string","required":false,"uniqueItems":false}},"id":"contextualLookupRequest","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/corpus.{format}/recentViews","description":"","operations":[{"parameters":[{"name":"limit","description":"Limits results","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"humanOnly","description":"Returns results only from human visitors","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"sortByFrequency","description":"Sorts results by frequency","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches recent views from the website.","httpMethod":"GET","nickname":"getRecentViews","responseClass":"List[wordResult]"}]},{"path":"/corpus.{format}/words/{statsType}/{object}","description":"","operations":[{"parameters":[{"name":"statsType","description":"Stats type to fetch","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"object","description":"Object identifier","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Gets WordFrequency data","httpMethod":"GET","errorResponses":[{"reason":"Invalid dimension for WordFrequency data or Object Identifier not found.","code":400}],"nickname":"getWordFrequencies","responseClass":"List[wordFrequency]"}]},{"path":"/corpus.{format}/dictionaryStats","description":"","operations":[{"parameters":[{"name":"sourceDictionary","description":"Dictionary name to fetch stats for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Gets Dictionary Statistics data","httpMethod":"GET","errorResponses":[{"reason":"Invalid dictionary name supplied.","code":404}],"nickname":"getWordFrequencies","responseClass":"dictionaryStats"}]},{"path":"/corpus.{format}/firstUsed","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Gets Dictionary Statistics data","httpMethod":"GET","errorResponses":[{"reason":"No data found for corpus.","code":404}],"nickname":"getWordFrequencies","responseClass":"List[basicWordUsage]"}]},{"path":"/corpus.{format}/totalDocumentCount","description":"","operations":[{"summary":"Returns the count of documents in the Corpus.","httpMethod":"GET","nickname":"getTotalDocumentCount","responseClass":"long"}]},{"path":"/corpus.{format}/processText","description":"","operations":[{"parameters":[{"description":"Text body to process.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"body"},{"name":"split","description":"Tells the processor to split multiple sentences from the input. Default is true.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"rank","description":"Flag to invoke the ranking logic. Default is false.","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Processes text input.","httpMethod":"POST","errorResponses":[{"reason":"Invalid text supplied.","code":400}],"nickname":"processText","responseClass":"List[sentence]","notes":"Returns tagged and processed text based on the input string."}]},{"path":"/corpus.{format}/punctuationFactor","description":"","operations":[{"summary":"Returns corpus-wide PunctuationFactor.","httpMethod":"GET","errorResponses":[{"reason":"No data available.","code":404}],"nickname":"getPunctuationFactor","responseClass":"punctuationFactor"}]},{"path":"/corpus.{format}/phraseFeedback","description":"","operations":[{"parameters":[{"description":"Phrase to store.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Receives info on phrases which should be captured","httpMethod":"POST","errorResponses":[{"reason":"Invalid phrase supplied.","code":400}],"nickname":"getPunctuationFactor","responseClass":"List[sentence]"}]},{"path":"/corpus.{format}/documentStats","description":"","operations":[{"parameters":[{"name":"documentStatsType","description":"Type of statistics to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"id","description":"ID of statistics type to return.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"split","description":"Flag to invoke the ranking logic. Default is false.","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns document-level stats.","httpMethod":"GET","errorResponses":[{"reason":"Invalid stats type supplied.","code":400}],"nickname":"getDocumentStats","responseClass":"basicDocumentStats"}]},{"path":"/corpus.{format}/words","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Gets corpus-level WordFrequency","httpMethod":"GET","errorResponses":[{"reason":"No corpus frequency data available.","code":400}],"nickname":"getCorpusWordFrequencies","responseClass":"List[wordFrequency]"}]},{"path":"/corpus.{format}/dymInternal/{wordstring}","description":"","operations":[{"parameters":[{"name":"wordstring","description":"Returns results only from human visitors","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns word relationships.","httpMethod":"GET","errorResponses":[{"reason":"No data available.","code":404},{"reason":"Invalid word supplied.","code":400}],"nickname":"getDym","responseClass":"relationshipMap"}]},{"path":"/corpus.{format}/recentListedWords","description":"","operations":[{"parameters":[{"name":"limit","description":"Maximun results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns recently listed words.","httpMethod":"GET","nickname":"getRecentListedWords","responseClass":"List[wordListingHistory]"}]},{"path":"/corpus.{format}/views","description":"","operations":[{"parameters":[{"name":"word","description":"Filter by word","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"userId","description":"filter by user id","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"userGuid","description":"Filter by user guid","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"sessionId","description":"Filter by user session id","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"callingClass","description":"Filter by calling class","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"method","description":"Filter by calling method","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"environment","description":"Deployment environment to find results from","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"serverIp","description":"Server IP to query from","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"createdAfter","description":"Date to find results after","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches views from the website.","httpMethod":"GET","nickname":"getViews","responseClass":"List[wordView]"}]},{"path":"/corpus.{format}/contextualLookup","description":"","operations":[{"parameters":[{"name":"word","description":"Word of interest","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"contextString","description":"Sentence word appears in","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"title","description":"Word of interest","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"metadataId","description":"Word of interest","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"partnerId","description":"Partner Id","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"sourceUrl","description":"Document source URL","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Mock method to return Contextual Lookup info.","httpMethod":"GET","nickname":"getMockContextualLookupInfo","responseClass":"contextualLookupResponse","notes":"Internal Only"},{"parameters":[{"name":"category","description":"Filters response by category","required":false,"dataType":"contextualLookupRequest","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches ContextualLookup info.","httpMethod":"POST","nickname":"getContextualLookupInfo","responseClass":"contextualLookupResponse"}]},{"path":"/corpus.{format}/totalWordCount","description":"","operations":[{"summary":"Returns the count of tokens in the Corpus.","httpMethod":"GET","nickname":"getTotalTokensCount","responseClass":"long"}]},{"path":"/corpus.{format}/sentenceCount","description":"","operations":[{"summary":"Returns the count of sentences in the Corpus.","httpMethod":"GET","nickname":"getTotalSentencesCount","responseClass":"long"}]}],"models1":[{"name":"sentence","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"scoredWord","required":false,"wrapperName":"scoredWords","allowMultiple":false,"paramType":"List[scoredWord]"},{"name":"display","required":false,"allowMultiple":false,"paramType":"string"},{"name":"documentMetadataId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"rating","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"wordFrequency","fields":[{"name":"count","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"contextualLookupRequest","fields":[{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sourceUrl","required":false,"allowMultiple":false,"paramType":"string"},{"name":"contextString","required":false,"allowMultiple":false,"paramType":"string"},{"name":"metadataId","required":false,"allowMultiple":false,"paramType":"string"},{"name":"partnerId","required":false,"allowMultiple":false,"paramType":"string"},{"name":"documentTitle","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"relationshipMap","fields":[{"name":"sourceWordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"suggestion","required":false,"wrapperName":"suggestions","allowMultiple":false,"paramType":"List[suggestion]"}]},{"name":"punctuationFactor","fields":[{"name":"totalCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"periodCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"exclamationPointCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"questionMarkCount","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"long","fields":[{"name":"value","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"lookupExample","fields":[{"name":"uRL","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sourceName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"exampleString","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"wordView","fields":[{"name":"id","required":true,"allowMultiple":false,"paramType":"long"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"basicWordUsage","fields":[{"name":"year","required":false,"allowMultiple":false,"paramType":"integer"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"documentId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"sentenceId","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"wordListingHistory","fields":[{"name":"wordString","required":false,"allowMultiple":false,"paramType":"string"},{"name":"wordId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"listingCount","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"dictionaryStats","fields":[{"name":"defintionCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"textPronunciationCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"exampleCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"dictionaryName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"wordCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"wordsWithRelationship","required":false,"allowMultiple":false,"paramType":"Map[string,integer]"},{"name":"relationshipLinks","required":false,"allowMultiple":false,"paramType":"Map[string,integer]"}]},{"name":"wordResult","fields":[{"name":"count","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"scoredWord","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"position","required":false,"allowMultiple":false,"paramType":"int"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"score","required":false,"allowMultiple":false,"paramType":"float"},{"name":"sentenceId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"partOfSpeech","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"contextualLookupResponse","fields":[{"name":"examples","required":false,"wrapperName":"lookupExamples","allowMultiple":false,"paramType":"List[lookupExample]"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"suggestion","fields":[{"name":"type","required":false,"allowMultiple":false,"paramType":"int"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"basicDocumentStats","fields":[{"name":"key","required":false,"allowMultiple":false,"paramType":"string"},{"name":"type","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sentencesCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"uniqueWordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"documentsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"tokensCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"firstUsedWordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"viableSentencesCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"uniqueBiGramsCount","required":false,"allowMultiple":false,"paramType":"long"}]}],"basePath":"url","swaggerVersion":"1.0"}
+{"resourcePath":"/corpus","basePath":"url","swaggerVersion":"1.0"}
View
1 api_docs/document.json
@@ -1 +0,0 @@
-{"resourcePath":"/document","models":{"authorType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"authorType","type":"any","required":false,"uniqueItems":false},"yearType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"yearType","type":"any","required":false,"uniqueItems":false},"documentModel":{"properties":{"biGramFrequency":{"type":"array","required":false,"items":{"$ref":"biGramFrequency","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"sentence":{"type":"array","required":false,"items":{"$ref":"sentence","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"wordFrequency":{"type":"array","required":false,"items":{"$ref":"wordFrequency","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"documentMetadata":{"type":"documentMetadata","required":false,"uniqueItems":false},"basicDocumentStats":{"type":"basicDocumentStats","required":false,"uniqueItems":false}},"id":"documentModel","type":"any","required":false,"uniqueItems":false},"extendedMetadata":{"properties":{"sourceFileSize":{"type":"long","required":false,"uniqueItems":false},"issn":{"type":"string","required":false,"uniqueItems":false},"isbn":{"type":"string","required":false,"uniqueItems":false},"lccn":{"type":"string","required":false,"uniqueItems":false},"documentMetadataId":{"type":"long","required":false,"uniqueItems":false}},"id":"extendedMetadata","type":"any","required":false,"uniqueItems":false},"subjectClassificationType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"subjectClassificationType","type":"any","required":false,"uniqueItems":false},"sentence":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"display":{"type":"string","required":false,"uniqueItems":false},"rating":{"type":"int","required":false,"uniqueItems":false},"documentMetadataId":{"type":"long","required":false,"uniqueItems":false},"scoredWord":{"type":"array","required":false,"items":{"$ref":"scoredWord","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"sentence","type":"any","required":false,"uniqueItems":false},"documentMedium":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"documentMedium","type":"any","required":false,"uniqueItems":false},"contentType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"contentType","type":"any","required":false,"uniqueItems":false},"documentMetadata":{"properties":{"yearType":{"type":"yearType","required":false,"uniqueItems":false},"expirationDate":{"type":"Date","required":false,"uniqueItems":false},"extendedMetadata":{"type":"extendedMetadata","required":false,"uniqueItems":false},"stats":{"type":"basicDocumentStats","required":false,"uniqueItems":false},"tag":{"type":"array","required":false,"items":{"type":"string","required":false,"uniqueItems":false},"uniqueItems":false},"provider":{"type":"contentProvider","required":false,"uniqueItems":false},"contentType":{"type":"contentType","required":false,"uniqueItems":false},"sourceUrl":{"type":"string","required":false,"uniqueItems":false},"date":{"type":"Date","required":false,"uniqueItems":false},"medium":{"type":"documentMedium","required":false,"uniqueItems":false},"guid":{"type":"string","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"author":{"type":"array","required":false,"items":{"$ref":"author","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"title":{"type":"string","required":false,"uniqueItems":false},"primaryAuthorType":{"type":"authorType","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"classification":{"type":"subjectClassificationType","required":false,"uniqueItems":false},"year":{"type":"integer","required":false,"uniqueItems":false},"primaryAuthor":{"type":"string","required":false,"uniqueItems":false},"rating":{"type":"double","required":false,"uniqueItems":false},"primaryAuthorId":{"type":"long","required":false,"uniqueItems":false}},"id":"documentMetadata","type":"any","required":false,"uniqueItems":false},"basicDocumentStats":{"properties":{"uniqueBiGramsCount":{"type":"long","required":false,"uniqueItems":false},"wordsCount":{"type":"long","required":false,"uniqueItems":false},"documentsCount":{"type":"long","required":false,"uniqueItems":false},"firstUsedWordsCount":{"type":"long","required":false,"uniqueItems":false},"tokensCount":{"type":"long","required":false,"uniqueItems":false},"sentencesCount":{"type":"long","required":false,"uniqueItems":false},"viableSentencesCount":{"type":"long","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false},"uniqueWordsCount":{"type":"long","required":false,"uniqueItems":false},"key":{"type":"string","required":false,"uniqueItems":false}},"id":"basicDocumentStats","type":"any","required":false,"uniqueItems":false},"scoredWord":{"properties":{"position":{"type":"int","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"wordType":{"type":"string","required":false,"uniqueItems":false},"score":{"type":"float","required":false,"uniqueItems":false},"sentenceId":{"type":"long","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"partOfSpeech":{"type":"string","required":false,"uniqueItems":false}},"id":"scoredWord","type":"any","required":false,"uniqueItems":false},"author":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"authorType":{"type":"authorType","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"uniqueName":{"type":"string","required":false,"uniqueItems":false}},"id":"author","type":"any","required":false,"uniqueItems":false},"bigram":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"gram2":{"type":"string","required":false,"uniqueItems":false},"gram1":{"type":"string","required":false,"uniqueItems":false},"wlmi":{"type":"double","required":false,"uniqueItems":false},"mi":{"type":"double","required":false,"uniqueItems":false}},"id":"bigram","type":"any","required":false,"uniqueItems":false},"biGramFrequency":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"bigram":{"type":"bigram","required":false,"uniqueItems":false},"wlmi":{"type":"double","required":false,"uniqueItems":false},"mi":{"type":"double","required":false,"uniqueItems":false}},"id":"biGramFrequency","type":"any","required":false,"uniqueItems":false},"contentProvider":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"contentProvider","type":"any","required":false,"uniqueItems":false},"wordFrequency":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"wordFrequency","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/document.{format}/id/{document_id}/words","description":"","operations":[{"parameters":[{"name":"document_id","description":"Document ID to fetch frequency data for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches Document objects by Content Provider code.","httpMethod":"GET","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"getWordFrequencies","responseClass":"List[wordFrequency]"}]},{"path":"/document.{format}/{contentProvider}/documents","description":"","operations":[{"parameters":[{"name":"contentProvider","description":"Partner Code to fetch for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"filterByWordScore","description":"Filter document model by word scores.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minWordScore","description":"Minimum word score to return.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches examples for a specific provider matching a criteria.","httpMethod":"GET","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":404}],"nickname":"getGlossaries","responseClass":"List[documentModel]"}]},{"path":"/document.{format}/provider/{provider}","description":"","operations":[{"parameters":[{"name":"provider","description":"Content provider","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches Document objects by Content Provider code.","httpMethod":"GET","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"getDocumentsByContentProvider","responseClass":"List[documentMetadata]"}]},{"path":"/document.{format}/{id}/metadata","description":"","operations":[{"parameters":[{"name":"id","description":"Document ID","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches Document objects by document identifier.","httpMethod":"GET","errorResponses":[{"reason":"Invalid document ID supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"getMetadataById","responseClass":"documentMetadata"}]},{"path":"/document.{format}/{id}/model","description":"","operations":[{"parameters":[{"name":"scores","description":"Return word scores","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"id","description":"Document ID","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches Document objects by id.","httpMethod":"GET","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":400},{"reason":"No activation code available.","code":404}],"nickname":"getModelById","responseClass":"documentModel"}]}],"models1":[{"name":"wordFrequency","fields":[{"name":"count","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"sentence","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"scoredWord","required":false,"wrapperName":"scoredWords","allowMultiple":false,"paramType":"List[scoredWord]"},{"name":"display","required":false,"allowMultiple":false,"paramType":"string"},{"name":"documentMetadataId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"rating","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"extendedMetadata","fields":[{"name":"documentMetadataId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"isbn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"issn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"lccn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sourceFileSize","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"documentModel","fields":[{"name":"documentMetadata","required":false,"allowMultiple":false,"paramType":"documentMetadata"},{"name":"basicDocumentStats","required":false,"allowMultiple":false,"paramType":"basicDocumentStats"},{"name":"wordFrequency","required":false,"wrapperName":"wordFrequencies","allowMultiple":false,"paramType":"List[wordFrequency]"},{"name":"sentence","required":false,"wrapperName":"sentences","allowMultiple":false,"paramType":"List[sentence]"},{"name":"biGramFrequency","required":false,"wrapperName":"bigramFrequencies","allowMultiple":false,"paramType":"List[biGramFrequency]"}]},{"name":"biGramFrequency","fields":[{"name":"count","required":false,"allowMultiple":false,"paramType":"long"},{"name":"mi","required":false,"allowMultiple":false,"paramType":"double"},{"name":"wlmi","required":false,"allowMultiple":false,"paramType":"double"},{"name":"bigram","required":false,"allowMultiple":false,"paramType":"bigram"}]},{"name":"author","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"authorType","required":false,"allowMultiple":false,"paramType":"authorType"},{"name":"uniqueName","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"contentType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"bigram","fields":[{"name":"count","required":false,"allowMultiple":false,"paramType":"long"},{"name":"gram1","required":false,"allowMultiple":false,"paramType":"string"},{"name":"gram2","required":false,"allowMultiple":false,"paramType":"string"},{"name":"mi","required":false,"allowMultiple":false,"paramType":"double"},{"name":"wlmi","required":false,"allowMultiple":false,"paramType":"double"}]},{"name":"yearType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"documentMetadata","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"year","required":false,"allowMultiple":false,"paramType":"integer"},{"name":"contentType","required":false,"allowMultiple":false,"paramType":"contentType"},{"name":"provider","required":false,"allowMultiple":false,"paramType":"contentProvider"},{"name":"tag","required":false,"wrapperName":"tags","allowMultiple":false,"paramType":"List[string]"},{"name":"title","required":false,"allowMultiple":false,"paramType":"string"},{"name":"rating","required":false,"allowMultiple":false,"paramType":"double"},{"name":"medium","required":false,"allowMultiple":false,"paramType":"documentMedium"},{"name":"sourceUrl","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"classification","required":false,"allowMultiple":false,"paramType":"subjectClassificationType"},{"name":"date","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"yearType","required":false,"allowMultiple":false,"paramType":"yearType"},{"name":"primaryAuthor","required":false,"allowMultiple":false,"paramType":"string"},{"name":"primaryAuthorType","required":false,"allowMultiple":false,"paramType":"authorType"},{"name":"primaryAuthorId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"guid","required":false,"allowMultiple":false,"paramType":"string"},{"name":"extendedMetadata","required":false,"allowMultiple":false,"paramType":"extendedMetadata"},{"name":"author","required":false,"wrapperName":"authors","allowMultiple":false,"paramType":"List[author]"},{"name":"expirationDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"stats","required":false,"allowMultiple":false,"paramType":"basicDocumentStats"}]},{"name":"documentMedium","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"subjectClassificationType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"contentProvider","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"authorType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"scoredWord","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"position","required":false,"allowMultiple":false,"paramType":"int"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"score","required":false,"allowMultiple":false,"paramType":"float"},{"name":"sentenceId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"partOfSpeech","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"basicDocumentStats","fields":[{"name":"key","required":false,"allowMultiple":false,"paramType":"string"},{"name":"type","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sentencesCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"uniqueWordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"documentsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"tokensCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"firstUsedWordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"viableSentencesCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"uniqueBiGramsCount","required":false,"allowMultiple":false,"paramType":"long"}]}],"basePath":"url","swaggerVersion":"1.0"}
View
1 api_docs/partner.json
@@ -1 +0,0 @@
-{"resourcePath":"/partner","models":{"glossaryStatus":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"glossaryStatus","type":"any","required":false,"uniqueItems":false},"GlossaryEntry":{"properties":{"title":{"type":"string","required":false,"uniqueItems":false},"noteType":{"type":"string","required":false,"uniqueItems":false},"example":{"type":"string","required":false,"uniqueItems":false},"glossaryId":{"type":"long","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false},"note":{"type":"string","required":false,"uniqueItems":false},"url":{"type":"string","required":false,"uniqueItems":false}},"id":"GlossaryEntry","type":"any","required":false,"uniqueItems":false},"Glossary":{"properties":{"updatedAt":{"type":"Date","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"permalinkId":{"type":"string","required":false,"uniqueItems":false},"status":{"type":"glossaryStatus","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"contentProvider":{"type":"contentProvider","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"totalEntries":{"type":"int","required":false,"uniqueItems":false},"publishedDate":{"type":"Date","required":false,"uniqueItems":false},"version":{"type":"double","required":false,"uniqueItems":false}},"id":"Glossary","type":"any","required":false,"uniqueItems":false},"contentProvider":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"contentProvider","type":"any","required":false,"uniqueItems":false},"documentModelSearchResults":{"properties":{"author":{"type":"string","required":false,"uniqueItems":false},"title":{"type":"string","required":false,"uniqueItems":false},"sentences":{"type":"array","required":false,"items":{"type":"string","required":false,"uniqueItems":false},"uniqueItems":false},"date":{"type":"string","required":false,"uniqueItems":false},"url":{"type":"string","required":false,"uniqueItems":false}},"id":"documentModelSearchResults","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/partner.{format}/{id}/result","description":"","operations":[{"parameters":[{"name":"id","description":"Document ID","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"searchTerms","description":"Comma separated search terms","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches model search results.","httpMethod":"GET","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":404}],"nickname":"getResults","responseClass":"List[documentModelSearchResults]"}]},{"path":"/partner.{format}/glossaries","description":"","operations":[{"parameters":[{"name":"includeDrafts","description":"Includes unpublished Glossaries","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches glossaries for the specified Provider.","httpMethod":"GET","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":404}],"nickname":"getGlossaries","responseClass":"List[Glossary]"}]},{"path":"/partner.{format}/glossary/{permalink}","description":"","operations":[{"parameters":[{"name":"permalink","description":"Permalink of Glossary to fetch.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"version","description":"Version to fetch","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches a glossary by permalink.","httpMethod":"GET","errorResponses":[{"reason":"Not authorized.","code":403},{"reason":"Invalid ID supplied.","code":404}],"nickname":"getGlossary","responseClass":"Glossary"}]},{"path":"/partner.{format}/{word}/related","description":"","operations":[{"parameters":[{"name":"word","description":"Word to find related items for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"type","description":"Related Type","required":false,"dataType":"string","allowableValues":["person"," location"," organization"],"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns weighted terms related to the input word","httpMethod":"GET","errorResponses":[{"reason":"No data found.","code":404}],"nickname":"getRelatedWords","responseClass":"relatedWord"}]},{"path":"/partner.{format}/glossary/{permalink}/entries","description":"","operations":[{"parameters":[{"name":"permalink","description":"Permalink of Glossary.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"version","description":"Specific Glossary version to fetch Entries for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"startsWith","description":"Word pattern to fetch with.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches GlossaryEntry objects for the specified Glossary.","httpMethod":"GET","errorResponses":[{"reason":"Not authorized.","code":403},{"reason":"Invalid ID supplied.","code":404}],"nickname":"getGlossaryEntries","responseClass":"List[GlossaryEntry]"}]}],"models1":[{"name":"contentProvider","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"Glossary","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"version","required":false,"allowMultiple":false,"paramType":"double"},{"name":"status","required":false,"allowMultiple":false,"paramType":"glossaryStatus"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"permalinkId","required":false,"allowMultiple":false,"paramType":"string"},{"name":"contentProvider","required":false,"allowMultiple":false,"paramType":"contentProvider"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"publishedDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"updatedAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"totalEntries","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"documentModelSearchResults","fields":[{"name":"date","required":false,"allowMultiple":false,"paramType":"string"},{"name":"url","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sentences","required":false,"allowMultiple":false,"paramType":"List[string]"},{"name":"title","required":false,"allowMultiple":false,"paramType":"string"},{"name":"author","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"GlossaryEntry","fields":[{"name":"url","required":false,"allowMultiple":false,"paramType":"string"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"example","required":false,"allowMultiple":false,"paramType":"string"},{"name":"title","required":false,"allowMultiple":false,"paramType":"string"},{"name":"note","required":false,"allowMultiple":false,"paramType":"string"},{"name":"glossaryId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"noteType","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"glossaryStatus","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]}],"basePath":"url","swaggerVersion":"1.0"}
View
1 api_docs/partners.json
@@ -1 +0,0 @@
-{"resourcePath":"/partners","models":{"glossaryStatus":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"glossaryStatus","type":"any","required":false,"uniqueItems":false},"GlossaryEntry":{"properties":{"title":{"type":"string","required":false,"uniqueItems":false},"noteType":{"type":"string","required":false,"uniqueItems":false},"example":{"type":"string","required":false,"uniqueItems":false},"glossaryId":{"type":"long","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false},"note":{"type":"string","required":false,"uniqueItems":false},"url":{"type":"string","required":false,"uniqueItems":false}},"id":"GlossaryEntry","type":"any","required":false,"uniqueItems":false},"Glossary":{"properties":{"updatedAt":{"type":"Date","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"permalinkId":{"type":"string","required":false,"uniqueItems":false},"status":{"type":"glossaryStatus","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"contentProvider":{"type":"contentProvider","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"totalEntries":{"type":"int","required":false,"uniqueItems":false},"publishedDate":{"type":"Date","required":false,"uniqueItems":false},"version":{"type":"double","required":false,"uniqueItems":false}},"id":"Glossary","type":"any","required":false,"uniqueItems":false},"contentProvider":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"contentProvider","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/partners.{format}/{contentProvider}/glossaries","description":"","operations":[{"parameters":[{"name":"contentProvider","description":"Partner Code to create for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Glossary to create","required":false,"dataType":"Glossary","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Creates a glossary for the Content Provider.","httpMethod":"POST","errorResponses":[{"reason":"Invalid Glossary supplied.","code":400},{"reason":"Invalid Content Provider code supplied.","code":404}],"nickname":"createGlossary","responseClass":"Glossary"},{"parameters":[{"name":"contentProvider","description":"Partner Code to fetch for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"includeDrafts","description":"Includes unpublished Glossaries","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches glossaries for the specified Provider.","httpMethod":"GET","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":404}],"nickname":"getGlossaries","responseClass":"List[Glossary]"}]},{"path":"/partners.{format}/{contentProvider}/glossary/{permalinkId}","description":"","operations":[{"parameters":[{"name":"contentProvider","description":"Partner Code to fetch for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalinkId","description":"Permalink of Glossary to fetch.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"version","description":"Version to fetch","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches a glossary for the specified Provider.","httpMethod":"GET","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":404}],"nickname":"getGlossary","responseClass":"Glossary"},{"parameters":[{"name":"contentProvider","description":"Partner Code to update for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalinkId","description":"Permalink of Glossary to fetch.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"version","description":"Version to fetch","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"description":"Updated Glossary","required":false,"dataType":"Glossary","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Updates a Glossaryfor the specified Provider.","httpMethod":"PUT","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":404}],"nickname":"updateGlossary","responseClass":"Glossary"},{"parameters":[{"name":"contentProvider","description":"Partner Code to delete for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalinkId","description":"Permalink of Glossary to delete.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"version","description":"Version to delete","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Deletes a single Glossary.","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":404}],"nickname":"deleteGlossary","responseClass":"ok"}]},{"path":"/partners.{format}/{contentProvider}/glossary/{permalinkId}/entries","description":"","operations":[{"parameters":[{"name":"contentProvider","description":"Partner Code to fetch for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalinkId","description":"Permalink of Glossary.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"version","description":"Specific Glossary version to fetch Entries for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"startsWith","description":"Word pattern to fetch with.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches GlossaryEntry objects for the specified Glossary.","httpMethod":"GET","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":404}],"nickname":"getGlossaryEntries","responseClass":"List[GlossaryEntry]"},{"parameters":[{"name":"contentProvider","description":"Partner Code to add to.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalinkId","description":"Permalink of Glossary.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"version","description":"Specific Glossary version to fetch Entries for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"description":"Glossary Entries to add","required":false,"dataType":"GlossaryEntry[]","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Adds GlossaryEntry objects for the specified Glossary.","httpMethod":"POST","errorResponses":[{"reason":"Invalid Content Provider code supplied.","code":404}],"nickname":"addGlossaryEntry","responseClass":"ok"}]},{"path":"/partners.{format}/{contentProvider}/glossary/{permalinkId}/publish","description":"","operations":[{"parameters":[{"name":"contentProvider","description":"Partner Code for Glossary.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalinkId","description":"Permalink of Glossary to publish.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"version","description":"Version to publish.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Publishes a Glossary.","httpMethod":"POST","errorResponses":[{"reason":"Invalid Content Provider code","code":400},{"reason":"Invalid Permalink ID supplied.","code":404}],"nickname":"publishGlossary","responseClass":"ok"}]},{"path":"/partners.{format}/{contentProvider}/glossary/{permalinkId}/clone","description":"","operations":[{"parameters":[{"name":"contentProvider","description":"Partner Code for Glossary.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalinkId","description":"Permalink of Glossary to version.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"version","description":"New version number to assign.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Creates a new version of a Glossary.","httpMethod":"POST","errorResponses":[{"reason":"Invalid Content Provider code","code":400},{"reason":"Invalid Permalink ID supplied.","code":404}],"nickname":"createVersion","responseClass":"Glossary"}]},{"path":"/partners.{format}/{contentProvider}/glossary/{permalinkId}/entries/{word}","description":"","operations":[{"parameters":[{"name":"contentProvider","description":"Partner Code to delete from.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalinkId","description":"Permalink of Glossary.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"word","description":"Word to remove.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"version","description":"Specific Glossary version to fetch Entries for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Removes a GlossaryEntry object from the specified Glossary.","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid word being removed.","code":400},{"reason":"Invalid Content Provider code supplied.","code":404}],"nickname":"deleteGlossaryEntry","responseClass":"ok"}]},{"path":"/partners.{format}/{contentProvider}/glossary/{permalinkId}/deleteEntries","description":"","operations":[{"parameters":[{"name":"contentProvider","description":"Partner Code to delete from.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalinkId","description":"Permalink of Glossary.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Words to remove.","required":false,"dataType":"StringValue[]","allowableValues":[],"allowMultiple":false,"paramType":"body"},{"name":"version","description":"Specific Glossary version to remove Entries from","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Removes a GlossaryEntry object from the specified Glossary.","httpMethod":"POST","errorResponses":[{"reason":"Invalid word being removed.","code":400},{"reason":"Invalid Content Provider code supplied.","code":404}],"nickname":"deleteGlossaryEntries","responseClass":"ok"}]}],"models1":[{"name":"contentProvider","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"Glossary","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"version","required":false,"allowMultiple":false,"paramType":"double"},{"name":"status","required":false,"allowMultiple":false,"paramType":"glossaryStatus"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"permalinkId","required":false,"allowMultiple":false,"paramType":"string"},{"name":"contentProvider","required":false,"allowMultiple":false,"paramType":"contentProvider"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"publishedDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"updatedAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"totalEntries","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"GlossaryEntry","fields":[{"name":"url","required":false,"allowMultiple":false,"paramType":"string"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"example","required":false,"allowMultiple":false,"paramType":"string"},{"name":"title","required":false,"allowMultiple":false,"paramType":"string"},{"name":"note","required":false,"allowMultiple":false,"paramType":"string"},{"name":"glossaryId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"noteType","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"glossaryStatus","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]}],"basePath":"url","swaggerVersion":"1.0"}
View
2 api_docs/suggest.json
@@ -1 +1 @@
-{"resourcePath":"/suggest","models":{"searchResult":{"properties":{"matches":{"type":"int","required":false,"uniqueItems":false},"more":{"type":"int","required":false,"uniqueItems":false},"searchTerm":{"type":"wordResult","required":false,"uniqueItems":false},"match":{"type":"array","required":false,"items":{"$ref":"wordResult","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"searchResult","type":"any","required":false,"uniqueItems":false},"wordResult":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"wordResult","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/suggest.{format}/tags/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"Word fragment to use.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns Word strings based on the input.","httpMethod":"GET","errorResponses":[{"reason":"Invalid Word Fragment supplied.","code":400}],"nickname":"getTagSuggestions","responseClass":"searchResult"}]}],"models1":[{"name":"wordResult","fields":[{"name":"count","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"searchResult","fields":[{"name":"matches","required":false,"allowMultiple":false,"paramType":"int"},{"name":"match","required":false,"allowMultiple":false,"paramType":"List[wordResult]"},{"name":"searchTerm","required":false,"allowMultiple":false,"paramType":"wordResult"},{"name":"more","required":false,"allowMultiple":false,"paramType":"int"}]}],"basePath":"url","swaggerVersion":"1.0"}
+{"resourcePath":"/suggest","basePath":"url","swaggerVersion":"1.0"}
View
2 api_docs/system.json
@@ -1 +1 @@
-{"resourcePath":"/system","models":{"contentProvider":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"contentProvider","type":"any","required":false,"uniqueItems":false},"word":{"properties":{"numericProperties":{"type":"Map[string,double]","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"stringProperties":{"type":"Map[string,string]","required":false,"uniqueItems":false}},"id":"word","type":"any","required":false,"uniqueItems":false},"wordStats":{"properties":{"wordsListedCount":{"type":"long","required":false,"uniqueItems":false},"externalApiCallsCount":{"type":"long","required":false,"uniqueItems":false},"favoritesCount":{"type":"long","required":false,"uniqueItems":false},"wordViewCount":{"type":"long","required":false,"uniqueItems":false},"tokensCount":{"type":"long","required":false,"uniqueItems":false},"sentencesCount":{"type":"long","required":false,"uniqueItems":false},"apiUsersCount":{"type":"long","required":false,"uniqueItems":false},"commentsCount":{"type":"long","required":false,"uniqueItems":false},"audioPronsCount":{"type":"long","required":false,"uniqueItems":false},"listsCount":{"type":"long","required":false,"uniqueItems":false},"documentsCount":{"type":"long","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"elapsedMillis":{"type":"long","required":false,"uniqueItems":false},"userLoginCount":{"type":"long","required":false,"uniqueItems":false},"prettyWordsCount":{"type":"long","required":false,"uniqueItems":false},"usersCount":{"type":"long","required":false,"uniqueItems":false},"taggedObjectsCount":{"type":"long","required":false,"uniqueItems":false},"uniqueWordsCount":{"type":"long","required":false,"uniqueItems":false},"tagsCount":{"type":"long","required":false,"uniqueItems":false}},"id":"wordStats","type":"any","required":false,"uniqueItems":false},"long":{"properties":{"value":{"type":"long","required":false,"uniqueItems":false}},"id":"long","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/system.{format}/providers","description":"","operations":[{"summary":"Returns all defined ContentProviders.","httpMethod":"GET","nickname":"getProviders","responseClass":"List[contentProvider]"}]},{"path":"/system.{format}/stats","description":"","operations":[{"parameters":[{"name":"skip","required":true,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","required":true,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"delta","required":true,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns system-wide statistics for the platform.","httpMethod":"GET","nickname":"getStats","responseClass":"List[wordStats]"}]},{"path":"/system.{format}/{word}/related","description":"","operations":[{"parameters":[{"name":"word","description":"Word to find related items for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"type","description":"Relationship type","required":false,"dataType":"string","allowableValues":["synonym","antonym","variant","equivalent","cross-reference","related-word","rhyme","form","etymologically-related-term","hypernym","hyponym","inflected-form","primary","same-context","verb-form","verb-stem","unknown"],"allowMultiple":false,"paramType":"query"}],"summary":"Returns weighted terms related to the input word","httpMethod":"GET","errorResponses":[{"reason":"No data found.","code":404}],"nickname":"getRelatedWords","responseClass":"relatedWord"}]},{"path":"/system.{format}/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to find attributes for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"useLiteral","description":"Use exact word","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns a word with attributes","httpMethod":"GET","errorResponses":[{"reason":"No data found.","code":404}],"nickname":"getRelatedWords","responseClass":"word"}]},{"path":"/system.{format}/graph","description":"","operations":[{"parameters":[{"name":"term","description":"Term to query","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"objectType","description":"Object type","required":false,"dataType":"string","allowableValues":["word"],"allowMultiple":false,"paramType":"query"},{"name":"excludeEdgeTypes","description":"Relationships to exclude","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"includeEdgeTypes","description":"Specifies the only relationship to include (note, this overrides the exclusions)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"startConstraints","description":"Edge start constraints to enforce","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"endConstraints","description":"Edge end constraints to enforce","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxHops","defaultValue":"2","description":"Maximum number of to route","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxResults","defaultValue":"2","description":"Maximum number of routes to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"destination","description":"Destination to route to (VERY inefficient)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"useGraphML","description":"Return is GraphML format","required":false,"dataType":"string","allowableValues":["true","false"],"allowMultiple":false,"paramType":"query"},{"name":"goal","description":"Selection goal","required":false,"dataType":"string","allowableValues":["content","similar","basic-form"],"allowMultiple":false,"paramType":"query"}],"summary":"Returns a graph response for the supplied terms","httpMethod":"GET","errorResponses":[{"reason":"Invalid query.","code":400},{"reason":"No data found.","code":404}],"nickname":"getWordById","responseClass":"com.wordnik.graph.RouteResponse"}]},{"path":"/system.{format}/audioRecordId","description":"","operations":[{"summary":"Gets an Audio File ID for recording.","httpMethod":"GET","nickname":"getAudioRecordId","responseClass":"long"}]},{"path":"/system.{format}/audioDuration","description":"","operations":[{"parameters":[{"name":"audioFileId","description":"Audio file id","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"duration","description":"Audio duration","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Sets duration of an Audio File","httpMethod":"POST","errorResponses":[{"reason":"Invalid audio file id supplied.","code":400}],"nickname":"setAudioDuration","responseClass":"ok"}]}],"models1":[{"name":"wordStats","fields":[{"name":"sentencesCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"uniqueWordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"apiUsersCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"audioPronsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"commentsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"documentsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"externalApiCallsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"favoritesCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"listsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"userLoginCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"prettyWordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"taggedObjectsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"tagsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"tokensCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordsListedCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordViewCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"usersCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"elapsedMillis","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"contentProvider","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"word","fields":[{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"stringProperties","required":false,"allowMultiple":false,"paramType":"Map[string,string]"},{"name":"numericProperties","required":false,"allowMultiple":false,"paramType":"Map[string,double]"}]},{"name":"long","fields":[{"name":"value","required":false,"allowMultiple":false,"paramType":"long"}]}],"basePath":"url","swaggerVersion":"1.0"}
+{"resourcePath":"/system","models":{"word":{"properties":{"numericProperties":{"type":"Map[string,double]"},"word":{"type":"string"},"stringProperties":{"type":"Map[string,string]"}},"id":"word"}},"apis":[{"path":"/system.{format}/{word}/related","description":"","operations":[{"parameters":[{"name":"word","description":"Word to find related items for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"type","description":"Relationship type","required":false,"dataType":"string","allowableValues":["synonym","antonym","variant","equivalent","cross-reference","related-word","rhyme","form","etymologically-related-term","hypernym","hyponym","inflected-form","primary","same-context","verb-form","verb-stem","unknown"],"allowMultiple":false,"paramType":"query"}],"summary":"Returns weighted terms related to the input word","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":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"useLiteral","description":"Use exact word","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns a word with attributes","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","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"objectType","description":"Object type","required":false,"dataType":"string","allowableValues":["word"],"allowMultiple":false,"paramType":"query"},{"name":"excludeEdgeTypes","description":"Relationships to exclude","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"includeEdgeTypes","description":"Specifies the only relationship to include (note, this overrides the exclusions)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"startConstraints","description":"Edge start constraints to enforce","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"endConstraints","description":"Edge end constraints to enforce","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxHops","defaultValue":"2","description":"Maximum number of to route","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxResults","defaultValue":"2","description":"Maximum number of routes to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"destination","description":"Destination to route to (VERY inefficient)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"useGraphML","description":"Return is GraphML format","required":false,"dataType":"string","allowableValues":["true","false"],"allowMultiple":false,"paramType":"query"},{"name":"goal","description":"Selection goal","required":false,"dataType":"string","allowableValues":["content","similar","basic-form"],"allowMultiple":false,"paramType":"query"}],"summary":"Returns a graph response for the supplied terms","responseTypeInternal":"com.wordnik.graph.RouteResponse","errorResponses":[{"reason":"Invalid query.","code":400},{"reason":"No data found.","code":404}],"nickname":"getWordById","responseClass":"com.wordnik.graph.RouteResponse","httpMethod":"GET"}]}],"basePath":"url","swaggerVersion":"1.0"}
View
1 api_docs/tag.json
@@ -1 +0,0 @@
-{"resourcePath":"/tag","models":{"wordObject":{"properties":{"word":{"type":"string","required":false,"uniqueItems":false},"vulgar":{"type":"string","required":false,"uniqueItems":false}},"id":"wordObject","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/tag.{format}/{tag}/word","description":"","operations":[{"parameters":[{"name":"tag","description":"Tag to fetch words for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"userName","description":"Username to restrict results to","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches Words with a specific Tag.","httpMethod":"GET","errorResponses":[{"reason":"Invalid Tag supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getWordsTagged","responseClass":"List[wordObject]"}]}],"models1":[{"name":"wordObject","fields":[{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"vulgar","required":false,"allowMultiple":false,"paramType":"string"}]}],"basePath":"url","swaggerVersion":"1.0"}
View
2 api_docs/user.json
@@ -1 +1 @@
-{"resourcePath":"/user","models":{"SubscriptionStatus":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"SubscriptionStatus","type":"any","required":false,"uniqueItems":false},"wordOfTheDayList":{"properties":{"subscriptionNamespace":{"type":"string","required":false,"uniqueItems":false},"subscriberCount":{"type":"int","required":false,"uniqueItems":false},"commentCount":{"type":"int","required":false,"uniqueItems":false},"subscriptionIdentifier":{"type":"string","required":false,"uniqueItems":false},"firstItemDate":{"type":"Date","required":false,"uniqueItems":false},"voteCount":{"type":"integer","required":false,"uniqueItems":false},"id":{"type":"string","required":true,"uniqueItems":false},"category":{"type":"string","required":false,"uniqueItems":false},"createdBy":{"type":"string","required":false,"uniqueItems":false},"items":{"type":"array","required":false,"items":{"$ref":"WordOfTheDay","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"voteWeightedAverage":{"type":"float","required":false,"uniqueItems":false},"subscriptionSchedule":{"type":"string","required":false,"uniqueItems":false},"lastItemDate":{"type":"Date","required":false,"uniqueItems":false},"voteAverage":{"type":"float","required":false,"uniqueItems":false},"itemCount":{"type":"int","required":false,"uniqueItems":false},"subscriptionStatus":{"type":"string","required":false,"uniqueItems":false}},"id":"wordOfTheDayList","type":"any","required":false,"uniqueItems":false},"Principal":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"token":{"type":"string","required":false,"uniqueItems":false},"wordnikUserId":{"type":"long","required":false,"uniqueItems":false},"type":{"type":"int","required":false,"uniqueItems":false}},"id":"Principal","type":"any","required":false,"uniqueItems":false},"UserHandle":{"properties":{"webService":{"type":"int","required":false,"uniqueItems":false},"handle":{"type":"string","required":false,"uniqueItems":false}},"id":"UserHandle","type":"any","required":false,"uniqueItems":false},"tag":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"count":{"type":"long","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"tag","type":"any","required":false,"uniqueItems":false},"userTagHistory":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"wordId":{"type":"long","required":false,"uniqueItems":false},"tagDate":{"type":"Date","required":false,"uniqueItems":false},"tag":{"type":"string","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"tagId":{"type":"long","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"userTagHistory","type":"any","required":false,"uniqueItems":false},"WordOfTheDay":{"properties":{"id":{"type":"long","required":true,"uniqueItems":false},"parentId":{"type":"string","required":false,"uniqueItems":false},"category":{"type":"string","required":false,"uniqueItems":false},"definition":{"type":"array","required":false,"items":{"$ref":"SimpleDefinition","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"createdBy":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"contentProvider":{"type":"contentProvider","required":false,"uniqueItems":false},"htmlExtra":{"type":"string","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"example":{"type":"array","required":false,"items":{"$ref":"SimpleExample","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"note":{"type":"string","required":false,"uniqueItems":false},"publishDate":{"type":"Date","required":false,"uniqueItems":false}},"id":"WordOfTheDay","type":"any","required":false,"uniqueItems":false},"long":{"properties":{"value":{"type":"long","required":false,"uniqueItems":false}},"id":"long","type":"any","required":false,"uniqueItems":false},"UgcSummary":{"properties":{"ugcEvents":{"type":"Map[string,Date]","required":false,"uniqueItems":false},"ugcLabels":{"type":"Map[string,string]","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"ugcCounters":{"type":"Map[string,long]","required":false,"uniqueItems":false}},"id":"UgcSummary","type":"any","required":false,"uniqueItems":false},"SimpleDefinition":{"properties":{"text":{"type":"string","required":false,"uniqueItems":false},"source":{"type":"string","required":false,"uniqueItems":false},"note":{"type":"string","required":false,"uniqueItems":false},"partOfSpeech":{"type":"string","required":false,"uniqueItems":false}},"id":"SimpleDefinition","type":"any","required":false,"uniqueItems":false},"wordObject":{"properties":{"word":{"type":"string","required":false,"uniqueItems":false},"vulgar":{"type":"string","required":false,"uniqueItems":false}},"id":"wordObject","type":"any","required":false,"uniqueItems":false},"UserTrackingInfo":{"properties":{"signupDate":{"type":"Date","required":false,"uniqueItems":false},"lastLoginDate":{"type":"Date","required":false,"uniqueItems":false},"noOfLogins":{"type":"int","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"lastUpdatedDate":{"type":"Date","required":false,"uniqueItems":false},"signupIPAddress":{"type":"string","required":false,"uniqueItems":false}},"id":"UserTrackingInfo","type":"any","required":false,"uniqueItems":false},"audioObject":{"properties":{"recordId":{"type":"string","required":false,"uniqueItems":false},"wordId":{"type":"long","required":false,"uniqueItems":false},"audioFileType":{"type":"audioType","required":false,"uniqueItems":false},"filePath":{"type":"string","required":false,"uniqueItems":false},"type":{"type":"audioType","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"duration":{"type":"double","required":false,"uniqueItems":false},"createdBy":{"type":"string","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"streamPath":{"type":"string","required":false,"uniqueItems":false},"audioFileId":{"type":"long","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"audioObject","type":"any","required":false,"uniqueItems":false},"wordList":{"properties":{"updatedAt":{"type":"Date","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"username":{"type":"string","required":false,"uniqueItems":false},"permalink":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"numberWordsInList":{"type":"long","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false}},"id":"wordList","type":"any","required":false,"uniqueItems":false},"SubscriptionType":{"properties":{"items":{"type":"array","required":false,"items":{"$ref":"SubscriptionItem","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"SubscriptionType","type":"any","required":false,"uniqueItems":false},"UserSettings":{"properties":{"bossURL":{"type":"string","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false}},"id":"UserSettings","type":"any","required":false,"uniqueItems":false},"audioType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"audioType","type":"any","required":false,"uniqueItems":false},"SubscriptionItem":{"properties":{"createdAt":{"type":"Date","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"medium":{"type":"string","required":false,"uniqueItems":false}},"id":"SubscriptionItem","type":"any","required":false,"uniqueItems":false},"recentLookup":{"properties":{"createdAt":{"type":"Date","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"recentLookup","type":"any","required":false,"uniqueItems":false},"contentProvider":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"contentProvider","type":"any","required":false,"uniqueItems":false},"UserProfile":{"properties":{"lastName":{"type":"string","required":false,"uniqueItems":false},"mostFavoriteWord":{"type":"string","required":false,"uniqueItems":false},"location":{"type":"string","required":false,"uniqueItems":false},"seekingWord":{"type":"string","required":false,"uniqueItems":false},"leastFavoriteWord":{"type":"string","required":false,"uniqueItems":false},"onomaTopoeiaWord":{"type":"string","required":false,"uniqueItems":false},"siteUrl":{"type":"string","required":false,"uniqueItems":false},"bio":{"type":"string","required":false,"uniqueItems":false},"userHandles":{"type":"array","required":false,"items":{"$ref":"UserHandle","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"youWord":{"type":"string","required":false,"uniqueItems":false},"firstName":{"type":"string","required":false,"uniqueItems":false},"siteName":{"type":"string","required":false,"uniqueItems":false}},"id":"UserProfile","type":"any","required":false,"uniqueItems":false},"comment":{"properties":{"updatedAt":{"type":"Date","required":false,"uniqueItems":false},"id":{"type":"string","required":false,"uniqueItems":false},"body":{"type":"string","required":false,"uniqueItems":false},"commentedOn":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"objectId":{"type":"long","required":false,"uniqueItems":false},"commentedBy":{"type":"string","required":false,"uniqueItems":false},"objectType":{"type":"string","required":false,"uniqueItems":false}},"id":"comment","type":"any","required":false,"uniqueItems":false},"SimpleExample":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"title":{"type":"string","required":false,"uniqueItems":false},"text":{"type":"string","required":false,"uniqueItems":false},"url":{"type":"string","required":false,"uniqueItems":false}},"id":"SimpleExample","type":"any","required":false,"uniqueItems":false},"user":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"email":{"type":"string","required":false,"uniqueItems":false},"status":{"type":"int","required":false,"uniqueItems":false},"faceBookId":{"type":"string","required":false,"uniqueItems":false},"userName":{"type":"string","required":false,"uniqueItems":false},"displayName":{"type":"string","required":false,"uniqueItems":false},"password":{"type":"string","required":false,"uniqueItems":false}},"id":"user","type":"any","required":false,"uniqueItems":false},"partOfSpeech":{"properties":{"roots":{"type":"array","required":false,"items":{"$ref":"root","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"partOfSpeech","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/user.{format}/{username}/wordOfTheDayList","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"includeAll","description":"Include future words (owner-only)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns a user's WordOfTheDayList","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"No WordOfTheDayList available","code":404}],"nickname":"getWordOfTheDayList","responseClass":"wordOfTheDayList"},{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"WordOfTheDayList to create, provided in the format specified by the URL","required":true,"dataType":"wordOfTheDayList","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Creates a WordOfTheDayList","httpMethod":"POST","errorResponses":[{"reason":"User already has a list or list is invalid","code":400},{"reason":"User not found","code":404}],"nickname":"createWordOfTheDayList","responseClass":"wordOfTheDayList","notes":"A user can have only one WordOfTheDayList."},{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Updated WordOfTheDayList data in the format specified by the URL","required":true,"dataType":"wordOfTheDayList","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Updates a user's WordOfTheDayList","httpMethod":"PUT","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"Not authorized to perform update","code":403},{"reason":"No WordOfTheDayList available","code":404}],"nickname":"updateWordOfTheDayList","responseClass":"ok"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalink","description":"Permalink of WordOfTheDayList to delete","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Deletes a user's WordOfTheDayList","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"Not authorized to perform update","code":403},{"reason":"No WordOfTheDayList available","code":404}],"nickname":"updateWordOfTheDayList","responseClass":"ok"},{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalink","description":"Permalink of the WordOfTheDayList to add the WordOfTheDay to","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"WordOfTheDay to add, in the format specified by the URL","required":true,"dataType":"WordOfTheDay","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Adds a WordOfTheDay to a user's WordOfTheDayList","httpMethod":"PUT","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"nickname":"updateItemInWordOfTheDayList","responseClass":"ok"}]},{"path":"/user.{format}/{username}/profile","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch profile for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns a UserProfile","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getUserProfile","responseClass":"UserProfile"},{"parameters":[{"name":"username","description":"Username to fetch profile for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Updated UserProfile.","required":false,"dataType":"UserProfile","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Updates a UserProfile","httpMethod":"PUT","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"updateUserProfile","responseClass":"ok"}]},{"path":"/user.{format}/{username}/trackingInfo","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch tracking info for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns a user's tracking info","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getUserTrackingInfo","responseClass":"UserTrackingInfo"}]},{"path":"/user.{format}/{username}","description":"","operations":[{"parameters":[{"name":"username","description":"Username to update.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Updated User object.","required":false,"dataType":"user","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Updates a User","httpMethod":"PUT","errorResponses":[{"reason":"Invalid username supplied or username/email already in use.","code":400},{"reason":"User not found","code":404}],"nickname":"updateUser","responseClass":"ok"},{"parameters":[{"name":"username","description":"Username to get.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches a User","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found","code":404}],"nickname":"getUser","responseClass":"user"},{"parameters":[{"name":"username","description":"Username to update.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Deletes a User","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid username supplied or username/email already in use.","code":400},{"reason":"User not found","code":404}],"nickname":"deleteUser","responseClass":"ok"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}/add","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalink","description":"WordOfTheDayList to modify","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"WordOfTheDay to add","required":true,"dataType":"WordOfTheDay","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Adds an item to a user's WordOfTheDayList","httpMethod":"PUT","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"nickname":"addWordToWordOfTheDayList","responseClass":"ok"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}/{wordToDelete}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalink","description":"Permalink of WordOfTheDayList to delete a word from","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"wordToDelete","description":"Word to delete","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Deletes a specific word from a user's WordOfTheDayList","httpMethod":"DELETE","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"nickname":"deleteWordFromWordOfTheDayList","responseClass":"ok"}]},{"path":"/user.{format}/{username}/wordOfTheDay/{date}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDay owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"date","description":"Date of the WordOfTheDay to retrieve (yyyy-MM-dd) format","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"includeAll","description":"Include WordOfTheDay items for future dates (owner-only)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns the WordOfTheDay for a given user on a given date","httpMethod":"GET","errorResponses":[{"reason":"Invalid username or dateString supplied","code":400},{"reason":"User not found or no list available","code":404}],"nickname":"getWordOfTheDayByDate","responseClass":"WordOfTheDay"}]},{"path":"/user.{format}/{username}/wordLists","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch WordLists for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"sortBy","defaultValue":"createDate","description":"Field to sort by","required":false,"dataType":"string","allowableValues":["alpha","createDate","editDate"],"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","defaultValue":"desc","description":"Direction to sort","required":false,"dataType":"string","allowableValues":["asc","desc"],"allowMultiple":false,"paramType":"query"}],"summary":"Gets WordLists for a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found","code":404}],"nickname":"getUserWordLists","responseClass":"List[wordList]"}]},{"path":"/user.{format}/{username}/wordListsCount","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch WordLists for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Gets the count of WordLists for a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found","code":404}],"nickname":"getUserWordListCount","responseClass":"long"}]},{"path":"/user.{format}/{username}/settings","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch settings for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns a user's settings","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getUserSettings","responseClass":"UserSettings"},{"parameters":[{"name":"username","description":"Username to fetch profile for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Updated UserSettings.","required":false,"dataType":"UserSettings","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Updates a user's settings","httpMethod":"PUT","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"updateUserSettings","responseClass":"ok"}]},{"path":"/user.{format}/{username}/apiKey","description":"","operations":[{"parameters":[{"name":"username","description":"Username to fetch api key for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns the API key for the specified user","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404},{"reason":"API key not found","code":409}],"nickname":"getApiKeyForUser","responseClass":"Principal","notes":"Use the super user API key for getting this information or auth token of the user who is requesting the API key"}]},{"path":"/user.{format}/{username}/comment","description":"","operations":[{"parameters":[{"name":"username","description":"Username to comment on.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Comment to save.","required":false,"dataType":"comment","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Adds a Comment on a User","httpMethod":"POST","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"commentOnUser","responseClass":"comment"},{"parameters":[{"name":"username","description":"Username with Comment.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Updated Comment.","required":false,"dataType":"comment","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Updates a Comment on a User","httpMethod":"PUT","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"updateCommentOnUser","responseClass":"comment"}]},{"path":"/user.{format}/{username}/comment/{commentId}","description":"","operations":[{"parameters":[{"name":"username","description":"Username with Comment.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Updated Comment.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Deletes a Comment on a User","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"deleteCommentOnUser","responseClass":"ok"},{"parameters":[{"name":"username","description":"Username with Comment.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Comment ID.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches a comment by ID","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getCommentOnUserById","responseClass":"comment"}]},{"path":"/user.{format}/{username}/commentsOnCount","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns a count of Comments on a user","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getCommentsOnUserCount","responseClass":"long"}]},{"path":"/user.{format}/{username}/commentsByCount","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count by.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Returns a count of Comments by a user","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getCommentsByUserCount","responseClass":"long"}]},{"path":"/user.{format}/{username}/commentsBy","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count by.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Sort order","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns Comments by a user","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getCommentsByUser","responseClass":"List[comment]"}]},{"path":"/user.{format}/{username}/commentsOnUser","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get count by.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Sort order","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns Comments on a user","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getCommentsOnUser","responseClass":"List[comment]"}]},{"path":"/user.{format}/{username}/ugcSummary","description":"","operations":[{"parameters":[{"name":"username","description":"Username to get statistics for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Sort order","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns UgcSummary info a user","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"User not found","code":404}],"nickname":"getUgcSummaryForUser","responseClass":"UgcSummary"}]},{"path":"/user.{format}/{user}/tagHistory","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch History for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches TagHistory for a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserTagHistory","responseClass":"List[userTagHistory]"}]},{"path":"/user.{format}/{user}/tags","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Tags for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches Tags by a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserTags","responseClass":"List[tag]"}]},{"path":"/user.{format}/{user}/tagCount","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Tag count for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches the count of Tags created by a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"nickname":"getUserTagCount","responseClass":"long"}]},{"path":"/user.{format}/{user}/subscriptions","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch subscriptions for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches all subscriptions for a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"Not authorized to fetch subscriptions.","code":403},{"reason":"User not found.","code":404}],"nickname":"getSubscriptions","responseClass":"List[SubscriptionType]"}]},{"path":"/user.{format}/{user}/subscriptions/{objectType}/{objectIdentifier}","description":"","operations":[{"parameters":[{"name":"user","description":"User to add subscriptions to","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"objectType","description":"Object Type","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"objectIdentifier","description":"Object Identifier","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"medium","description":"Subscription medium","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Subscribes to an object.","httpMethod":"POST","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"Not authorized to subscribe user to WordOfTheDayList.","code":403},{"reason":"User not found to filter by.","code":404}],"nickname":"addSubscription","responseClass":"ok"},{"parameters":[{"name":"user","description":"User to add subscriptions to","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"objectType","description":"Object Type","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"objectIdentifier","description":"Object Identifier","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"medium","description":"Subscription medium","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Deletes a subscription to an object.","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"Not authorized to subscribe user to WordOfTheDayList.","code":403},{"reason":"User not found to filter by.","code":404}],"nickname":"removeSubscription","responseClass":"ok"}]},{"path":"/user.{format}/{user}/favorites/words","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite Words for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches Favorite Words for a user.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserFavoriteWords","responseClass":"List[wordObject]"}]},{"path":"/user.{format}/{user}/favorites/wordCount","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite Words for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches favorite word count for a user.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserFavoriteCount","responseClass":"long"}]},{"path":"/user.{format}/{user}/favorites/wordLists","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite WordLists for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"access","description":"Filters results by access","required":false,"dataType":"string","allowableValues":["public","private"],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches Favorite WordLists for a user.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserFavoriteWordLists","responseClass":"List[wordList]"}]},{"path":"/user.{format}/{user}/favorites/wordListCount","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch Favorite WordList count for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches Favorite WordList count for a user.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserFavoriteWordListsCount","responseClass":"long"}]},{"path":"/user.{format}/{user}/searches","description":"","operations":[{"parameters":[{"name":"user","description":"User to fetch History for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches SearchHistory for a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found to filter by.","code":404}],"nickname":"getUserSearchHistory","responseClass":"List[recentLookup]"},{"parameters":[{"name":"user","description":"User to remove search history for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"word","description":"Word to delete","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches SearchHistory for a User.","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"nickname":"removeUserSearchHistoryItem","responseClass":"List[recentLookup]"}]},{"path":"/user.{format}/{user}/totalSearches","description":"","operations":[{"parameters":[{"name":"user","description":"User to retrieve search count for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches the total search count for a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"nickname":"getUserSearchHistoryCount","responseClass":"Long"}]},{"path":"/user.{format}/{user}/pronunciations","description":"","operations":[{"parameters":[{"name":"user","description":"User to retrieve search count for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches the total search count for a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"nickname":"getUserPronunciations","responseClass":"List[audioObject]"}]},{"path":"/user.{format}/{user}/activitystream","description":"","operations":[{"parameters":[{"name":"user","description":"User to retrieve search count for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches the total search count for a User.","httpMethod":"GET","errorResponses":[{"reason":"Invalid username supplied.","code":400},{"reason":"User not found.","code":404}],"nickname":"getUserActivityStream","responseClass":"Long"}]}],"models1":[{"name":"Principal","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"type","required":false,"allowMultiple":false,"paramType":"int"},{"name":"token","required":false,"allowMultiple":false,"paramType":"string"},{"name":"wordnikUserId","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"tag","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"count","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"userTagHistory","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"tag","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"wordId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"tagId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"tagDate","required":false,"allowMultiple":false,"paramType":"Date"}]},{"name":"long","fields":[{"name":"value","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"wordOfTheDayList","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":true,"allowMultiple":false,"paramType":"string"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"category","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"items","required":false,"allowMultiple":false,"paramType":"List[WordOfTheDay]"},{"name":"subscriberCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"subscriptionStatus","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"commentCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"voteCount","required":false,"allowMultiple":false,"paramType":"integer"},{"name":"voteAverage","required":false,"allowMultiple":false,"paramType":"float"},{"name":"voteWeightedAverage","required":false,"allowMultiple":false,"paramType":"float"},{"name":"itemCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"firstItemDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"lastItemDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"subscriptionSchedule","required":false,"allowMultiple":false,"paramType":"string"},{"name":"subscriptionNamespace","required":false,"allowMultiple":false,"paramType":"string"},{"name":"subscriptionIdentifier","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"SubscriptionType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"items","required":false,"allowMultiple":false,"paramType":"List[SubscriptionItem]"}]},{"name":"contentProvider","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"audioType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"audioType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"SimpleDefinition","fields":[{"name":"text","required":false,"allowMultiple":false,"paramType":"string"},{"name":"partOfSpeech","required":false,"allowMultiple":false,"paramType":"string"},{"name":"note","required":false,"allowMultiple":false,"paramType":"string"},{"name":"source","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"wordObject","fields":[{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"vulgar","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"UserHandle","fields":[{"name":"webService","required":false,"allowMultiple":false,"paramType":"int"},{"name":"handle","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"SubscriptionItem","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"medium","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"}]},{"name":"UserTrackingInfo","fields":[{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"noOfLogins","required":false,"allowMultiple":false,"paramType":"int"},{"name":"signupDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"signupIPAddress","required":false,"allowMultiple":false,"paramType":"string"},{"name":"lastUpdatedDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"lastLoginDate","required":false,"allowMultiple":false,"paramType":"Date"}]},{"name":"comment","fields":[{"name":"objectType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"objectId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"commentedBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"id","required":false,"allowMultiple":false,"paramType":"string"},{"name":"commentedOn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"body","required":false,"allowMultiple":false,"paramType":"string"},{"name":"updatedAt","required":false,"allowMultiple":false,"paramType":"Date"}]},{"name":"partOfSpeech","fields":[{"name":"roots","required":false,"allowMultiple":false,"paramType":"List[root]"}]},{"name":"recentLookup","fields":[{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"}]},{"name":"UserProfile","fields":[{"name":"location","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"firstName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"lastName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"bio","required":false,"allowMultiple":false,"paramType":"string"},{"name":"siteUrl","required":false,"allowMultiple":false,"paramType":"string"},{"name":"leastFavoriteWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"mostFavoriteWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"onomaTopoeiaWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"seekingWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"youWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userHandles","required":false,"allowMultiple":false,"paramType":"List[UserHandle]"},{"name":"siteName","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"wordList","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"type","required":false,"allowMultiple":false,"paramType":"string"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"permalink","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"username","required":false,"allowMultiple":false,"paramType":"string"},{"name":"updatedAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"numberWordsInList","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"WordOfTheDay","fields":[{"name":"id","required":true,"allowMultiple":false,"paramType":"long"},{"name":"category","required":false,"allowMultiple":false,"paramType":"string"},{"name":"example","required":false,"wrapperName":"examples","allowMultiple":false,"paramType":"List[SimpleExample]"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"definition","required":false,"wrapperName":"definitions","allowMultiple":false,"paramType":"List[SimpleDefinition]"},{"name":"contentProvider","required":false,"allowMultiple":false,"paramType":"contentProvider"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"publishDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"parentId","required":false,"allowMultiple":false,"paramType":"string"},{"name":"note","required":false,"allowMultiple":false,"paramType":"string"},{"name":"htmlExtra","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"UserSettings","fields":[{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"bossURL","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"SubscriptionStatus","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"UgcSummary","fields":[{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"ugcEvents","required":false,"allowMultiple":false,"paramType":"Map[string,Date]"},{"name":"ugcCounters","required":false,"allowMultiple":false,"paramType":"Map[string,long]"},{"name":"ugcLabels","required":false,"allowMultiple":false,"paramType":"Map[string,string]"}]},{"name":"audioObject","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"type","required":false,"allowMultiple":false,"paramType":"audioType"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"duration","required":false,"allowMultiple":false,"paramType":"double"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"audioFileType","required":false,"allowMultiple":false,"paramType":"audioType"},{"name":"audioFileId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"filePath","required":false,"allowMultiple":false,"paramType":"string"},{"name":"wordId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"recordId","required":false,"allowMultiple":false,"paramType":"string"},{"name":"streamPath","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"SimpleExample","fields":[{"name":"url","required":false,"allowMultiple":false,"paramType":"string"},{"name":"text","required":false,"allowMultiple":false,"paramType":"string"},{"name":"title","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"user","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"displayName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"status","required":false,"allowMultiple":false,"paramType":"int"},{"name":"password","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"email","required":false,"allowMultiple":false,"paramType":"string"},{"name":"faceBookId","required":false,"allowMultiple":false,"paramType":"string"}]}],"basePath":"url","swaggerVersion":"1.0"}
+{"resourcePath":"/user","models":{"SubscriptionStatus":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"SubscriptionStatus"},"wordOfTheDayList":{"properties":{"subscriptionNamespace":{"type":"string"},"subscriberCount":{"type":"int"},"commentCount":{"type":"int"},"subscriptionIdentifier":{"type":"string"},"firstItemDate":{"type":"Date"},"voteCount":{"type":"integer"},"id":{"type":"string","required":true},"category":{"type":"string"},"createdBy":{"type":"string"},"items":{"type":"array","items":{"$ref":"WordOfTheDay"}},"description":{"type":"string"},"createdAt":{"type":"Date"},"name":{"type":"string"},"voteWeightedAverage":{"type":"float"},"subscriptionSchedule":{"type":"string"},"lastItemDate":{"type":"Date"},"voteAverage":{"type":"float"},"itemCount":{"type":"int"},"subscriptionStatus":{"type":"string"}},"id":"wordOfTheDayList"},"SimpleDefinition":{"properties":{"text":{"type":"string"},"source":{"type":"string"},"note":{"type":"string"},"partOfSpeech":{"type":"string"}},"id":"SimpleDefinition"},"WordOfTheDay":{"properties":{"id":{"type":"long","required":true},"parentId":{"type":"string"},"category":{"type":"string"},"definition":{"type":"array","items":{"$ref":"SimpleDefinition"}},"createdBy":{"type":"string"},"createdAt":{"type":"Date"},"contentProvider":{"type":"contentProvider"},"htmlExtra":{"type":"string"},"word":{"type":"string"},"example":{"type":"array","items":{"$ref":"SimpleExample"}},"note":{"type":"string"},"publishDate":{"type":"Date"}},"id":"WordOfTheDay"},"contentProvider":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"contentProvider"},"SimpleExample":{"properties":{"id":{"type":"long"},"title":{"type":"string"},"text":{"type":"string"},"url":{"type":"string"}},"id":"SimpleExample"},"partOfSpeech":{"properties":{"roots":{"type":"array","items":{"$ref":"root"}}},"id":"partOfSpeech"}},"apis":[{"path":"/user.{format}/{username}/wordOfTheDayList","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"includeAll","description":"Include future words (owner-only)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns a user's WordOfTheDayList","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","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"WordOfTheDayList to create, provided in the format specified by the URL","required":true,"dataType":"wordOfTheDayList","allowableValues":[],"valueTypeInternal":"com.wordnik.corpus.updated.entity.WordOfTheDayList","allowMultiple":false,"paramType":"body"}],"summary":"Creates a WordOfTheDayList","responseTypeInternal":"com.wordnik.corpus.updated.entity.WordOfTheDayList","errorResponses":[{"reason":"User already has a list or list is invalid","code":400},{"reason":"User not found","code":404}],"nickname":"createWordOfTheDayList","responseClass":"wordOfTheDayList","notes":"A user can have only one WordOfTheDayList.","httpMethod":"POST"},{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Updated WordOfTheDayList data in the format specified by the URL","required":true,"dataType":"wordOfTheDayList","allowableValues":[],"valueTypeInternal":"com.wordnik.corpus.updated.entity.WordOfTheDayList","allowMultiple":false,"paramType":"body"}],"summary":"Updates a user's WordOfTheDayList","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"Not authorized to perform update","code":403},{"reason":"No WordOfTheDayList available","code":404}],"nickname":"updateWordOfTheDayList","responseClass":"ok","httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalink","description":"Permalink of WordOfTheDayList to delete","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Deletes a user's WordOfTheDayList","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","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalink","description":"Permalink of the WordOfTheDayList to add the WordOfTheDay to","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"WordOfTheDay to add, in the format specified by the URL","required":true,"dataType":"WordOfTheDay","allowableValues":[],"valueTypeInternal":"com.wordnik.community.entity.WordOfTheDay","allowMultiple":false,"paramType":"body"}],"summary":"Adds a WordOfTheDay to a user's WordOfTheDayList","responseTypeInternal":"ok","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"nickname":"updateItemInWordOfTheDayList","responseClass":"ok","httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}/add","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalink","description":"WordOfTheDayList to modify","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"WordOfTheDay to add","required":true,"dataType":"WordOfTheDay","allowableValues":[],"valueTypeInternal":"com.wordnik.community.entity.WordOfTheDay","allowMultiple":false,"paramType":"body"}],"summary":"Adds an item to a user's WordOfTheDayList","responseTypeInternal":"ok","errorResponses":[{"reason":"WordOfTheDay already scheduled on this date","code":400},{"reason":"Not authorized to perform modification","code":403},{"reason":"No WordOfTheDayList available to add to","code":404}],"nickname":"addWordToWordOfTheDayList","responseClass":"ok","httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}/{wordToDelete}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"permalink","description":"Permalink of WordOfTheDayList to delete a word from","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"wordToDelete","description":"Word to delete","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Deletes a specific word from a user's WordOfTheDayList","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","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"date","description":"Date of the WordOfTheDay to retrieve (yyyy-MM-dd) format","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"includeAll","description":"Include WordOfTheDay items for future dates (owner-only)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns the WordOfTheDay for a given user on a given date","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"}]}],"basePath":"url","swaggerVersion":"1.0"}
View
1 api_docs/users.json
@@ -1 +0,0 @@
-{"resourcePath":"/users","models":{"wordObject":{"properties":{"word":{"type":"string","required":false,"uniqueItems":false},"vulgar":{"type":"string","required":false,"uniqueItems":false}},"id":"wordObject","type":"any","required":false,"uniqueItems":false},"UserSummary":{"properties":{"totalListedWordsCount":{"type":"long","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"userName":{"type":"string","required":false,"uniqueItems":false}},"id":"UserSummary","type":"any","required":false,"uniqueItems":false},"comment":{"properties":{"updatedAt":{"type":"Date","required":false,"uniqueItems":false},"id":{"type":"string","required":false,"uniqueItems":false},"body":{"type":"string","required":false,"uniqueItems":false},"commentedOn":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"objectId":{"type":"long","required":false,"uniqueItems":false},"commentedBy":{"type":"string","required":false,"uniqueItems":false},"objectType":{"type":"string","required":false,"uniqueItems":false}},"id":"comment","type":"any","required":false,"uniqueItems":false},"user":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"email":{"type":"string","required":false,"uniqueItems":false},"status":{"type":"int","required":false,"uniqueItems":false},"faceBookId":{"type":"string","required":false,"uniqueItems":false},"userName":{"type":"string","required":false,"uniqueItems":false},"displayName":{"type":"string","required":false,"uniqueItems":false},"password":{"type":"string","required":false,"uniqueItems":false}},"id":"user","type":"any","required":false,"uniqueItems":false},"audioObject":{"properties":{"recordId":{"type":"string","required":false,"uniqueItems":false},"wordId":{"type":"long","required":false,"uniqueItems":false},"audioFileType":{"type":"audioType","required":false,"uniqueItems":false},"filePath":{"type":"string","required":false,"uniqueItems":false},"type":{"type":"audioType","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"duration":{"type":"double","required":false,"uniqueItems":false},"createdBy":{"type":"string","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"streamPath":{"type":"string","required":false,"uniqueItems":false},"audioFileId":{"type":"long","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"audioObject","type":"any","required":false,"uniqueItems":false},"audioType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"audioType","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/users.{format}/pronunciations","description":"","operations":[{"parameters":[{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches recent AudioPron objects","httpMethod":"GET","nickname":"getRecentPronunciations","responseClass":"List[audioObject]"}]},{"path":"/users.{format}/id/{id}","description":"","operations":[{"parameters":[{"name":"id","description":"User ID to filter by","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches a User by ID","httpMethod":"GET","errorResponses":[{"reason":"User not found.","code":404}],"nickname":"getUserById","responseClass":"user"}]},{"path":"/users.{format}/facebook/{facebookId}","description":"","operations":[{"parameters":[{"name":"facebookId","description":"Facebook ID to filter by","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches a User by Facebook ID","httpMethod":"GET","errorResponses":[{"reason":"User not found.","code":404}],"nickname":"getByFacebookId","responseClass":"user"}]},{"path":"/users.{format}","description":"","operations":[{"parameters":[{"name":"signupIP","description":"Client IP address","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"password","description":"Password","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"description":"User to create","required":false,"dataType":"user","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Creates a User","httpMethod":"POST","errorResponses":[{"reason":"Invalid User or User parameters supplied.","code":400}],"nickname":"createUser","responseClass":"user"}]},{"path":"/users.{format}/favorites","description":"","operations":[{"parameters":[{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches recent Favorite Word objects.","httpMethod":"GET","nickname":"getRecentFavorites","responseClass":"List[wordObject]"}]},{"path":"/users.{format}/comments","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches recent Comment objects","httpMethod":"GET","nickname":"getRecentComments","responseClass":"List[comment]"}]},{"path":"/users.{format}/listedMostWords","description":"","operations":[{"parameters":[{"name":"dayInterval","description":"Interval in days to compute from","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches info on Users who listed most words","httpMethod":"GET","nickname":"getUsersWhoListedMostWords","responseClass":"List[UserSummary]"}]}],"models1":[{"name":"wordObject","fields":[{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"vulgar","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"audioType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"audioType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"comment","fields":[{"name":"objectType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"objectId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"commentedBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"id","required":false,"allowMultiple":false,"paramType":"string"},{"name":"commentedOn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"body","required":false,"allowMultiple":false,"paramType":"string"},{"name":"updatedAt","required":false,"allowMultiple":false,"paramType":"Date"}]},{"name":"audioObject","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"type","required":false,"allowMultiple":false,"paramType":"audioType"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"duration","required":false,"allowMultiple":false,"paramType":"double"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"audioFileType","required":false,"allowMultiple":false,"paramType":"audioType"},{"name":"audioFileId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"filePath","required":false,"allowMultiple":false,"paramType":"string"},{"name":"wordId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"recordId","required":false,"allowMultiple":false,"paramType":"string"},{"name":"streamPath","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"UserSummary","fields":[{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"userName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"totalListedWordsCount","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"user","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"displayName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"status","required":false,"allowMultiple":false,"paramType":"int"},{"name":"password","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"email","required":false,"allowMultiple":false,"paramType":"string"},{"name":"faceBookId","required":false,"allowMultiple":false,"paramType":"string"}]}],"basePath":"url","swaggerVersion":"1.0"}
View
2 api_docs/word.json
1 addition, 1 deletion not shown because the diff is too large. Please use a local Git client to view these changes.
View
2 api_docs/wordList.json
@@ -1 +1 @@
-{"resourcePath":"/wordList","models":{"BooleanValue":{"properties":{"value":{"type":"boolean","required":false,"uniqueItems":false}},"id":"BooleanValue","type":"any","required":false,"uniqueItems":false},"tag":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"count":{"type":"long","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"tag","type":"any","required":false,"uniqueItems":false},"comment":{"properties":{"updatedAt":{"type":"Date","required":false,"uniqueItems":false},"id":{"type":"string","required":false,"uniqueItems":false},"body":{"type":"string","required":false,"uniqueItems":false},"commentedOn":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"objectId":{"type":"long","required":false,"uniqueItems":false},"commentedBy":{"type":"string","required":false,"uniqueItems":false},"objectType":{"type":"string","required":false,"uniqueItems":false}},"id":"comment","type":"any","required":false,"uniqueItems":false},"long":{"properties":{"value":{"type":"long","required":false,"uniqueItems":false}},"id":"long","type":"any","required":false,"uniqueItems":false},"wordListWord":{"properties":{"username":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"numberCommentsOnWord":{"type":"long","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"numberLists":{"type":"long","required":false,"uniqueItems":false}},"id":"wordListWord","type":"any","required":false,"uniqueItems":false},"wordList":{"properties":{"updatedAt":{"type":"Date","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"username":{"type":"string","required":false,"uniqueItems":false},"permalink":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"numberWordsInList":{"type":"long","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false}},"id":"wordList","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/wordList.{format}/{wordListId}","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to update","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Updated WordList","required":false,"dataType":"wordList","allowableValues":[],"allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Updates an existing WordList","httpMethod":"PUT","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to update WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"updateWordList","responseClass":"ok"},{"parameters":[{"name":"wordListId","description":"ID of WordList to delete","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Deletes an existing WordList","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to delete WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"deleteWordList","responseClass":"ok"},{"parameters":[{"name":"wordListId","description":"ID of WordList to fetch","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Fetches a WordList by ID","httpMethod":"GET","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"getWordListById","responseClass":"wordList"}]},{"path":"/wordList.{format}/{wordListId}/words","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to user","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to add words on behalf of","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"description":"Array of words to add to WordList","required":false,"dataType":"StringValue[]","allowableValues":[],"allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Adds words to a WordList","httpMethod":"POST","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"addWordsToWordList","responseClass":"ok"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"sortBy","defaultValue":"createDate","description":"Field to sort by","required":false,"dataType":"string","allowableValues":["createDate","alpha"],"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","defaultValue":"desc","description":"Direction to sort","required":false,"dataType":"string","allowableValues":["asc","desc"],"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Fetches words in a WordList","httpMethod":"GET","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"getWordListWords","responseClass":"List[wordListWord]"}]},{"path":"/wordList.{format}/{wordListId}/isFavorite","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to check","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to check for Favorite status","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Checks to see if a WordList has been favorited for a user","httpMethod":"GET","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"Not Authorized to favorite WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"isFavoriteWordList","responseClass":"BooleanValue"}]},{"path":"/wordList.{format}/{wordListId}/favorite","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to fetch","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to favorite on behalf of","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Favorites a WordList for a User","httpMethod":"POST","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"Not Authorized to favorite WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"favoriteWordList","responseClass":"ok"},{"parameters":[{"name":"wordListId","description":"ID of WordList to fetch","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to unfavorite on behalf of","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Unfavorites a WordList for a User","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"Not Authorized to favorite WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"unFavoriteWordList","responseClass":"ok"}]},{"path":"/wordList.{format}/{wordListId}/tags","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to get Tags for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches Tags on a WordList","httpMethod":"GET","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListTags","responseClass":"List[tag]"}]},{"path":"/wordList.{format}/{wordListId}/tagCount","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to get Tags for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches Tag count on a WordList","httpMethod":"GET","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListTagCount","responseClass":"long"}]},{"path":"/wordList.{format}/{wordListId}/tag","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to add Tags for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"tags","description":"Tags to add","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Adds a Tag on a WordList","httpMethod":"POST","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"addWordListTag","responseClass":"ok"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to delete Tags for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"tags","description":"Tags to delete","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Deletes a tag on a WordList","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"deleteWordListTag","responseClass":"ok"}]},{"path":"/wordList.{format}/{wordListId}/comments","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Direction to sort","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches comments on a WordList","httpMethod":"GET","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListComments","responseClass":"List[comment]"}]},{"path":"/wordList.{format}/{wordListId}/comment","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Comment to add","required":false,"dataType":"comment","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Adds a Comment on a WordList","httpMethod":"POST","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"Not Authorized to access WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"addCommentToWordList","responseClass":"comment"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Updated Comment","required":false,"dataType":"comment","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Updates a Comment on a WordList","httpMethod":"PUT","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"Not Authorized to access WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"updateCommentOnWordList","responseClass":"comment"}]},{"path":"/wordList.{format}/{wordListId}/comment/{commentId}","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Comment ID to fetch","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches a WordList comment by ID","httpMethod":"GET","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList or Comment not found.","code":404}],"nickname":"getWordListCommentById","responseClass":"comment"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Comment ID to delete","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Deletes a WordList comment by ID","httpMethod":"DELETE","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList or Comment not found.","code":404}],"nickname":"deleteWordListCommentById","responseClass":"ok"}]},{"path":"/wordList.{format}/{wordListId}/commentCount","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches WordList Comment count","httpMethod":"GET","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListCommentCount","responseClass":"long"}]},{"path":"/wordList.{format}/{wordListId}/deleteWords","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to remove words on behalf of","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"description":"Words to remove from WordList","required":false,"dataType":"StringValue[]","allowableValues":[],"allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Removes words from a WordList","httpMethod":"POST","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to modify WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"deleteWordsFromWordList","responseClass":"ok"}]},{"path":"/wordList.{format}/{wordListId}/wordsCount","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Gets a count of Words in a WordList","httpMethod":"GET","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"getWordListWordsCount","responseClass":"long"}]}],"models1":[{"name":"BooleanValue","fields":[{"name":"value","required":false,"allowMultiple":false,"paramType":"boolean"}]},{"name":"tag","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"count","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"wordList","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"type","required":false,"allowMultiple":false,"paramType":"string"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"permalink","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"username","required":false,"allowMultiple":false,"paramType":"string"},{"name":"updatedAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"numberWordsInList","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"wordListWord","fields":[{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"username","required":false,"allowMultiple":false,"paramType":"string"},{"name":"numberCommentsOnWord","required":false,"allowMultiple":false,"paramType":"long"},{"name":"numberLists","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"long","fields":[{"name":"value","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"comment","fields":[{"name":"objectType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"objectId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"commentedBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"id","required":false,"allowMultiple":false,"paramType":"string"},{"name":"commentedOn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"body","required":false,"allowMultiple":false,"paramType":"string"},{"name":"updatedAt","required":false,"allowMultiple":false,"paramType":"Date"}]}],"basePath":"url","swaggerVersion":"1.0"}
+{"resourcePath":"/wordList","models":{"wordListWord":{"properties":{"username":{"type":"string"},"createdAt":{"type":"Date"},"numberCommentsOnWord":{"type":"long"},"userId":{"type":"long"},"word":{"type":"string"},"numberLists":{"type":"long"}},"id":"wordListWord"},"wordList":{"properties":{"updatedAt":{"type":"Date"},"id":{"type":"long"},"username":{"type":"string"},"permalink":{"type":"string"},"createdAt":{"type":"Date"},"description":{"type":"string"},"userId":{"type":"long"},"name":{"type":"string"},"numberWordsInList":{"type":"long"},"type":{"type":"string"}},"id":"wordList"}},"apis":[{"path":"/wordList.{format}/{wordListId}","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to update","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Updated WordList","required":false,"dataType":"wordList","allowableValues":[],"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","allowableValues":[],"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","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Deletes an existing WordList","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","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Fetches a WordList by ID","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","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to add words on behalf of","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"description":"Array of words to add to WordList","required":false,"dataType":"StringValue[]","allowableValues":[],"valueTypeInternal":"[Lcom.wordnik.resource.StringValue;","allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"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","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"sortBy","defaultValue":"createDate","description":"Field to sort by","required":false,"dataType":"string","allowableValues":["createDate","alpha"],"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","defaultValue":"desc","description":"Direction to sort","required":false,"dataType":"string","allowableValues":["asc","desc"],"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Fetches words in a WordList","responseTypeInternal":"com.wordnik.community.entity.WordListWord","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"getWordListWords","responseClass":"List[wordListWord]","httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/deleteWords","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to remove words on behalf of","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"description":"Words to remove from WordList","required":false,"dataType":"StringValue[]","allowableValues":[],"valueTypeInternal":"[Lcom.wordnik.resource.StringValue;","allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"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"}]}],"basePath":"url","swaggerVersion":"1.0"}
View
2 api_docs/wordLists.json
@@ -1 +1 @@
-{"resourcePath":"/wordLists","models":{"commentSummary":{"properties":{"objectDisplayName":{"type":"string","required":false,"uniqueItems":false},"objectName":{"type":"string","required":false,"uniqueItems":false},"totalCount":{"type":"long","required":false,"uniqueItems":false},"countInInterval":{"type":"long","required":false,"uniqueItems":false},"intervalInMilliseconds":{"type":"long","required":false,"uniqueItems":false},"objectType":{"type":"string","required":false,"uniqueItems":false}},"id":"commentSummary","type":"any","required":false,"uniqueItems":false},"wordList":{"properties":{"updatedAt":{"type":"Date","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"username":{"type":"string","required":false,"uniqueItems":false},"permalink":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"userId":{"type":"long","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"numberWordsInList":{"type":"long","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false}},"id":"wordList","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/wordLists.{format}/find/{searchString}","description":"","operations":[{"parameters":[{"name":"searchString","description":"String to search for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches WordList objects by name.","httpMethod":"GET","errorResponses":[{"reason":"Not authenticated.","code":403}],"nickname":"findByName","responseClass":"List[wordList]","notes":"The term supplied is effectively given a wildcard before and after so 'cat' becomes '%cat%'"}]},{"path":"/wordLists.{format}","description":"","operations":[{"parameters":[{"description":"WordList to create","required":false,"dataType":"wordList","allowableValues":[],"allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"}],"summary":"Creates a WordList.","httpMethod":"POST","errorResponses":[{"reason":"Invalid WordList supplied or mandatory fields are missing.","code":400},{"reason":"Not authenticated.","code":403},{"reason":"WordList owner not found.","code":404}],"nickname":"createWordList","responseClass":"wordList"}]},{"path":"/wordLists.{format}/mostCommentedOn","description":"","operations":[{"parameters":[{"name":"dayInterval","description":"Interval in days","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches a CommentSummary for WordList objects.","httpMethod":"GET","errorResponses":[{"reason":"Not authenticated.","code":403}],"nickname":"findMostCommentedOn","responseClass":"List[commentSummary]","notes":"The CommentSummary is sorted by comment count, descending"}]},{"path":"/wordLists.{format}/containing/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to find lists for","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to add words on behalf of","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Fetches WordList objects containing a word.","httpMethod":"GET","errorResponses":[{"reason":"Invalid word or username supplied.","code":400},{"reason":"Not authenticated.","code":403}],"nickname":"findContainingWord","responseClass":"List[wordList]","notes":"Results are scoped to the supplied user."}]},{"path":"/wordLists.{format}/recentLists","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"type","description":"WordListType to filter by","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches recently created WordList objects.","httpMethod":"GET","errorResponses":[{"reason":"Not authenticated.","code":403}],"nickname":"findRecentLists","responseClass":"List[wordList]"}]}],"models1":[{"name":"wordList","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"type","required":false,"allowMultiple":false,"paramType":"string"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"userId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"permalink","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"username","required":false,"allowMultiple":false,"paramType":"string"},{"name":"updatedAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"numberWordsInList","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"commentSummary","fields":[{"name":"objectType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"totalCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"objectName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"objectDisplayName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"countInInterval","required":false,"allowMultiple":false,"paramType":"long"},{"name":"intervalInMilliseconds","required":false,"allowMultiple":false,"paramType":"long"}]}],"basePath":"url","swaggerVersion":"1.0"}
+{"resourcePath":"/wordLists","models":{"wordList":{"properties":{"updatedAt":{"type":"Date"},"id":{"type":"long"},"username":{"type":"string"},"permalink":{"type":"string"},"createdAt":{"type":"Date"},"description":{"type":"string"},"userId":{"type":"long"},"name":{"type":"string"},"numberWordsInList":{"type":"long"},"type":{"type":"string"}},"id":"wordList"}},"apis":[{"path":"/wordLists.{format}","description":"","operations":[{"parameters":[{"description":"WordList to create","required":false,"dataType":"wordList","allowableValues":[],"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","allowableValues":[],"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"}]}],"basePath":"url","swaggerVersion":"1.0"}
View
2 api_docs/words.json
@@ -1 +1 @@
-{"resourcePath":"/words","models":{"SubscriptionStatus":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"SubscriptionStatus","type":"any","required":false,"uniqueItems":false},"wordOfTheDayList":{"properties":{"subscriptionNamespace":{"type":"string","required":false,"uniqueItems":false},"subscriberCount":{"type":"int","required":false,"uniqueItems":false},"commentCount":{"type":"int","required":false,"uniqueItems":false},"subscriptionIdentifier":{"type":"string","required":false,"uniqueItems":false},"firstItemDate":{"type":"Date","required":false,"uniqueItems":false},"voteCount":{"type":"integer","required":false,"uniqueItems":false},"id":{"type":"string","required":true,"uniqueItems":false},"category":{"type":"string","required":false,"uniqueItems":false},"createdBy":{"type":"string","required":false,"uniqueItems":false},"items":{"type":"array","required":false,"items":{"$ref":"WordOfTheDay","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"voteWeightedAverage":{"type":"float","required":false,"uniqueItems":false},"subscriptionSchedule":{"type":"string","required":false,"uniqueItems":false},"lastItemDate":{"type":"Date","required":false,"uniqueItems":false},"voteAverage":{"type":"float","required":false,"uniqueItems":false},"itemCount":{"type":"int","required":false,"uniqueItems":false},"subscriptionStatus":{"type":"string","required":false,"uniqueItems":false}},"id":"wordOfTheDayList","type":"any","required":false,"uniqueItems":false},"detailedWordUsage":{"properties":{"sentence":{"type":"sentence","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false},"metadata":{"type":"documentMetadata","required":false,"uniqueItems":false}},"id":"detailedWordUsage","type":"any","required":false,"uniqueItems":false},"yearType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"yearType","type":"any","required":false,"uniqueItems":false},"extendedMetadata":{"properties":{"sourceFileSize":{"type":"long","required":false,"uniqueItems":false},"issn":{"type":"string","required":false,"uniqueItems":false},"isbn":{"type":"string","required":false,"uniqueItems":false},"lccn":{"type":"string","required":false,"uniqueItems":false},"documentMetadataId":{"type":"long","required":false,"uniqueItems":false}},"id":"extendedMetadata","type":"any","required":false,"uniqueItems":false},"WordOfTheDay":{"properties":{"id":{"type":"long","required":true,"uniqueItems":false},"parentId":{"type":"string","required":false,"uniqueItems":false},"category":{"type":"string","required":false,"uniqueItems":false},"definition":{"type":"array","required":false,"items":{"$ref":"SimpleDefinition","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"createdBy":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"contentProvider":{"type":"contentProvider","required":false,"uniqueItems":false},"htmlExtra":{"type":"string","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"example":{"type":"array","required":false,"items":{"$ref":"SimpleExample","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"note":{"type":"string","required":false,"uniqueItems":false},"publishDate":{"type":"Date","required":false,"uniqueItems":false}},"id":"WordOfTheDay","type":"any","required":false,"uniqueItems":false},"sentence":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"display":{"type":"string","required":false,"uniqueItems":false},"rating":{"type":"int","required":false,"uniqueItems":false},"documentMetadataId":{"type":"long","required":false,"uniqueItems":false},"scoredWord":{"type":"array","required":false,"items":{"$ref":"scoredWord","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"sentence","type":"any","required":false,"uniqueItems":false},"documentMedium":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"documentMedium","type":"any","required":false,"uniqueItems":false},"frequency":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"year":{"type":"int","required":false,"uniqueItems":false}},"id":"frequency","type":"any","required":false,"uniqueItems":false},"contentType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"contentType","type":"any","required":false,"uniqueItems":false},"documentMetadata":{"properties":{"yearType":{"type":"yearType","required":false,"uniqueItems":false},"expirationDate":{"type":"Date","required":false,"uniqueItems":false},"extendedMetadata":{"type":"extendedMetadata","required":false,"uniqueItems":false},"stats":{"type":"basicDocumentStats","required":false,"uniqueItems":false},"tag":{"type":"array","required":false,"items":{"type":"string","required":false,"uniqueItems":false},"uniqueItems":false},"provider":{"type":"contentProvider","required":false,"uniqueItems":false},"contentType":{"type":"contentType","required":false,"uniqueItems":false},"sourceUrl":{"type":"string","required":false,"uniqueItems":false},"date":{"type":"Date","required":false,"uniqueItems":false},"medium":{"type":"documentMedium","required":false,"uniqueItems":false},"guid":{"type":"string","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"author":{"type":"array","required":false,"items":{"$ref":"author","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"title":{"type":"string","required":false,"uniqueItems":false},"primaryAuthorType":{"type":"authorType","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"classification":{"type":"subjectClassificationType","required":false,"uniqueItems":false},"year":{"type":"integer","required":false,"uniqueItems":false},"primaryAuthor":{"type":"string","required":false,"uniqueItems":false},"rating":{"type":"double","required":false,"uniqueItems":false},"primaryAuthorId":{"type":"long","required":false,"uniqueItems":false}},"id":"documentMetadata","type":"any","required":false,"uniqueItems":false},"author":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"authorType":{"type":"authorType","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"description":{"type":"string","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false},"uniqueName":{"type":"string","required":false,"uniqueItems":false}},"id":"author","type":"any","required":false,"uniqueItems":false},"wordSearchResults":{"properties":{"searchResult":{"type":"array","required":false,"items":{"$ref":"WordSearchResult","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"totalResults":{"type":"int","required":false,"uniqueItems":false}},"id":"wordSearchResults","type":"any","required":false,"uniqueItems":false},"SimpleDefinition":{"properties":{"text":{"type":"string","required":false,"uniqueItems":false},"source":{"type":"string","required":false,"uniqueItems":false},"note":{"type":"string","required":false,"uniqueItems":false},"partOfSpeech":{"type":"string","required":false,"uniqueItems":false}},"id":"SimpleDefinition","type":"any","required":false,"uniqueItems":false},"wordObject":{"properties":{"word":{"type":"string","required":false,"uniqueItems":false},"vulgar":{"type":"string","required":false,"uniqueItems":false}},"id":"wordObject","type":"any","required":false,"uniqueItems":false},"wotdListInvitation":{"properties":{"failure":{"type":"array","required":false,"items":{"type":"string","required":false,"uniqueItems":false},"uniqueItems":false},"permalink":{"type":"string","required":false,"uniqueItems":false},"createdBy":{"type":"string","required":false,"uniqueItems":false},"createdAt":{"type":"Date","required":false,"uniqueItems":false},"recipient":{"type":"array","required":false,"items":{"type":"string","required":false,"uniqueItems":false},"uniqueItems":false},"note":{"type":"string","required":false,"uniqueItems":false}},"id":"wotdListInvitation","type":"any","required":false,"uniqueItems":false},"wordFrequency":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"wordstring":{"type":"string","required":false,"uniqueItems":false}},"id":"wordFrequency","type":"any","required":false,"uniqueItems":false},"authorType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"authorType","type":"any","required":false,"uniqueItems":false},"definition":{"properties":{"extendedText":{"type":"string","required":false,"uniqueItems":false},"citation":{"type":"array","required":false,"items":{"$ref":"citation","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"text":{"type":"string","required":false,"uniqueItems":false},"sourceDictionary":{"type":"string","required":false,"uniqueItems":false},"exampleUsage":{"type":"array","required":false,"items":{"$ref":"ExampleUsage","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"relWord":{"type":"array","required":false,"items":{"$ref":"related","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"score":{"type":"float","required":false,"uniqueItems":false},"label":{"type":"array","required":false,"items":{"$ref":"Label","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"seqString":{"type":"string","required":false,"uniqueItems":false},"sequence":{"type":"string","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"note":{"type":"array","required":false,"items":{"$ref":"note","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"textPron":{"type":"array","required":false,"items":{"$ref":"textPron","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"partOfSpeech":{"type":"string","required":false,"uniqueItems":false}},"id":"definition","type":"any","required":false,"uniqueItems":false},"WordSearchResult":{"properties":{"count":{"type":"long","required":false,"uniqueItems":false},"lexicality":{"type":"double","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false}},"id":"WordSearchResult","type":"any","required":false,"uniqueItems":false},"commentSummary":{"properties":{"objectDisplayName":{"type":"string","required":false,"uniqueItems":false},"objectName":{"type":"string","required":false,"uniqueItems":false},"totalCount":{"type":"long","required":false,"uniqueItems":false},"countInInterval":{"type":"long","required":false,"uniqueItems":false},"intervalInMilliseconds":{"type":"long","required":false,"uniqueItems":false},"objectType":{"type":"string","required":false,"uniqueItems":false}},"id":"commentSummary","type":"any","required":false,"uniqueItems":false},"subjectClassificationType":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"subjectClassificationType","type":"any","required":false,"uniqueItems":false},"EntrySearchResult":{"properties":{"sourceDictionary":{"type":"string","required":false,"uniqueItems":false},"definition":{"type":"array","required":false,"items":{"$ref":"definition","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"headWord":{"type":"string","required":false,"uniqueItems":false},"entryId":{"type":"long","required":false,"uniqueItems":false}},"id":"EntrySearchResult","type":"any","required":false,"uniqueItems":false},"DefinitionSearchResults":{"properties":{"result":{"type":"array","required":false,"items":{"$ref":"definition","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"totalResults":{"type":"int","required":false,"uniqueItems":false}},"id":"DefinitionSearchResults","type":"any","required":false,"uniqueItems":false},"scoredWord":{"properties":{"position":{"type":"int","required":false,"uniqueItems":false},"id":{"type":"long","required":false,"uniqueItems":false},"wordType":{"type":"string","required":false,"uniqueItems":false},"score":{"type":"float","required":false,"uniqueItems":false},"sentenceId":{"type":"long","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"partOfSpeech":{"type":"string","required":false,"uniqueItems":false}},"id":"scoredWord","type":"any","required":false,"uniqueItems":false},"basicDocumentStats":{"properties":{"uniqueBiGramsCount":{"type":"long","required":false,"uniqueItems":false},"wordsCount":{"type":"long","required":false,"uniqueItems":false},"documentsCount":{"type":"long","required":false,"uniqueItems":false},"firstUsedWordsCount":{"type":"long","required":false,"uniqueItems":false},"tokensCount":{"type":"long","required":false,"uniqueItems":false},"sentencesCount":{"type":"long","required":false,"uniqueItems":false},"viableSentencesCount":{"type":"long","required":false,"uniqueItems":false},"type":{"type":"string","required":false,"uniqueItems":false},"uniqueWordsCount":{"type":"long","required":false,"uniqueItems":false},"key":{"type":"string","required":false,"uniqueItems":false}},"id":"basicDocumentStats","type":"any","required":false,"uniqueItems":false},"contentProvider":{"properties":{"id":{"type":"int","required":false,"uniqueItems":false},"name":{"type":"string","required":false,"uniqueItems":false}},"id":"contentProvider","type":"any","required":false,"uniqueItems":false},"EntrySearchResults":{"properties":{"searchResult":{"type":"array","required":false,"items":{"$ref":"EntrySearchResult","type":"any","required":false,"uniqueItems":false},"uniqueItems":false},"totalResults":{"type":"int","required":false,"uniqueItems":false}},"id":"EntrySearchResults","type":"any","required":false,"uniqueItems":false},"example":{"properties":{"exampleId":{"type":"long","required":false,"uniqueItems":false},"title":{"type":"string","required":false,"uniqueItems":false},"text":{"type":"string","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"provider":{"type":"contentProvider","required":false,"uniqueItems":false},"year":{"type":"integer","required":false,"uniqueItems":false},"rating":{"type":"float","required":false,"uniqueItems":false},"documentId":{"type":"long","required":false,"uniqueItems":false},"url":{"type":"string","required":false,"uniqueItems":false}},"id":"example","type":"any","required":false,"uniqueItems":false},"SimpleExample":{"properties":{"id":{"type":"long","required":false,"uniqueItems":false},"title":{"type":"string","required":false,"uniqueItems":false},"text":{"type":"string","required":false,"uniqueItems":false},"url":{"type":"string","required":false,"uniqueItems":false}},"id":"SimpleExample","type":"any","required":false,"uniqueItems":false},"frequencySummary":{"properties":{"unknownYearCount":{"type":"int","required":false,"uniqueItems":false},"totalCount":{"type":"long","required":false,"uniqueItems":false},"word":{"type":"string","required":false,"uniqueItems":false},"frequency":{"type":"array","required":false,"items":{"$ref":"frequency","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"frequencySummary","type":"any","required":false,"uniqueItems":false},"partOfSpeech":{"properties":{"roots":{"type":"array","required":false,"items":{"$ref":"root","type":"any","required":false,"uniqueItems":false},"uniqueItems":false}},"id":"partOfSpeech","type":"any","required":false,"uniqueItems":false}},"apis":[{"path":"/words.{format}/search","description":"","operations":[{"parameters":[{"name":"allowRegex","defaultValue":"false","description":"Search term is a Regular Expression","required":false,"dataType":"string","allowableValues":["true | false"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"query","description":"Search term","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"caseSensitive","defaultValue":"true","description":"Search case sensitive","required":false,"dataType":"string","allowableValues":["true | false"],"allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"Only include these comma-delimited parts of speech","required":false,"dataType":"string","allowableValues":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"Exclude these comma-delimited parts of speech","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minCorpusCount","defaultValue":"5","description":"Minimum corpus frequency for terms","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"minDictionaryCount","defaultValue":"1","description":"Minimum number of dictionary entries","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"minLength","defaultValue":"1","description":"Minimum word length","required":false,"dataType":"string","allowableValues":["0 to 1024"],"allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"dataType":"string","allowableValues":["0 to 1024"],"allowMultiple":false,"paramType":"query"},{"name":"minLexicalityRating","defaultValue":"0","description":"Minimum lexicality","required":false,"dataType":"string","allowableValues":["0 to 100"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"maxLexicalityRating","defaultValue":"0","description":"Maximum lexicality","required":false,"dataType":"string","allowableValues":["0 to 100"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":["0 to 1000"],"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":["1 to 1000"],"allowMultiple":false,"paramType":"query"}],"summary":"Searches words.","httpMethod":"GET","errorResponses":[{"reason":"Invalid term supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"searchWords","responseClass":"List[wordFrequency]"}]},{"path":"/words.{format}/wordOfTheDayList/{permalink}","description":"","operations":[{"parameters":[{"name":"permalink","description":"ID of WordOfTheDayList","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"includeAll","description":"Returns future WordOfTheDay items","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches a WordOfTheDayList by ID","httpMethod":"GET","errorResponses":[{"reason":"Invalid id supplied","code":400},{"reason":"WordOfTheDayList not found","code":404}],"nickname":"getWordOfTheDayList","responseClass":"wordOfTheDayList"}]},{"path":"/words.{format}/wordOfTheDay","description":"","operations":[{"parameters":[{"name":"date","description":"Fetches by date in yyyy-MM-dd","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"category","description":"Filters response by category","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"creator","description":"Filters response by username","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns a specific WordOfTheDay","httpMethod":"GET","nickname":"getWordOfTheDay","responseClass":"WordOfTheDay"}]},{"path":"/words.{format}/searchDefinitions","description":"","operations":[{"parameters":[{"name":"query","description":"Search term","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"definedWordSearchTerm","description":"Defined word search term","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"includeSourceDictionaries","description":"Only include these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":["ahd"," century"," wiktionary"," webster"," wordnet"],"allowMultiple":false,"paramType":"query"},{"name":"excludeSourceDictionaries","description":"Exclude these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":["ahd"," century"," wiktionary"," webster"," wordnet"],"allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"Only include these comma-delimited parts of speech","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"Exclude these comma-delimited parts of speech","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minCorpusCount","defaultValue":"5","description":"Minimum corpus frequency for terms","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"minLength","defaultValue":"1","description":"Minimum word length","required":false,"dataType":"string","allowableValues":["0 to 1024"],"allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"dataType":"string","allowableValues":["0 to 1024"],"allowMultiple":false,"paramType":"query"},{"name":"expandTerms","description":"Expand terms","required":false,"dataType":"string","allowableValues":["synonym","hypernym"],"allowMultiple":false,"paramType":"query"},{"name":"wordTypes","description":"Word types","required":false,"dataType":"string","allowableValues":["word","multi-word-unit"],"allowMultiple":false,"paramType":"query"},{"name":"returnWordsOnly","defaultValue":"false","description":"Return words only","required":false,"dataType":"string","allowableValues":["false","true"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"includeTags","defaultValue":"false","description":"Return a closed set of XML tags in response","required":false,"dataType":"string","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"},{"name":"useTagsForRanking","defaultValue":"true","description":"Use user tags, dictionary labels and hypernyms for ranking","required":false,"dataType":"string","allowableValues":["false","true"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"sortBy","description":"Attribute to sort by","required":false,"dataType":"string","allowableValues":["alpha","count","length"],"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Sort direction","required":false,"dataType":"string","allowableValues":["asc","desc"],"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":["0 to 1000"],"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":["1 to 1000"],"allowMultiple":false,"paramType":"query"}],"summary":"Searches definitions.","httpMethod":"GET","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"nickname":"searchDefinitions","responseClass":"DefinitionSearchResults"}]},{"path":"/words.{format}/searchEntries","description":"","operations":[{"parameters":[{"name":"query","description":"Search term","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":["0 to 1000"],"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":["1 to 1000"],"allowMultiple":false,"paramType":"query"}],"summary":"Searches dictionary entries.","httpMethod":"GET","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"nickname":"searchEntries","responseClass":"EntrySearchResults"}]},{"path":"/words.{format}/frequency","description":"","operations":[{"summary":"Fetches corpus-level word frequency","httpMethod":"GET","errorResponses":[{"reason":"No data found.","code":404}],"nickname":"getFrequency","responseClass":"frequencySummary"}]},{"path":"/words.{format}/surfaceForms","description":"","operations":[{"parameters":[{"name":"term","description":"Word to get surface forms for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches surface forms of a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"nickname":"getSurfaceForms","responseClass":"String"}]},{"path":"/words.{format}/id/{id}","description":"","operations":[{"parameters":[{"name":"id","description":"ID of word","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"}],"summary":"Fetches a word by ID","httpMethod":"GET","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"No word found.","code":404}],"nickname":"getWordById","responseClass":"wordObject","notes":"Deprecated."}]},{"path":"/words.{format}/wordOfTheDay/range","description":"","operations":[{"parameters":[{"name":"category","description":"Filters response by category","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"creator","description":"Filters response by username","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"provider","description":"Filters response by ContentProvider","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns a WordOfTheDay range","httpMethod":"GET","nickname":"getWordOfTheDayRange","responseClass":"List[WordOfTheDay]"}]},{"path":"/words.{format}/canonicalForms","description":"","operations":[{"parameters":[{"name":"term","description":"Word to get canonical forms for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches canonical forms of a word","httpMethod":"GET","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"nickname":"getCanonicalForms","responseClass":"String"}]},{"path":"/words.{format}/search/{query}","description":"","operations":[{"parameters":[{"name":"allowRegex","defaultValue":"false","description":"Search query is a Regular Expression","required":false,"dataType":"string","allowableValues":["true | false"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"query","description":"Search query","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"caseSensitive","defaultValue":"true","description":"Search case sensitive","required":false,"dataType":"string","allowableValues":["true | false"],"allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"Only include these comma-delimited parts of speech","required":false,"dataType":"string","allowableValues":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"Exclude these comma-delimited parts of speech","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minCorpusCount","defaultValue":"5","description":"Minimum corpus frequency for terms","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"minDictionaryCount","defaultValue":"1","description":"Minimum number of dictionary entries","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"minLength","defaultValue":"1","description":"Minimum word length","required":false,"dataType":"string","allowableValues":["0 to 1024"],"allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"dataType":"string","allowableValues":["0 to 1024"],"allowMultiple":false,"paramType":"query"},{"name":"minLexicalityRating","defaultValue":"0","description":"Minimum lexicality","required":false,"dataType":"string","allowableValues":["0 to 100"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"maxLexicalityRating","defaultValue":"0","description":"Maximum lexicality","required":false,"dataType":"string","allowableValues":["0 to 100"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":["0 to 1000"],"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":["1 to 1000"],"allowMultiple":false,"paramType":"query"}],"summary":"Searches words.","httpMethod":"GET","errorResponses":[{"reason":"Invalid query supplied.","code":400}],"nickname":"searchWordsNew","responseClass":"wordSearchResults"}]},{"path":"/words.{format}/randomWords","description":"","operations":[{"parameters":[{"name":"hasDictionaryDef","description":"Only return words with dictionary definitions","required":false,"dataType":"string","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"CSV part-of-speech values to include","required":false,"dataType":"string","allowableValues":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"CSV part-of-speech values to exclude","required":false,"dataType":"string","allowableValues":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"allowMultiple":false,"paramType":"query"},{"name":"minCorpusCount","description":"Minimum corpus frequency for terms (integer)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms (integer)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minDictionaryCount","description":"Minimum dictionary count (integer)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count (integer)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minLength","description":"Minimum word length (characters)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length (characters)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minLexicalityRating","description":"Minimum lexicality","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"maxLexicalityRating","description":"Maximum lexicality","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"sortBy","description":"Attribute to sort by","required":false,"dataType":"string","allowableValues":["alpha","count"],"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Sort direction","required":false,"dataType":"string","allowableValues":["asc","desc"],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns an array of random WordObjects, in the format specified by the URL","httpMethod":"GET","errorResponses":[{"reason":"Invalid term supplied.","code":400},{"reason":"No results.","code":404}],"nickname":"getRandomWords","responseClass":"List[wordObject]"}]},{"path":"/words.{format}/randomWord","description":"","operations":[{"parameters":[{"name":"hasDictionaryDef","defaultValue":"true","description":"Only return words with dictionary definitions","required":false,"dataType":"string","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"CSV part-of-speech values to include","required":false,"dataType":"string","allowableValues":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"CSV part-of-speech values to exclude","required":false,"dataType":"string","allowableValues":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"allowMultiple":false,"paramType":"query"},{"name":"minCorpusCount","description":"Minimum corpus frequency for terms","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minDictionaryCount","description":"Minimum dictionary count","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minLength","description":"Minimum word length","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minLexicalityRating","description":"Minimum lexicality","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"maxLexicalityRating","description":"Maximum lexicality","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns a single random WordObject, in the format specified by the URL","httpMethod":"GET","errorResponses":[{"reason":"No word found.","code":404}],"nickname":"getRandomWord","responseClass":"wordObject"}]},{"path":"/words.{format}/examples","description":"","operations":[{"parameters":[{"description":"Words to fetch examples for","required":false,"dataType":"String[]","allowableValues":[],"allowMultiple":false,"paramType":"body"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches examples for multiple words.","httpMethod":"POST","errorResponses":[{"reason":"Invalid words to search with.","code":400}],"nickname":"getExamplesForWords","responseClass":"List[example]"}]},{"path":"/words.{format}/mostCommentedOn","description":"","operations":[{"parameters":[{"name":"dayInterval","description":"Number of days to consider","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches words most commented on.","httpMethod":"GET","errorResponses":[{"reason":"Invalid time interval.","code":400}],"nickname":"getWordsMostCommentedOn","responseClass":"List[commentSummary]","notes":"Set the dayInterval to determine the time frame."}]},{"path":"/words.{format}/firstUsed/{statsType}/{object}","description":"","operations":[{"parameters":[{"name":"statsType","description":"DocumentStatsType dimension to filter by","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"object","description":"Identifier of DocumentStatsType object","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"detailed","description":"Return detailed data","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches words most commented on.","httpMethod":"GET","errorResponses":[{"reason":"Invalid time interval.","code":400}],"nickname":"getWordsMostCommentedOn","responseClass":"List[detailedWordUsage]","notes":"Set the dayInterval to determine the time frame."}]},{"path":"/words.{format}/wordOfTheDayList/{permalink}/invite","description":"","operations":[{"parameters":[{"name":"permalink","description":"ID of WordOfTheDayList","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"description":"Invitation to send","required":false,"dataType":"wotdListInvitation","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Invites users to a WordOfTheDayList","httpMethod":"POST","errorResponses":[{"reason":"User is not eligible to send invitations","code":400},{"reason":"WordOfTheDayList not found.","code":404}],"nickname":"inviteToWordOfTheDayList","responseClass":"ok","notes":"A user can invite up to 20 people in a single day. The users being invited will be checked to see if they have opted out of email communications"}]},{"path":"/words.{format}/wordOfTheDayLists/recent","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches recently created WordOfTheDayLists","httpMethod":"GET","errorResponses":[{"reason":"No WordOfTheDayLists found.","code":404}],"nickname":"getRecentWordOfTheDayLists","responseClass":"List[wordOfTheDayList]"}]},{"path":"/words.{format}/wordOfTheDayList/{permalink}/{specifier}","description":"","operations":[{"parameters":[{"name":"permalink","description":"ID of WordOfTheDayList","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"specifier","description":"Specifier for the item to fetch. Either 'current' or a date.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"includeExtraHtml","description":"Include extra HTML if available","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Fetches a WordOfTheDayList by ID","httpMethod":"GET","errorResponses":[{"reason":"Invalid id supplied","code":400},{"reason":"WordOfTheDayList not found","code":404}],"nickname":"getWordOfTheDayListItem","responseClass":"WordOfTheDay"}]},{"path":"/words.{format}/wordOfTheDayLists","description":"","operations":[{"parameters":[{"name":"containsWord","description":"Lists must contain a specific word","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"subscriberCount","description":"Lists must have the specified number of subscribers","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"itemCount","description":"Lists must have the specified number of items","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"includeAll","description":"Returns future WordOfTheDay items","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches an array of WordOfTheDayList basd on a criteria","httpMethod":"GET","errorResponses":[{"reason":"Invalid word supplied.","code":400}],"nickname":"getWordOfTheDayListsContainingWord","responseClass":"List[wordOfTheDayList]"}]},{"path":"/words.{format}/wordOfTheDayLists/subscriptionProcess","description":"","operations":[{"parameters":[{"name":"date","description":"Date string to fetch for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns whether or not a subscription process has been run.","httpMethod":"GET","errorResponses":[{"reason":"Invalid date format supplied.","code":400}],"nickname":"getWordOfTheDayListSubscriptionProcessStatus","responseClass":"String","notes":"Uses the current server time (day resolution) as the default date to check for, optionally a dateString can be supplied for a specific date to check for."}]},{"path":"/words.{format}/wordOfTheDayList/{permalink}/subscription","description":"","operations":[{"parameters":[{"name":"auth_token","description":"auth_token of logged-in user","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"permalink","description":"ID of WordOfTheDayList","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"medium","description":"Medium to subscribe with","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"description":"Username to subscribe","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Subscribes a user to a WordOfTheDayList","httpMethod":"POST","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not authorized to subscribe","code":403},{"reason":"WordOfTheDayList or User not found","code":404}],"nickname":"subscribeToList","responseClass":"ok"}]},{"path":"/words.{format}/wordOfTheDayLists/{date}","description":"","operations":[{"parameters":[{"name":"date","description":"ID of WordOfTheDayList","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"includeAll","description":"Returns future WordOfTheDay items","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches WordOfTheDay objects for a specific date","httpMethod":"GET","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"WordOfTheDayList or User not found","code":404}],"nickname":"getWordOfTheDayListsForDate","responseClass":"List[WordOfTheDay]"}]}],"models1":[{"name":"EntrySearchResult","fields":[{"name":"definition","required":false,"wrapperName":"definitions","allowMultiple":false,"paramType":"List[definition]"},{"name":"sourceDictionary","required":false,"allowMultiple":false,"paramType":"string"},{"name":"headWord","required":false,"allowMultiple":false,"paramType":"string"},{"name":"entryId","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"extendedMetadata","fields":[{"name":"documentMetadataId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"isbn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"issn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"lccn","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sourceFileSize","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"commentSummary","fields":[{"name":"objectType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"totalCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"objectName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"objectDisplayName","required":false,"allowMultiple":false,"paramType":"string"},{"name":"countInInterval","required":false,"allowMultiple":false,"paramType":"long"},{"name":"intervalInMilliseconds","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"author","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"authorType","required":false,"allowMultiple":false,"paramType":"authorType"},{"name":"uniqueName","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"wotdListInvitation","fields":[{"name":"createdBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"note","required":false,"allowMultiple":false,"paramType":"string"},{"name":"permalink","required":false,"allowMultiple":false,"paramType":"string"},{"name":"recipient","required":false,"wrapperName":"recipients","allowMultiple":false,"paramType":"List[string]"},{"name":"failure","required":false,"wrapperName":"failures","allowMultiple":false,"paramType":"List[string]"}]},{"name":"wordOfTheDayList","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":true,"allowMultiple":false,"paramType":"string"},{"name":"description","required":false,"allowMultiple":false,"paramType":"string"},{"name":"category","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"items","required":false,"allowMultiple":false,"paramType":"List[WordOfTheDay]"},{"name":"subscriberCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"subscriptionStatus","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"commentCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"voteCount","required":false,"allowMultiple":false,"paramType":"integer"},{"name":"voteAverage","required":false,"allowMultiple":false,"paramType":"float"},{"name":"voteWeightedAverage","required":false,"allowMultiple":false,"paramType":"float"},{"name":"itemCount","required":false,"allowMultiple":false,"paramType":"int"},{"name":"firstItemDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"lastItemDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"subscriptionSchedule","required":false,"allowMultiple":false,"paramType":"string"},{"name":"subscriptionNamespace","required":false,"allowMultiple":false,"paramType":"string"},{"name":"subscriptionIdentifier","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"example","fields":[{"name":"year","required":false,"allowMultiple":false,"paramType":"integer"},{"name":"provider","required":false,"allowMultiple":false,"paramType":"contentProvider"},{"name":"url","required":false,"allowMultiple":false,"paramType":"string"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"text","required":false,"allowMultiple":false,"paramType":"string"},{"name":"title","required":false,"allowMultiple":false,"paramType":"string"},{"name":"rating","required":false,"allowMultiple":false,"paramType":"float"},{"name":"exampleId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"documentId","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"WordSearchResult","fields":[{"name":"count","required":false,"allowMultiple":false,"paramType":"long"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"lexicality","required":false,"allowMultiple":false,"paramType":"double"}]},{"name":"definition","fields":[{"name":"exampleUsage","required":false,"wrapperName":"exampleUses","allowMultiple":false,"paramType":"List[ExampleUsage]"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"text","required":false,"allowMultiple":false,"paramType":"string"},{"name":"textPron","required":false,"wrapperName":"textProns","allowMultiple":false,"paramType":"List[textPron]"},{"name":"score","required":false,"allowMultiple":false,"paramType":"float"},{"name":"partOfSpeech","required":false,"allowMultiple":false,"paramType":"string"},{"name":"note","required":false,"wrapperName":"notes","allowMultiple":false,"paramType":"List[note]"},{"name":"relWord","required":false,"wrapperName":"relatedWords","allowMultiple":false,"paramType":"List[related]"},{"name":"sourceDictionary","required":false,"allowMultiple":false,"paramType":"string"},{"name":"label","required":false,"wrapperName":"labels","allowMultiple":false,"paramType":"List[Label]"},{"name":"citation","required":false,"wrapperName":"citations","allowMultiple":false,"paramType":"List[citation]"},{"name":"sequence","required":false,"allowMultiple":false,"paramType":"string"},{"name":"seqString","required":false,"allowMultiple":false,"paramType":"string"},{"name":"extendedText","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"documentMedium","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"contentProvider","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"frequency","fields":[{"name":"year","required":false,"allowMultiple":false,"paramType":"int"},{"name":"count","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"authorType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"frequencySummary","fields":[{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"totalCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"frequency","required":false,"allowMultiple":false,"paramType":"List[frequency]"},{"name":"unknownYearCount","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"detailedWordUsage","fields":[{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sentence","required":false,"allowMultiple":false,"paramType":"sentence"},{"name":"metadata","required":false,"allowMultiple":false,"paramType":"documentMetadata"}]},{"name":"scoredWord","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordType","required":false,"allowMultiple":false,"paramType":"string"},{"name":"position","required":false,"allowMultiple":false,"paramType":"int"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"score","required":false,"allowMultiple":false,"paramType":"float"},{"name":"sentenceId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"partOfSpeech","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"SimpleDefinition","fields":[{"name":"text","required":false,"allowMultiple":false,"paramType":"string"},{"name":"partOfSpeech","required":false,"allowMultiple":false,"paramType":"string"},{"name":"note","required":false,"allowMultiple":false,"paramType":"string"},{"name":"source","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"basicDocumentStats","fields":[{"name":"key","required":false,"allowMultiple":false,"paramType":"string"},{"name":"type","required":false,"allowMultiple":false,"paramType":"string"},{"name":"sentencesCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"uniqueWordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"documentsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"tokensCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"firstUsedWordsCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"viableSentencesCount","required":false,"allowMultiple":false,"paramType":"long"},{"name":"uniqueBiGramsCount","required":false,"allowMultiple":false,"paramType":"long"}]},{"name":"wordFrequency","fields":[{"name":"count","required":false,"allowMultiple":false,"paramType":"long"},{"name":"wordstring","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"sentence","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"scoredWord","required":false,"wrapperName":"scoredWords","allowMultiple":false,"paramType":"List[scoredWord]"},{"name":"display","required":false,"allowMultiple":false,"paramType":"string"},{"name":"documentMetadataId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"rating","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"wordObject","fields":[{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"vulgar","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"contentType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"yearType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"documentMetadata","fields":[{"name":"id","required":false,"allowMultiple":false,"paramType":"long"},{"name":"year","required":false,"allowMultiple":false,"paramType":"integer"},{"name":"contentType","required":false,"allowMultiple":false,"paramType":"contentType"},{"name":"provider","required":false,"allowMultiple":false,"paramType":"contentProvider"},{"name":"tag","required":false,"wrapperName":"tags","allowMultiple":false,"paramType":"List[string]"},{"name":"title","required":false,"allowMultiple":false,"paramType":"string"},{"name":"rating","required":false,"allowMultiple":false,"paramType":"double"},{"name":"medium","required":false,"allowMultiple":false,"paramType":"documentMedium"},{"name":"sourceUrl","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"classification","required":false,"allowMultiple":false,"paramType":"subjectClassificationType"},{"name":"date","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"yearType","required":false,"allowMultiple":false,"paramType":"yearType"},{"name":"primaryAuthor","required":false,"allowMultiple":false,"paramType":"string"},{"name":"primaryAuthorType","required":false,"allowMultiple":false,"paramType":"authorType"},{"name":"primaryAuthorId","required":false,"allowMultiple":false,"paramType":"long"},{"name":"guid","required":false,"allowMultiple":false,"paramType":"string"},{"name":"extendedMetadata","required":false,"allowMultiple":false,"paramType":"extendedMetadata"},{"name":"author","required":false,"wrapperName":"authors","allowMultiple":false,"paramType":"List[author]"},{"name":"expirationDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"stats","required":false,"allowMultiple":false,"paramType":"basicDocumentStats"}]},{"name":"partOfSpeech","fields":[{"name":"roots","required":false,"allowMultiple":false,"paramType":"List[root]"}]},{"name":"subjectClassificationType","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"wordSearchResults","fields":[{"name":"totalResults","required":false,"allowMultiple":false,"paramType":"int"},{"name":"searchResult","required":false,"wrapperName":"searchResults","allowMultiple":false,"paramType":"List[WordSearchResult]"}]},{"name":"WordOfTheDay","fields":[{"name":"id","required":true,"allowMultiple":false,"paramType":"long"},{"name":"category","required":false,"allowMultiple":false,"paramType":"string"},{"name":"example","required":false,"wrapperName":"examples","allowMultiple":false,"paramType":"List[SimpleExample]"},{"name":"word","required":false,"allowMultiple":false,"paramType":"string"},{"name":"createdBy","required":false,"allowMultiple":false,"paramType":"string"},{"name":"definition","required":false,"wrapperName":"definitions","allowMultiple":false,"paramType":"List[SimpleDefinition]"},{"name":"contentProvider","required":false,"allowMultiple":false,"paramType":"contentProvider"},{"name":"createdAt","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"publishDate","required":false,"allowMultiple":false,"paramType":"Date"},{"name":"parentId","required":false,"allowMultiple":false,"paramType":"string"},{"name":"note","required":false,"allowMultiple":false,"paramType":"string"},{"name":"htmlExtra","required":false,"allowMultiple":false,"paramType":"string"}]},{"name":"DefinitionSearchResults","fields":[{"name":"totalResults","required":false,"allowMultiple":false,"paramType":"int"},{"name":"result","required":false,"wrapperName":"results","allowMultiple":false,"paramType":"List[definition]"}]},{"name":"SubscriptionStatus","fields":[{"name":"name","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"int"}]},{"name":"EntrySearchResults","fields":[{"name":"totalResults","required":false,"allowMultiple":false,"paramType":"int"},{"name":"searchResult","required":false,"wrapperName":"searchResults","allowMultiple":false,"paramType":"List[EntrySearchResult]"}]},{"name":"SimpleExample","fields":[{"name":"url","required":false,"allowMultiple":false,"paramType":"string"},{"name":"text","required":false,"allowMultiple":false,"paramType":"string"},{"name":"title","required":false,"allowMultiple":false,"paramType":"string"},{"name":"id","required":false,"allowMultiple":false,"paramType":"long"}]}],"basePath":"url","swaggerVersion":"1.0"}
+{"resourcePath":"/words","models":{"SubscriptionStatus":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"SubscriptionStatus"},"citation":{"properties":{"cite":{"type":"string"},"source":{"type":"string"}},"id":"citation"},"wordOfTheDayList":{"properties":{"subscriptionNamespace":{"type":"string"},"subscriberCount":{"type":"int"},"commentCount":{"type":"int"},"subscriptionIdentifier":{"type":"string"},"firstItemDate":{"type":"Date"},"voteCount":{"type":"integer"},"id":{"type":"string","required":true},"category":{"type":"string"},"createdBy":{"type":"string"},"items":{"type":"array","items":{"$ref":"WordOfTheDay"}},"description":{"type":"string"},"createdAt":{"type":"Date"},"name":{"type":"string"},"voteWeightedAverage":{"type":"float"},"subscriptionSchedule":{"type":"string"},"lastItemDate":{"type":"Date"},"voteAverage":{"type":"float"},"itemCount":{"type":"int"},"subscriptionStatus":{"type":"string"}},"id":"wordOfTheDayList"},"definition":{"properties":{"extendedText":{"type":"string"},"citation":{"type":"array","items":{"$ref":"citation"}},"text":{"type":"string"},"sourceDictionary":{"type":"string"},"exampleUsage":{"type":"array","items":{"$ref":"ExampleUsage"}},"relWord":{"type":"array","items":{"$ref":"related"}},"score":{"type":"float"},"label":{"type":"array","items":{"$ref":"Label"}},"seqString":{"type":"string"},"sequence":{"type":"string"},"word":{"type":"string"},"note":{"type":"array","items":{"$ref":"note"}},"textPron":{"type":"array","items":{"$ref":"textPron"}},"partOfSpeech":{"type":"string"}},"id":"definition"},"root":{"properties":{"name":{"type":"string"},"categories":{"type":"array","items":{"$ref":"category"}}},"id":"root"},"WordOfTheDay":{"properties":{"id":{"type":"long","required":true},"parentId":{"type":"string"},"category":{"type":"string"},"definition":{"type":"array","items":{"$ref":"SimpleDefinition"}},"createdBy":{"type":"string"},"createdAt":{"type":"Date"},"contentProvider":{"type":"contentProvider"},"htmlExtra":{"type":"string"},"word":{"type":"string"},"example":{"type":"array","items":{"$ref":"SimpleExample"}},"note":{"type":"string"},"publishDate":{"type":"Date"}},"id":"WordOfTheDay"},"EntrySearchResult":{"properties":{"sourceDictionary":{"type":"string"},"definition":{"type":"array","items":{"$ref":"definition"}},"headWord":{"type":"string"},"entryId":{"type":"long"}},"id":"EntrySearchResult"},"DefinitionSearchResults":{"properties":{"result":{"type":"array","items":{"$ref":"definition"}},"totalResults":{"type":"int"}},"id":"DefinitionSearchResults"},"related":{"properties":{"label1":{"type":"string"},"label2":{"type":"string"},"relationshipType":{"type":"string"},"label3":{"type":"string"},"word":{"type":"array","items":{"type":"string"}},"gram":{"type":"string"},"label4":{"type":"string"}},"id":"related"},"category":{"properties":{"name":{"type":"string"}},"id":"category"},"SimpleDefinition":{"properties":{"text":{"type":"string"},"source":{"type":"string"},"note":{"type":"string"},"partOfSpeech":{"type":"string"}},"id":"SimpleDefinition"},"wordObject":{"properties":{"word":{"type":"string"},"vulgar":{"type":"string"}},"id":"wordObject"},"contentProvider":{"properties":{"id":{"type":"int"},"name":{"type":"string"}},"id":"contentProvider"},"EntrySearchResults":{"properties":{"searchResult":{"type":"array","items":{"$ref":"EntrySearchResult"}},"totalResults":{"type":"int"}},"id":"EntrySearchResults"},"ExampleUsage":{"properties":{"text":{"type":"string"}},"id":"ExampleUsage"},"Label":{"properties":{"text":{"type":"string"},"type":{"type":"string"}},"id":"Label"},"wordFrequency":{"properties":{"count":{"type":"long"},"wordstring":{"type":"string"}},"id":"wordFrequency"},"SimpleExample":{"properties":{"id":{"type":"long"},"title":{"type":"string"},"text":{"type":"string"},"url":{"type":"string"}},"id":"SimpleExample"},"note":{"properties":{"noteType":{"type":"string"},"appliesTo":{"type":"array","items":{"type":"string"}},"value":{"type":"string"},"pos":{"type":"int"}},"id":"note"},"partOfSpeech":{"properties":{"roots":{"type":"array","items":{"$ref":"root"}}},"id":"partOfSpeech"},"textPron":{"properties":{"raw":{"type":"string"},"id":{"type":"long"},"seq":{"type":"int"},"rawType":{"type":"string"}},"id":"textPron"}},"apis":[{"path":"/words.{format}/search","description":"","operations":[{"parameters":[{"name":"allowRegex","defaultValue":"false","description":"Search term is a Regular Expression","required":false,"dataType":"string","allowableValues":["true | false"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"query","description":"Search term","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"caseSensitive","defaultValue":"true","description":"Search case sensitive","required":false,"dataType":"string","allowableValues":["true | false"],"allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"Only include these comma-delimited parts of speech","required":false,"dataType":"string","allowableValues":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"Exclude these comma-delimited parts of speech","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minCorpusCount","defaultValue":"5","description":"Minimum corpus frequency for terms","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"minDictionaryCount","defaultValue":"1","description":"Minimum number of dictionary entries","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"minLength","defaultValue":"1","description":"Minimum word length","required":false,"dataType":"string","allowableValues":["0 to 1024"],"allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"dataType":"string","allowableValues":["0 to 1024"],"allowMultiple":false,"paramType":"query"},{"name":"minLexicalityRating","defaultValue":"0","description":"Minimum lexicality","required":false,"dataType":"string","allowableValues":["0 to 100"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"maxLexicalityRating","defaultValue":"0","description":"Maximum lexicality","required":false,"dataType":"string","allowableValues":["0 to 100"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":["0 to 1000"],"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":["1 to 1000"],"allowMultiple":false,"paramType":"query"}],"summary":"Searches words.","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":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"includeAll","description":"Returns future WordOfTheDay items","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches a WordOfTheDayList by ID","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","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"category","description":"Filters response by category","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"creator","description":"Filters response by username","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns a specific WordOfTheDay","responseTypeInternal":"com.wordnik.community.entity.WordOfTheDay","nickname":"getWordOfTheDay","responseClass":"WordOfTheDay","httpMethod":"GET"}]},{"path":"/words.{format}/searchDefinitions","description":"","operations":[{"parameters":[{"name":"query","description":"Search term","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"definedWordSearchTerm","description":"Defined word search term","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"includeSourceDictionaries","description":"Only include these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":["ahd"," century"," wiktionary"," webster"," wordnet"],"allowMultiple":false,"paramType":"query"},{"name":"excludeSourceDictionaries","description":"Exclude these comma-delimited source dictionaries","required":false,"dataType":"string","allowableValues":["ahd"," century"," wiktionary"," webster"," wordnet"],"allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"Only include these comma-delimited parts of speech","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"Exclude these comma-delimited parts of speech","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minCorpusCount","defaultValue":"5","description":"Minimum corpus frequency for terms","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"dataType":"string","allowableValues":["non-negative integer"],"allowMultiple":false,"paramType":"query"},{"name":"minLength","defaultValue":"1","description":"Minimum word length","required":false,"dataType":"string","allowableValues":["0 to 1024"],"allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"dataType":"string","allowableValues":["0 to 1024"],"allowMultiple":false,"paramType":"query"},{"name":"expandTerms","description":"Expand terms","required":false,"dataType":"string","allowableValues":["synonym","hypernym"],"allowMultiple":false,"paramType":"query"},{"name":"wordTypes","description":"Word types","required":false,"dataType":"string","allowableValues":["word","multi-word-unit"],"allowMultiple":false,"paramType":"query"},{"name":"returnWordsOnly","defaultValue":"false","description":"Return words only","required":false,"dataType":"string","allowableValues":["false","true"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"includeTags","defaultValue":"false","description":"Return a closed set of XML tags in response","required":false,"dataType":"string","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"},{"name":"useTagsForRanking","defaultValue":"true","description":"Use user tags, dictionary labels and hypernyms for ranking","required":false,"dataType":"string","allowableValues":["false","true"],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"sortBy","description":"Attribute to sort by","required":false,"dataType":"string","allowableValues":["alpha","count","length"],"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Sort direction","required":false,"dataType":"string","allowableValues":["asc","desc"],"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":["0 to 1000"],"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":["1 to 1000"],"allowMultiple":false,"paramType":"query"}],"summary":"Searches definitions.","responseTypeInternal":"com.wordnik.index.definition.DefinitionSearchResults","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"nickname":"searchDefinitions","responseClass":"DefinitionSearchResults","httpMethod":"GET"}]},{"path":"/words.{format}/searchEntries","description":"","operations":[{"parameters":[{"name":"query","description":"Search term","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Results to skip","required":false,"dataType":"string","allowableValues":["0 to 1000"],"allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"10","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":["1 to 1000"],"allowMultiple":false,"paramType":"query"}],"summary":"Searches dictionary entries.","responseTypeInternal":"com.wordnik.index.entry.EntrySearchResults","errorResponses":[{"reason":"Invalid term supplied.","code":400}],"nickname":"searchEntries","responseClass":"EntrySearchResults","httpMethod":"GET"}]},{"path":"/words.{format}/surfaceForms","description":"","operations":[{"parameters":[{"name":"term","description":"Word to get surface forms for.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches surface forms of a word","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","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"creator","description":"Filters response by username","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"provider","description":"Filters response by ContentProvider","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns a WordOfTheDay range","responseTypeInternal":"com.wordnik.community.entity.WordOfTheDay","nickname":"getWordOfTheDayRange","responseClass":"List[WordOfTheDay]","httpMethod":"GET"}]},{"path":"/words.{format}/randomWords","description":"","operations":[{"parameters":[{"name":"hasDictionaryDef","description":"Only return words with dictionary definitions","required":false,"dataType":"string","allowableValues":["false","true"],"allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"CSV part-of-speech values to include","required":false,"dataType":"string","allowableValues":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"CSV part-of-speech values to exclude","required":false,"dataType":"string","allowableValues":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"allowMultiple":false,"paramType":"query"},{"name":"minCorpusCount","description":"Minimum corpus frequency for terms (integer)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms (integer)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minDictionaryCount","description":"Minimum dictionary count (integer)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count (integer)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minLength","description":"Minimum word length (characters)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length (characters)","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minLexicalityRating","description":"Minimum lexicality","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"maxLexicalityRating","description":"Maximum lexicality","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"sortBy","description":"Attribute to sort by","required":false,"dataType":"string","allowableValues":["alpha","count"],"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Sort direction","required":false,"dataType":"string","allowableValues":["asc","desc"],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Returns an array of random WordObjects, in the format specified by the URL","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":["false","true"],"allowMultiple":false,"paramType":"query"},{"name":"includePartOfSpeech","description":"CSV part-of-speech values to include","required":false,"dataType":"string","allowableValues":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"allowMultiple":false,"paramType":"query"},{"name":"excludePartOfSpeech","description":"CSV part-of-speech values to exclude","required":false,"dataType":"string","allowableValues":["noun","adjective","verb","adverb","interjection","pronoun","preposition","abbreviation","affix","article","auxiliary-verb","conjunction","definite-article","family-name","given-name","idiom","imperative","noun-plural","noun-posessive","past-participle","phrasal-prefix","proper-noun","proper-noun-plural","proper-noun-posessive","suffix","verb-intransitive","verb-transitive"],"allowMultiple":false,"paramType":"query"},{"name":"minCorpusCount","description":"Minimum corpus frequency for terms","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxCorpusCount","description":"Maximum corpus frequency for terms","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minDictionaryCount","description":"Minimum dictionary count","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxDictionaryCount","description":"Maximum dictionary count","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minLength","description":"Minimum word length","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"maxLength","description":"Maximum word length","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"minLexicalityRating","description":"Minimum lexicality","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"name":"maxLexicalityRating","description":"Maximum lexicality","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Returns a single random WordObject, in the format specified by the URL","responseTypeInternal":"com.wordnik.corpus.entity.Word","errorResponses":[{"reason":"No word found.","code":404}],"nickname":"getRandomWord","responseClass":"wordObject","httpMethod":"GET"}]},{"path":"/words.{format}/wordOfTheDayLists/recent","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches recently created WordOfTheDayLists","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":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"specifier","description":"Specifier for the item to fetch. Either 'current' or a date.","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"includeExtraHtml","description":"Include extra HTML if available","required":false,"dataType":"string","allowableValues":[],"paramAccess":"internal","allowMultiple":false,"paramType":"query"}],"summary":"Fetches a WordOfTheDayList by ID","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","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"subscriberCount","description":"Lists must have the specified number of subscribers","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"itemCount","description":"Lists must have the specified number of items","required":true,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"name":"includeAll","description":"Returns future WordOfTheDay items","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches an array of WordOfTheDayList basd on a criteria","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","allowableValues":[],"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","allowableValues":[],"allowMultiple":false,"paramType":"header"},{"name":"permalink","description":"ID of WordOfTheDayList","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"medium","description":"Medium to subscribe with","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"},{"description":"Username to subscribe","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"body"}],"summary":"Subscribes a user to a WordOfTheDayList","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":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"path"},{"name":"includeAll","description":"Returns future WordOfTheDay items","required":false,"dataType":"string","allowableValues":[],"allowMultiple":false,"paramType":"query"}],"summary":"Fetches WordOfTheDay objects for a specific date","responseTypeInternal":"com.wordnik.community.entity.WordOfTheDay","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"WordOfTheDayList or User not found","code":404}],"nickname":"getWordOfTheDayListsForDate","responseClass":"List[WordOfTheDay]","httpMethod":"GET"}]}],"basePath":"url","swaggerVersion":"1.0"}
View
268 lib/wordnik/resource_modules/account.rb
@@ -57,32 +57,6 @@ def authenticate_post(username, body, *args)
request_only ? request : request.response.body
end
- # Logs out a user
- #
- def logout(*args)
- http_method = :get
- path = '/account/logout'
-
- # 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 WordList objects for the logged-in user.
#
def get_word_lists_for_current_user(*args)
@@ -109,86 +83,6 @@ def get_word_lists_for_current_user(*args)
request_only ? request : request.response.body
end
- # Authenticates a User
- #
- def get_forgot_password(username, *args)
- http_method = :get
- path = '/account/forgotPassword/{username}'
- path.sub!('{username}', username.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 User by code
- #
- def reset_password(hashcode, *args)
- http_method = :get
- path = '/account/resetPassword/{hashcode}'
- path.sub!('{hashcode}', hashcode.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 an API account application.
- #
- def create_api_account(body, *args)
- http_method = :post
- path = '/account/apiAccountApplication'
-
- # 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
-
# Regenerates an API Token. Currently not supported or tested.
#
def create_api_account(*args)
@@ -241,87 +135,6 @@ def get_api_token_status(*args)
request_only ? request : request.response.body
end
- # Logs a VisitAction for the user
- # Requires a valid auth_token to be set.
- #
- def log_visit_for_user(*args)
- http_method = :post
- path = '/account/logVisit'
-
- # 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 an activation code given a username
- # If an activation code is not available, will return null.
- #
- def get_activation_code_for_user(username, *args)
- http_method = :get
- path = '/account/activationCode/{username}'
- path.sub!('{username}', username.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
-
- # Activates an account.
- #
- def activate_user(body, *args)
- http_method = :post
- path = '/account/activate'
-
- # 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 an ApiResponse indicating whether or not a username is available
#
def get_username_available(username, *args)
@@ -376,85 +189,4 @@ def get_logged_in_user(*args)
request_only ? request : request.response.body
end
- # Returns profile info for the logged-in user
- # Requires a valid auth_token to be set.
- #
- def get_logged_in_user_profile(*args)
- http_method = :get
- path = '/account/profile'
-
- # 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 logged-in User Settings
- # Requires a valid auth_token to be set.
- #
- def get_logged_in_user_settings(*args)
- http_method = :get
- path = '/account/settings'
-
- # 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 logged-in User TrackingInfo.
- # Requires a valid auth_token to be set.
- #
- def get_logged_in_user_tracking_info(*args)
- http_method = :get
- path = '/account/trackingInfo'
-
- # 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
89 lib/wordnik/resource_modules/analytics.rb
@@ -1,89 +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 AnalyticsMethods
-
- # Returns top hits over a year, month, week, day or hour
- # 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).
- #
- def get_top_hits(*args)
- http_method = :get
- path = '/analytics/top'
-
- # 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 words which were trending on a given week or month
- # If no time resolution parameters are passed, it returns trending hits for this week.
- # To fetch trending hits for a month, pass (year and month). To fetch trending hits for a week, pass (year and week).
- #
- def get_trending_hits(*args)
- http_method = :get
- path = '/analytics/trending'
-
- # 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 hits a word received in a given year, month, week or day
- # 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)
- #
- def get_word_hits(word, *args)
- http_method = :get
- path = '/analytics/word/{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
-
-end
View
453 lib/wordnik/resource_modules/corpus.rb
@@ -1,453 +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 CorpusMethods
-
- # Fetches recent views from the website.
- #
- def get_recent_views(*args)
- http_method = :get
- path = '/corpus/recentViews'
-
- # 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 WordFrequency data
- #
- def get_word_frequencies(statsType, object, *args)
- http_method = :get
- path = '/corpus/words/{statsType}/{object}'
- path.sub!('{statsType}', statsType.to_s)
- path.sub!('{object}', object.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
-
- # Gets Dictionary Statistics data
- #
- def get_word_frequencies(*args)
- http_method = :get
- path = '/corpus/dictionaryStats'
-
- # 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 Dictionary Statistics data
- #
- def get_word_frequencies(*args)
- http_method = :get
- path = '/corpus/firstUsed'
-
- # 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 count of documents in the Corpus.
- #
- def get_total_document_count(*args)
- http_method = :get
- path = '/corpus/totalDocumentCount'
-
- # 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
-
- # Processes text input.
- # Returns tagged and processed text based on the input string.
- #
- def process_text(body, *args)
- http_method = :post
- path = '/corpus/processText'
-
- # 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 corpus-wide PunctuationFactor.
- #
- def get_punctuation_factor(*args)
- http_method = :get
- path = '/corpus/punctuationFactor'
-
- # 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
-
- # Receives info on phrases which should be captured
- #
- def get_punctuation_factor(body, *args)
- http_method = :post
- 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')
- # 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)
- http_method = :get
- path = '/corpus/documentStats'
-
- # 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 corpus-level WordFrequency
- #
- def get_corpus_word_frequencies(*args)
- http_method = :get
- path = '/corpus/words'
-
- # 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 word relationships.
- #
- def get_dym(wordstring, *args)
- http_method = :get
- path = '/corpus/dymInternal/{wordstring}'
- path.sub!('{wordstring}', wordstring.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 recently listed words.
- #
- def get_recent_listed_words(*args)
- http_method = :get
- path = '/corpus/recentListedWords'
-
- # 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 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
-
- # 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.
- #
- def get_contextual_lookup_info(*args)
- http_method = :post
- 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
-
- # Returns the count of tokens in the Corpus.
- #
- def get_total_tokens_count(*args)
- http_method = :get
- path = '/corpus/totalWordCount'
-
- # 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 count of sentences in the Corpus.
- #
- def get_total_sentences_count(*args)
- http_method = :get
- path = '/corpus/sentenceCount'
-
- # 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
141 lib/wordnik/resource_modules/document.rb
@@ -1,141 +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 DocumentMethods
-
- # Fetches Document objects by Content Provider code.
- #
- def get_word_frequencies(document_id, *args)
- http_method = :get
- path = '/document/id/{document_id}/words'
- path.sub!('{document_id}', document_id.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 a specific provider matching a criteria.
- #
- def get_glossaries(contentProvider, *args)
- http_method = :get
- path = '/document/{contentProvider}/documents'
- path.sub!('{contentProvider}', contentProvider.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 Document objects by Content Provider code.
- #
- def get_documents_by_content_provider(provider, *args)
- http_method = :get
- path = '/document/provider/{provider}'
- path.sub!('{provider}', provider.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 Document objects by document identifier.
- #
- def get_metadata_by_id(id, *args)
- http_method = :get
- path = '/document/{id}/metadata'
- path.sub!('{id}', id.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 Document objects by id.
- #
- def get_model_by_id(id, *args)
- http_method = :get
- path = '/document/{id}/model'
- path.sub!('{id}', id.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)