Created
October 1, 2014 20:39
-
-
Save DoggettCK/a54f49718d5ac2c74019 to your computer and use it in GitHub Desktop.
API self-documentation output
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
RelativePath: "api/products/get?sort_by={sort_by}&sort_order={sort_order}", | |
Method: "GET", | |
SupportedResponseFormats: [ | |
"application/json", | |
"text/json" | |
], | |
SupportedEncodings: [ | |
"utf-8", | |
"utf-16" | |
], | |
Documentation: "Gets full list of products.", | |
Parameters: [{ | |
Name: "sort_by", | |
Source: "From URL", | |
Documentation: "Field name to sort products by. Defaults to " | |
WilsonScore ".", | |
Descriptor: { | |
Default: "Name", | |
Optional: true, | |
Type: "String" | |
} | |
}, { | |
Name: "sort_order", | |
Source: "From URL", | |
Documentation: "ASC or DESC", | |
Descriptor: { | |
Default: "ASC", | |
Optional: true, | |
Type: "String" | |
} | |
}] | |
}, { | |
RelativePath: "api/products/review_rating_volume_comparison?filter={filter}", | |
Method: "GET", | |
SupportedResponseFormats: [ | |
"application/json", | |
"text/json" | |
], | |
SupportedEncodings: [ | |
"utf-8", | |
"utf-16" | |
], | |
Documentation: "Gets date-bucketed, aggregated counts and averages of ratings and reviews.", | |
Parameters: [{ | |
Name: "filter", | |
Source: "From URL", | |
Documentation: "", | |
Descriptor: { | |
Default: null, | |
Optional: true, | |
Type: "String" | |
} | |
}] | |
}, { | |
RelativePath: "api/products/review_rating_volatility?filter={filter}", | |
Method: "GET", | |
SupportedResponseFormats: [ | |
"application/json", | |
"text/json" | |
], | |
SupportedEncodings: [ | |
"utf-8", | |
"utf-16" | |
], | |
Documentation: "Gets the top 5 products whose ratings have moved the most in the positive and negative directions (10 total).", | |
Parameters: [{ | |
Name: "filter", | |
Source: "From URL", | |
Documentation: "", | |
Descriptor: { | |
Default: null, | |
Optional: true, | |
Type: "String" | |
} | |
}] | |
}, { | |
RelativePath: "api/products/top_level_numbers?filter={filter}", | |
Method: "GET", | |
SupportedResponseFormats: [ | |
"application/json", | |
"text/json" | |
], | |
SupportedEncodings: [ | |
"utf-8", | |
"utf-16" | |
], | |
Documentation: "Gets top level numbers across all products, filterable by date range, age, gender, rating type, and product.", | |
Parameters: [{ | |
Name: "filter", | |
Source: "From URL", | |
Documentation: "", | |
Descriptor: { | |
Default: null, | |
Optional: true, | |
Type: "String" | |
} | |
}] | |
}, { | |
RelativePath: "api/reviews/summary?per_page={per_page}&page={page}&filter={filter}&sort_by={sort_by}&sort_order={sort_order}", | |
Method: "GET", | |
SupportedResponseFormats: [ | |
"application/json", | |
"text/json" | |
], | |
SupportedEncodings: [ | |
"utf-8", | |
"utf-16" | |
], | |
Documentation: "", | |
Parameters: [{ | |
Name: "per_page", | |
Source: "From URL", | |
Documentation: "", | |
Descriptor: { | |
Default: 10, | |
Optional: true, | |
Type: "Unsigned 32-bit integer" | |
} | |
}, { | |
Name: "page", | |
Source: "From URL", | |
Documentation: "", | |
Descriptor: { | |
Default: 0, | |
Optional: true, | |
Type: "Unsigned 32-bit integer" | |
} | |
}, { | |
Name: "filter", | |
Source: "From URL", | |
Documentation: "", | |
Descriptor: { | |
Default: null, | |
Optional: true, | |
Type: "String" | |
} | |
}, { | |
Name: "sort_by", | |
Source: "From URL", | |
Documentation: "", | |
Descriptor: { | |
Default: null, | |
Optional: true, | |
Type: "String" | |
} | |
}, { | |
Name: "sort_order", | |
Source: "From URL", | |
Documentation: "", | |
Descriptor: { | |
Default: null, | |
Optional: true, | |
Type: "String" | |
} | |
}] | |
}, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment