summaryrefslogtreecommitdiffstats
path: root/notes/more_api_patterns.txt
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2018-06-28 12:25:03 -0700
committerBryan Newbold <bnewbold@robocracy.org>2018-06-28 12:25:03 -0700
commit6b19abf279ff3aef44615a87f4ab671a8e515ebb (patch)
tree1b49cb773fa93fc3e39c2c4120d5f69d154fd120 /notes/more_api_patterns.txt
parent3a49586df2545723a6cc6280cd8c9b75a535042f (diff)
downloadfatcat-6b19abf279ff3aef44615a87f4ab671a8e515ebb.tar.gz
fatcat-6b19abf279ff3aef44615a87f4ab671a8e515ebb.zip
stripe API design note
Diffstat (limited to 'notes/more_api_patterns.txt')
-rw-r--r--notes/more_api_patterns.txt15
1 files changed, 15 insertions, 0 deletions
diff --git a/notes/more_api_patterns.txt b/notes/more_api_patterns.txt
new file mode 100644
index 00000000..ca61ac81
--- /dev/null
+++ b/notes/more_api_patterns.txt
@@ -0,0 +1,15 @@
+
+If returning a long list (eg, all releases for a container):
+
+ "releases": {
+ "data": [
+ <release>,
+ <release>,
+ ...
+ ],
+ "has_mode": true,
+ "total_count": 100,
+ "url": "/v0/container/asdf/releases"
+ }
+
+This pattern from the Stripe API.