diff options
author | Drew DeVault <sir@cmpwn.com> | 2019-03-03 12:05:39 -0700 |
---|---|---|
committer | Drew DeVault <sir@cmpwn.com> | 2019-03-03 12:05:39 -0700 |
commit | baf8db11537eae70eac6734f0a22aec99bc9e1e9 (patch) | |
tree | 25a93daf69050afc867433512d395c0903fbbf11 /api-conventions.md | |
parent | 10fd5592a6aba622d00f06b29c100e243c838389 (diff) | |
download | sr.ht-docs-baf8db11537eae70eac6734f0a22aec99bc9e1e9.tar.gz |
Add user to standard resources
Diffstat (limited to 'api-conventions.md')
-rw-r--r-- | api-conventions.md | 26 |
1 files changed, 26 insertions, 0 deletions
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 |