{"endPoints":[{"path":"/wordLists.{format}/find/{searchString}","description":"","operations":[{"parameters":[{"name":"searchString","description":"String to search for","required":false,"dataType":"string","paramType":"path"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordList]","errorResponses":[{"reason":"Not authenticated.","code":403}],"condition":"any"}],"category":"WordLists","summary":"Fetches WordList objects by name.","suggestedName":"findByName","deprecated":false,"open":false,"notes":"The term supplied is effectively given a wildcard before and after so 'cat' becomes '%cat%'","httpMethod":"GET"}]},{"path":"/wordLists.{format}","description":"","operations":[{"parameters":[{"description":"WordList to create","required":false,"dataType":"wordList","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","paramType":"header"}],"response":[{"valueType":"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}],"condition":"any"}],"category":"WordLists","summary":"Creates a WordList.","suggestedName":"createWordList","deprecated":false,"open":false,"httpMethod":"POST"},{"response":[{"valueType":"doc","errorResponses":[{"reason":"No data available","code":404}],"condition":"any"}],"category":"Help","summary":"Returns information about API parameters","suggestedName":"getHelp","deprecated":false,"open":true,"httpMethod":"GET"}]},{"path":"/wordLists.{format}/mostCommentedOn","description":"","operations":[{"parameters":[{"name":"dayInterval","description":"Interval in days","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[commentSummary]","errorResponses":[{"reason":"Not authenticated.","code":403}],"condition":"any"}],"category":"WordLists","summary":"Fetches a CommentSummary for WordList objects.","suggestedName":"findMostCommentedOn","deprecated":false,"open":false,"notes":"The CommentSummary is sorted by comment count, descending","httpMethod":"GET"}]},{"path":"/wordLists.{format}/containing/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"Word to find lists for","required":false,"dataType":"string","paramType":"path"},{"name":"username","description":"Username to add words on behalf of","required":false,"dataType":"string","paramAccess":"internal","paramType":"query"}],"response":[{"valueType":"List[wordList]","errorResponses":[{"reason":"Invalid word or username supplied.","code":400},{"reason":"Not authenticated.","code":403}],"condition":"any"}],"category":"WordLists","summary":"Fetches WordList objects containing a word.","suggestedName":"findContainingWord","deprecated":false,"open":false,"notes":"Results are scoped to the supplied user.","httpMethod":"GET"}]},{"path":"/wordLists.{format}/recentLists","description":"","operations":[{"parameters":[{"name":"skip","description":"Results to skip","required":false,"dataType":"string","paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","paramType":"query"},{"name":"type","description":"WordListType to filter by","required":false,"dataType":"string","paramType":"query"}],"response":[{"valueType":"List[wordList]","errorResponses":[{"reason":"Not authenticated.","code":403}],"condition":"any"}],"category":"WordLists","summary":"Fetches recently created WordList objects.","suggestedName":"findRecentLists","deprecated":false,"open":false,"httpMethod":"GET"}]}],"models":[{"name":"error","fields":[{"name":"reason","required":false,"paramType":"string"},{"name":"code","required":false,"paramType":"int"}]},{"name":"response","fields":[{"name":"valueType","required":false,"paramType":"string"},{"name":"errorResponses","required":false,"paramType":"List[error]"},{"name":"occurs","required":false,"paramType":"string"},{"name":"condition","required":false,"paramType":"string"}]},{"name":"parameter","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"defaultValue","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"required","required":false,"paramType":"boolean"},{"name":"dataType","required":false,"paramType":"string"},{"name":"allowableValues","required":false,"paramType":"string"},{"name":"wrapperName","required":false,"paramType":"string"},{"name":"internalDescription","required":false,"paramType":"string"},{"name":"paramAccess","required":false,"paramType":"string"},{"name":"paramType","required":false,"paramType":"string"}]},{"name":"wordList","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"long"},{"name":"type","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"userId","required":false,"paramType":"long"},{"name":"permalink","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"username","required":false,"paramType":"string"},{"name":"updatedAt","required":false,"paramType":"Date"},{"name":"numberWordsInList","required":false,"paramType":"long"}]},{"name":"doc","fields":[{"name":"endPoints","required":false,"paramType":"List[endpoint]"},{"name":"models","required":false,"paramType":"List[object]"}]},{"name":"commentSummary","fields":[{"name":"objectType","required":false,"paramType":"string"},{"name":"totalCount","required":false,"paramType":"long"},{"name":"objectName","required":false,"paramType":"string"},{"name":"countInInterval","required":false,"paramType":"long"},{"name":"intervalInMilliseconds","required":false,"paramType":"long"},{"name":"objectDisplayName","required":false,"paramType":"string"}]},{"name":"object","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"fields","required":false,"paramType":"List[parameter]"},{"name":"uniqueFieldName","required":false,"paramType":"string"}]},{"name":"endpoint","fields":[{"name":"path","required":false,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"operations","required":false,"paramType":"List[operation]"}]},{"name":"operation","fields":[{"name":"parameters","required":false,"paramType":"List[parameter]"},{"name":"response","required":false,"paramType":"List[response]"},{"name":"category","required":false,"paramType":"string"},{"name":"summary","required":false,"paramType":"string"},{"name":"suggestedName","required":false,"paramType":"string"},{"name":"deprecated","required":false,"paramType":"boolean"},{"name":"open","required":false,"paramType":"boolean"},{"name":"notes","required":false,"paramType":"string"},{"name":"httpMethod","required":false,"paramType":"string"}]}]}