api_docs/user.json in wordnik-0.4.5 vs api_docs/user.json in wordnik-0.4.6
- old
+ new
@@ -1 +1 @@
-{}
+{"endPoints":[{"path":"/user.{format}/{username}/wordOfTheDay/{date}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDay owner","required":true,"dataType":"string","paramType":"path"},{"name":"date","description":"Date of the WordOfTheDay to retrieve (yyyy-MM-dd) format","required":true,"dataType":"string","paramType":"path"},{"name":"includeAll","description":"Include WordOfTheDay items for future dates (owner-only)","required":false,"dataType":"string","paramType":"query"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"WordOfTheDay","errorResponses":[{"reason":"Invalid username or dateString supplied","code":400},{"reason":"User not found or no list available","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Returns the WordOfTheDay for a given user on a given date","suggestedName":"getWordOfTheDayByDate","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/wordOfTheDayList","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"includeAll","description":"Include future words (owner-only)","required":false,"dataType":"string","paramType":"query"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"wordOfTheDayList","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"No WordOfTheDayList available","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Returns a user's WordOfTheDayList","suggestedName":"getWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"GET"}]},{"path":"/user.{format}/{username}/wordOfTheDayList","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"description":"Updated WordOfTheDayList data in the format specified by the URL","required":true,"dataType":"wordOfTheDayList","paramType":"body"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"Not authorized to perform update","code":403},{"reason":"No WordOfTheDayList available","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Updates a user's WordOfTheDayList","suggestedName":"updateWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/wordOfTheDayList","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"description":"WordOfTheDayList to create, provided in the format specified by the URL","required":true,"dataType":"wordOfTheDayList","paramType":"body"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"wordOfTheDayList","errorResponses":[{"reason":"User already has a list or list is invalid","code":400},{"reason":"User not found","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Creates a WordOfTheDayList","suggestedName":"createWordOfTheDayList","deprecated":false,"open":false,"notes":"A user can have only one WordOfTheDayList.","httpMethod":"POST"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"permalink","description":"Permalink of the WordOfTheDayList to add the WordOfTheDay to","required":true,"dataType":"string","paramType":"path"},{"description":"WordOfTheDay to add, in the format specified by the URL","required":true,"dataType":"WordOfTheDay","paramType":"body"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"void","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}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Adds a WordOfTheDay to a user's WordOfTheDayList","suggestedName":"updateItemInWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"PUT"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"permalink","description":"Permalink of WordOfTheDayList to delete","required":true,"dataType":"string","paramType":"path"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"void","errorResponses":[{"reason":"Invalid username supplied","code":400},{"reason":"Not authorized to perform update","code":403},{"reason":"No WordOfTheDayList available","code":404}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Deletes a user's WordOfTheDayList","suggestedName":"updateWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}/{wordToDelete}","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"permalink","description":"Permalink of WordOfTheDayList to delete a word from","required":true,"dataType":"string","paramType":"path"},{"name":"wordToDelete","description":"Word to delete","required":true,"dataType":"string","paramType":"path"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"void","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}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Deletes a specific word from a user's WordOfTheDayList","suggestedName":"deleteWordFromWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"DELETE"}]},{"path":"/user.{format}/{username}/wordOfTheDayList/{permalink}/add","description":"","operations":[{"parameters":[{"name":"username","description":"Username of the WordOfTheDayList owner","required":true,"dataType":"string","paramType":"path"},{"name":"permalink","description":"WordOfTheDayList to modify","required":true,"dataType":"string","paramType":"path"},{"description":"WordOfTheDay to add","required":true,"dataType":"WordOfTheDay","paramType":"body"},{"name":"format","defaultValue":"json","description":"API response format","required":true,"allowableValues":"json,xml","paramType":"path"}],"response":[{"valueType":"void","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}],"condition":"any"}],"category":"WordOfTheDayList","summary":"Adds an item to a user's WordOfTheDayList","suggestedName":"addWordToWordOfTheDayList","deprecated":false,"open":false,"httpMethod":"PUT"}]}],"models":[{"name":"partOfSpeech","fields":[{"name":"roots","required":false,"paramType":"List[root]"}]},{"name":"contentProvider","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"WordOfTheDay","fields":[{"name":"id","required":true,"paramType":"long"},{"name":"category","required":false,"paramType":"string"},{"name":"example","required":false,"wrapperName":"examples","paramType":"List[SimpleExample]"},{"name":"createdBy","required":false,"paramType":"string"},{"name":"word","required":false,"paramType":"string"},{"name":"definition","required":false,"wrapperName":"definitions","paramType":"List[SimpleDefinition]"},{"name":"contentProvider","required":false,"paramType":"contentProvider"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"publishDate","required":false,"paramType":"Date"},{"name":"parentId","required":false,"paramType":"string"},{"name":"note","required":false,"paramType":"string"},{"name":"htmlExtra","required":false,"paramType":"string"}]},{"name":"SubscriptionStatus","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"int"}]},{"name":"SimpleDefinition","fields":[{"name":"text","required":false,"paramType":"string"},{"name":"partOfSpeech","required":false,"paramType":"string"},{"name":"note","required":false,"paramType":"string"},{"name":"source","required":false,"paramType":"string"}]},{"name":"wordOfTheDayList","fields":[{"name":"name","required":false,"paramType":"string"},{"name":"id","required":true,"paramType":"string"},{"name":"description","required":false,"paramType":"string"},{"name":"category","required":false,"paramType":"string"},{"name":"createdBy","required":false,"paramType":"string"},{"name":"items","required":false,"paramType":"List[WordOfTheDay]"},{"name":"subscriberCount","required":false,"paramType":"int"},{"name":"subscriptionStatus","required":false,"paramType":"string"},{"name":"createdAt","required":false,"paramType":"Date"},{"name":"commentCount","required":false,"paramType":"int"},{"name":"voteCount","required":false,"paramType":"integer"},{"name":"voteAverage","required":false,"paramType":"float"},{"name":"voteWeightedAverage","required":false,"paramType":"float"},{"name":"itemCount","required":false,"paramType":"int"},{"name":"firstItemDate","required":false,"paramType":"Date"},{"name":"lastItemDate","required":false,"paramType":"Date"},{"name":"subscriptionSchedule","required":false,"paramType":"string"},{"name":"subscriptionNamespace","required":false,"paramType":"string"},{"name":"subscriptionIdentifier","required":false,"paramType":"string"}]},{"name":"SimpleExample","fields":[{"name":"url","required":false,"paramType":"string"},{"name":"text","required":false,"paramType":"string"},{"name":"title","required":false,"paramType":"string"},{"name":"id","required":false,"paramType":"long"}]}]}
\ No newline at end of file