From baf8db11537eae70eac6734f0a22aec99bc9e1e9 Mon Sep 17 00:00:00 2001 From: Drew DeVault Date: Sun, 3 Mar 2019 12:05:39 -0700 Subject: Add user to standard resources --- api-conventions.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/api-conventions.md b/api-conventions.md index 8e12303..04f3098 100644 --- a/api-conventions.md +++ b/api-conventions.md @@ -134,6 +134,32 @@ guarantees about interface stability. } ``` +## Standard resources + +### User resource + +**full form** + +```json +{ + "canonical_name": "~username", + "name": "username", + "email": "email", + "url": "url" or null, + "location": "location" or null, + "bio": "bio" or null, +} +``` + +**short form** + +```json +{ + "canonical_name": "~username", + "name": "username", +} +``` + ## Webhooks Most resources will have webhooks which can deliver updates to your application -- cgit