{"resourcePath":"/wordList","models":{"Long":{"properties":{"value":{"type":"long"}},"id":"long"},"WordList":{"properties":{"updatedAt":{"type":"Date"},"id":{"type":"long"},"permalinkId":{"type":"string"},"lastActivityAt":{"type":"Date"},"createdAt":{"type":"Date"},"description":{"type":"string"},"userId":{"type":"long"},"name":{"type":"string"},"userName":{"type":"string"},"numberWordsInList":{"type":"long"},"type":{"type":"string"}},"id":"wordList"},"BooleanValue":{"properties":{"value":{"type":"boolean"}},"id":"BooleanValue"},"Tag":{"properties":{"id":{"type":"long"},"count":{"type":"long"},"name":{"type":"string"}},"id":"tag"},"Comment":{"properties":{"id":{"type":"string"},"updatedAt":{"type":"Date"},"body":{"type":"string"},"approved":{"type":"boolean"},"disemvoweled":{"type":"boolean"},"commentedOn":{"type":"string"},"createdAt":{"type":"Date"},"objectId":{"type":"long"},"commentedBy":{"type":"string"},"objectType":{"type":"string"}},"id":"comment"}},"apis":[{"path":"/wordList.{format}/{wordListId}","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to update","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Updated WordList","required":false,"dataType":"wordList","valueTypeInternal":"com.wordnik.community.entity.WordList","allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Updates an existing WordList","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to update WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"updateWordList","responseClass":"ok","httpMethod":"PUT"},{"parameters":[{"name":"wordListId","description":"ID of WordList to delete","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Deletes an existing WordList","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to delete WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"deleteWordList","responseClass":"ok","httpMethod":"DELETE"},{"parameters":[{"name":"wordListId","description":"ID of WordList to fetch","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Fetches a WordList by ID","responseTypeInternal":"com.wordnik.community.entity.WordList","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"getWordListById","responseClass":"wordList","httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/words","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to user","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to add words on behalf of","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"description":"Array of words to add to WordList","required":false,"dataType":"StringValue[]","valueTypeInternal":"[Lcom.wordnik.resource.StringValue;","allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Adds words to a WordList","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"addWordsToWordList","responseClass":"ok","httpMethod":"POST"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"sortBy","defaultValue":"createDate","description":"Field to sort by","required":false,"dataType":"string","allowableValues":{"values":["createDate","alpha"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"sortOrder","defaultValue":"desc","description":"Direction to sort","required":false,"dataType":"string","allowableValues":{"values":["asc","desc"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Fetches words in a WordList","responseTypeInternal":"com.wordnik.community.entity.WordListWord","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"getWordListWords","responseClass":"com.wordnik.community.entity.WordListWord","httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/isFavorite","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to check","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to check for Favorite status","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Checks to see if a WordList has been favorited for a user","responseTypeInternal":"com.wordnik.system.model.BooleanValue","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"Not Authorized to favorite WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"isFavoriteWordList","responseClass":"BooleanValue","httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/favorite","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to fetch","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to favorite on behalf of","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Favorites a WordList for a User","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"Not Authorized to favorite WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"favoriteWordList","responseClass":"ok","httpMethod":"POST"},{"parameters":[{"name":"wordListId","description":"ID of WordList to fetch","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to unfavorite on behalf of","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Unfavorites a WordList for a User","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid ID supplied.","code":400},{"reason":"Not Authorized to favorite WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"unFavoriteWordList","responseClass":"ok","httpMethod":"DELETE"}]},{"path":"/wordList.{format}/{wordListId}/tags","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to get Tags for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches Tags on a WordList","responseTypeInternal":"com.wordnik.community.entity.Tag","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListTags","responseClass":"List[tag]","httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/tagCount","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to get Tags for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches Tag count on a WordList","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListTagCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/tag","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to add Tags for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"tags","description":"Tags to add","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Adds a Tag on a WordList","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"addWordListTag","responseClass":"ok","httpMethod":"POST"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to delete Tags for","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"tags","description":"Tags to delete","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Deletes a tag on a WordList","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"deleteWordListTag","responseClass":"ok","httpMethod":"DELETE"}]},{"path":"/wordList.{format}/{wordListId}/comments","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"skip","description":"Results to skip","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","description":"Maximum number of results to return","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"sortOrder","description":"Direction to sort","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Fetches comments on a WordList","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListComments","responseClass":"List[comment]","httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/comment","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Comment to add","required":false,"dataType":"comment","valueTypeInternal":"com.wordnik.community.entity.Comment","allowMultiple":false,"paramType":"body"}],"summary":"Adds a Comment on a WordList","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"Not Authorized to access WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"addCommentToWordList","responseClass":"comment","httpMethod":"POST"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"description":"Updated Comment","required":false,"dataType":"comment","valueTypeInternal":"com.wordnik.community.entity.Comment","allowMultiple":false,"paramType":"body"}],"summary":"Updates a Comment on a WordList","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"Not Authorized to access WordList.","code":403},{"reason":"WordList not found.","code":404}],"nickname":"updateCommentOnWordList","responseClass":"comment","httpMethod":"PUT"}]},{"path":"/wordList.{format}/{wordListId}/comment/{commentId}","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Comment ID to fetch","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches a WordList comment by ID","responseTypeInternal":"com.wordnik.community.entity.Comment","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList or Comment not found.","code":404}],"nickname":"getWordListCommentById","responseClass":"comment","httpMethod":"GET"},{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"commentId","description":"Comment ID to delete","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Deletes a WordList comment by ID","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList or Comment not found.","code":404}],"nickname":"deleteWordListCommentById","responseClass":"ok","httpMethod":"DELETE"}]},{"path":"/wordList.{format}/{wordListId}/commentCount","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"}],"summary":"Fetches WordList Comment count","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid WordList ID supplied.","code":400},{"reason":"WordList not found.","code":404}],"nickname":"getWordListCommentCount","responseClass":"long","httpMethod":"GET"}]},{"path":"/wordList.{format}/{wordListId}/deleteWords","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"username","description":"Username to remove words on behalf of","required":false,"dataType":"string","paramAccess":"internal","allowMultiple":false,"paramType":"query"},{"description":"Words to remove from WordList","required":false,"dataType":"StringValue[]","valueTypeInternal":"[Lcom.wordnik.resource.StringValue;","allowMultiple":false,"paramType":"body"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Removes words from a WordList","responseTypeInternal":"ok","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to modify WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"deleteWordsFromWordList","responseClass":"ok","httpMethod":"POST"}]},{"path":"/wordList.{format}/{wordListId}/wordsCount","description":"","operations":[{"parameters":[{"name":"wordListId","description":"ID of WordList to use","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"auth_token","description":"The auth token of the logged-in user, obtained by calling /account.{format}/authenticate/{username} (described above)","required":true,"dataType":"string","allowMultiple":false,"paramType":"header"}],"summary":"Gets a count of Words in a WordList","responseTypeInternal":"com.wordnik.system.model.LongResult","errorResponses":[{"reason":"Invalid ID supplied","code":400},{"reason":"Not Authorized to access WordList","code":403},{"reason":"WordList not found","code":404}],"nickname":"getWordListWordsCount","responseClass":"long","httpMethod":"GET"}]}],"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1-SNAPSHOT.121130","apiVersion":"4.0"}