Skip to content

Commit

Permalink
re-swaggered to get new feeds resource in the mix, bumped version to …
Browse files Browse the repository at this point in the history
…4.06.13.
  • Loading branch information
zeke committed Jan 9, 2012
1 parent 65b69c3 commit 6662057
Show file tree
Hide file tree
Showing 21 changed files with 379 additions and 53 deletions.
2 changes: 1 addition & 1 deletion api_docs/account.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api_docs/analytics.json
@@ -1 +1 @@
{"resourcePath":"/analytics","models":{"WordHitsCollection":{"properties":{"wordHitsList":{"type":"array","items":{"$ref":"wordHits"}}},"id":"wordHitsCollection"},"WordHits":{"properties":{"timeMillis":{"type":"long"}},"id":"wordHits"}},"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":{"values":["site.word"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"year","description":"Year","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"month","description":"Month","required":false,"dataType":"string","allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"week","description":"Week","required":false,"dataType":"string","allowableValues":{"values":["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"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"day","description":"Day","required":false,"dataType":"string","allowableValues":{"values":["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"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"hour","description":"Hour","required":false,"dataType":"string","allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Number of results to skip by","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"50","description":"Number of results to fetch","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns top hits over a year, month, week, day or hour","responseTypeInternal":"com.wordnik.analytics.model.WordHitsCollection","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).","httpMethod":"GET"}]},{"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":{"values":["site.word"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"year","description":"Year","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"month","description":"Month","required":false,"dataType":"string","allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"week","description":"Week","required":false,"dataType":"string","allowableValues":{"values":["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"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Number of results to skip by","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"50","description":"Number of results to fetch","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns words which were trending on a given week or month","responseTypeInternal":"com.wordnik.analytics.model.WordHitsCollection","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).","httpMethod":"GET"}]},{"path":"/analytics.{format}/word/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"Word","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"namespace","defaultValue":"site.word","description":"The namespace for which to return hits","required":false,"dataType":"string","allowableValues":{"values":["site.word"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"year","description":"Year","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"month","description":"Month","required":false,"dataType":"string","allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"week","description":"Week","required":false,"dataType":"string","allowableValues":{"values":["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"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"day","description":"Day","required":false,"dataType":"string","allowableValues":{"values":["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"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Number of results to skip by","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"50","description":"Number of results to fetch","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns hits a word received in a given year, month, week or day","responseTypeInternal":"com.wordnik.analytics.model.WordHitsCollection","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)","httpMethod":"GET"}]}],"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1-SHAPSHOT.121026","apiVersion":"4.0"}
{"resourcePath":"/analytics","models":{"WordHitsCollection":{"properties":{"wordHitsList":{"type":"array","items":{"$ref":"wordHits"}}},"id":"wordHitsCollection"},"WordHits":{"properties":{"timeMillis":{"type":"long"}},"id":"wordHits"}},"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":{"values":["site.word"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"year","description":"Year","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"month","description":"Month","required":false,"dataType":"string","allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"week","description":"Week","required":false,"dataType":"string","allowableValues":{"values":["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"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"day","description":"Day","required":false,"dataType":"string","allowableValues":{"values":["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"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"hour","description":"Hour","required":false,"dataType":"string","allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22","23","24"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Number of results to skip by","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"50","description":"Number of results to fetch","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns top hits over a year, month, week, day or hour","responseTypeInternal":"com.wordnik.analytics.model.WordHitsCollection","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).","httpMethod":"GET"}]},{"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":{"values":["site.word"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"year","description":"Year","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"month","description":"Month","required":false,"dataType":"string","allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"week","description":"Week","required":false,"dataType":"string","allowableValues":{"values":["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"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Number of results to skip by","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"50","description":"Number of results to fetch","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns words which were trending on a given week or month","responseTypeInternal":"com.wordnik.analytics.model.WordHitsCollection","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).","httpMethod":"GET"}]},{"path":"/analytics.{format}/word/{word}","description":"","operations":[{"parameters":[{"name":"word","description":"Word","required":true,"dataType":"string","allowMultiple":false,"paramType":"path"},{"name":"namespace","defaultValue":"site.word","description":"The namespace for which to return hits","required":false,"dataType":"string","allowableValues":{"values":["site.word"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"year","description":"Year","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"month","description":"Month","required":false,"dataType":"string","allowableValues":{"values":["1","2","3","4","5","6","7","8","9","10","11","12"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"week","description":"Week","required":false,"dataType":"string","allowableValues":{"values":["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"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"day","description":"Day","required":false,"dataType":"string","allowableValues":{"values":["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"],"valueType":"LIST"},"allowMultiple":false,"paramType":"query"},{"name":"skip","defaultValue":"0","description":"Number of results to skip by","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"},{"name":"limit","defaultValue":"50","description":"Number of results to fetch","required":false,"dataType":"string","allowMultiple":false,"paramType":"query"}],"summary":"Returns hits a word received in a given year, month, week or day","responseTypeInternal":"com.wordnik.analytics.model.WordHitsCollection","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)","httpMethod":"GET"}]}],"basePath":"http://api.wordnik.com/v4","swaggerVersion":"1.1-SNAPSHOT.121130","apiVersion":"4.0"}

0 comments on commit 6662057

Please sign in to comment.