{"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"}