Kolby Moroz Liebl
    • Create new note
    • Create a note from template
      • Sharing URL Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Customize slides
      • Note Permission
      • Read
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Write
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Engagement control Commenting, Suggest edit, Emoji Reply
    • Invite by email
      Invitee

      This note has no invitees

    • Publish Note

      Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note

      Your note will be visible on your profile and discoverable by anyone.
      Your note is now live.
      This note is visible on your profile and discoverable online.
      Everyone on the web can find and read all notes of this public team.
      See published notes
      Unpublish note
      Please check the box to agree to the Community Guidelines.
      View profile
    • Commenting
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
      • Everyone
    • Suggest edit
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
    • Emoji Reply
    • Enable
    • Versions and GitHub Sync
    • Note settings
    • Note Insights New
    • Engagement control
    • Make a copy
    • Transfer ownership
    • Delete this note
    • Save as template
    • Insert from template
    • Import from
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
    • Export to
      • Dropbox
      • Google Drive
      • Gist
    • Download
      • Markdown
      • HTML
      • Raw HTML
Menu Note settings Note Insights Versions and GitHub Sync Sharing URL Create Help
Create Create new note Create a note from template
Menu
Options
Engagement control Make a copy Transfer ownership Delete this note
Import from
Dropbox Google Drive Gist Clipboard
Export to
Dropbox Google Drive Gist
Download
Markdown HTML Raw HTML
Back
Sharing URL Link copied
/edit
View mode
  • Edit mode
  • View mode
  • Book mode
  • Slide mode
Edit mode View mode Book mode Slide mode
Customize slides
Note Permission
Read
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Write
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Engagement control Commenting, Suggest edit, Emoji Reply
  • Invite by email
    Invitee

    This note has no invitees

  • Publish Note

    Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note

    Your note will be visible on your profile and discoverable by anyone.
    Your note is now live.
    This note is visible on your profile and discoverable online.
    Everyone on the web can find and read all notes of this public team.
    See published notes
    Unpublish note
    Please check the box to agree to the Community Guidelines.
    View profile
    Engagement control
    Commenting
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Suggest edit
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    Emoji Reply
    Enable
    Import from Dropbox Google Drive Gist Clipboard
       Owned this note    Owned this note      
    Published Linked with GitHub
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    # API Specs Assume that all nodes have direct connections to one another. (It simplifies the process a whole lot more) ## Post Propagation There are two types of posts that are propagated. ### Regular Posts The **source** post id should match the **origin** post id if we receive a post through the inbox that is not a shared post. In this case, we add a post with the same `id` and all other properties of the received post ### Shared Posts The **source** of the post gives the api url to the post that the share button was clicked. In our system, the author id and post id of the `source` is the author who SHARED the post and their copy post id. This way you can track who actually shared the post for the following feeds. (Since all other fields are of the original post that was shared with no ref to who shared the post) ## Likes I'm not totally set on this yet, and I'd love to hear how you guys would approach this. My approach is kinda like a proxy in a sense? ### Liking a Local Post Create a like object locally, and then that's it. ### Liking a Remote Post Send a like object to the post’s origin author inbox. The origin node is responsible for storing and sending out all likes. When a request is made on your node to fetch the likes of a post that originated from a remote node, it should internally send a request to the remote node and return the contents back to your original request. ## Comments This follows the same system as likes basically. Comments and stored on the original node that created the post. ## Friends/Following ### Following: - A remote author sends an inbox payload to the remote host. If the remote author accepts the request, a Following object is created on the remote node. ### Unfollowing: - When unfollowing an author, the author that was unfollowed should be sent an inbox message stating that they were unfollowed. (Should be of the type "Unfollow") - Additionally, after accepting/rejecting a friend request, the node should send back a "FollowResponse" inbox message. - See Friends/Follow Requests down below for more information as to the contents of the inbox message. - 1 Follow ```json { "type": "Follow", "summary":"Greg rejected your friend request.", "actor":{ "type":"author", "id":"http://127.0.0.1:5454/authors/1d698d25ff008f7538453c120f581471", "url":"http://127.0.0.1:5454/authors/1d698d25ff008f7538453c120f581471", "host":"http://127.0.0.1:5454/", "displayName":"Greg Johnson", "github": "http://github.com/gjohnson", "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" }, "object":{ "type":"author", "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "host":"http://127.0.0.1:5454/", "displayName":"Lara Croft", "url":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "github": "http://github.com/laracroft", "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" }, } ``` - Unfollow ```json { "type": "Unfollow", "summary":"Greg rejected your friend request.", "actor":{ "type":"author", "id":"http://127.0.0.1:5454/authors/1d698d25ff008f7538453c120f581471", "url":"http://127.0.0.1:5454/authors/1d698d25ff008f7538453c120f581471", "host":"http://127.0.0.1:5454/", "displayName":"Greg Johnson", "github": "http://github.com/gjohnson", "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" }, "object":{ "type":"author", "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "host":"http://127.0.0.1:5454/", "displayName":"Lara Croft", "url":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "github": "http://github.com/laracroft", "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" }, } ``` - FollowResponse ```json { "type": "FollowResponse", "summary":"Greg rejected your friend request.", "actor":{ "type":"author", "id":"http://127.0.0.1:5454/authors/1d698d25ff008f7538453c120f581471", "url":"http://127.0.0.1:5454/authors/1d698d25ff008f7538453c120f581471", "host":"http://127.0.0.1:5454/", "displayName":"Greg Johnson", "github": "http://github.com/gjohnson", "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" }, "object":{ "type":"author", "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "host":"http://127.0.0.1:5454/", "displayName":"Lara Croft", "url":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "github": "http://github.com/laracroft", "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" }, // Was the friend request rejected or accepted? "accepted": false } ``` # API REMOTE ENDPOINTS EACH TEAM MUST SUPPORT ### Authors - URL/api/authors/ - GET [local, remote]: retrieve all profiles on the server (paginated) - page: how many pages - size: how big is a page - Example query: GET URL/api/authors?page=10&size=5 - Gets the 5 authors, authors 45 to 49. - Example: GET URL/api/authors/ ```json { "type": "authors", "items":[ { "type":"author", "id":"http://127.0.0.1:5454/api/authors/<uuid>", "url":"http://127.0.0.1:5454/api/authors/1d698d25ff008f7538453c120f581471", "host":"http://127.0.0.1:5454/", "displayName":"Greg Johnson", "github": "http://github.com/gjohnson", "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" }, { "type":"author", "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "host":"http://127.0.0.1:5454/", "displayName":"Lara Croft", "url":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "github": "http://github.com/laracroft", "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" } ] } ``` ### Single Author - URL/api/authors/{AUTHOR_ID}/ - GET [local, remote]: retrieve AUTHOR_ID's profile - Example Format: ```json { "type":"author", // ID of the Author "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", // the home host of the author "host":"http://127.0.0.1:5454/", // the display name of the author "displayName":"Lara Croft", // url to the authors profile "url":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", // HATEOS url for Github API "github": "http://github.com/laracroft", // Image from a public domain "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" } ``` ### Followers - URL/api/authors/{AUTHOR_ID}/followers - GET [local, remote]: get a list of authors who are AUTHOR_ID's followers - URL/api/authors/{AUTHOR_ID}/followers/{FOREIGN_AUTHOR_ID} - Note: foreign author ID should be a percent encoded URL of the foreign author. An example URL would be: - `http://example-node-1/authors/178aba49-ca39-4741-b227-f40d072b1222/followers/http%3A%2F%2Fexample-node-2%2Fauthors%2F5f57808f-0bc9-4b3d-bdd1-bb07c976d12d` - GET [local, remote] check if FOREIGN_AUTHOR_ID is a follower of AUTHOR_ID - Should return 404 if they're not - Should return similar format to Follow Request below if they are. - Example: GET ://service/authors/{AUTHOR_ID}/followers ```json { "type": "followers", "items":[ { "type":"author", "id":"http://127.0.0.1:5454/api/authors/1d698d25ff008f7538453c120f581471", "url":"http://127.0.0.1:5454/authors/1d698d25ff008f7538453c120f581471", "host":"http://127.0.0.1:5454/", "displayName":"Greg Johnson", "github": "http://github.com/gjohnson", "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" }, { "type":"author", "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "host":"http://127.0.0.1:5454/", "displayName":"Lara Croft", "url":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "github": "http://github.com/laracroft", "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" } ] } ``` ### Friend/Follow Request - When author 1 tries to follow author 2, author 1's server send the follow request to author 2's server. - If the author 2 accepts the Follow Request then author 1 is following author 2. - If author 2 is also already following author 1, then they are now friends. - Sent to inbox of "object" - Example format: ```json { "type": "Follow", "summary":"Greg wants to follow Lara", "actor":{ "type":"author", "id":"http://127.0.0.1:5454/authors/1d698d25ff008f7538453c120f581471", "url":"http://127.0.0.1:5454/authors/1d698d25ff008f7538453c120f581471", "host":"http://127.0.0.1:5454/", "displayName":"Greg Johnson", "github": "http://github.com/gjohnson", "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" }, "object":{ "type":"author", // ID of the Author "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", // the home host of the author "host":"http://127.0.0.1:5454/", // the display name of the author "displayName":"Lara Croft", // url to the authors profile "url":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", // HATEOS url for Github API "github": "http://github.com/laracroft", // Image from a public domain "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" } } ``` - When a author rejects/accepts a friend request, it should send back a `FollowResponse` type inbox message that alerts the original node that their friend request was either accepted or denied. - Example format: ```json { "type": "FollowResponse", "summary":"Greg rejected your friend request.", "actor":{ "type":"author", "id":"http://127.0.0.1:5454/authors/1d698d25ff008f7538453c120f581471", "url":"http://127.0.0.1:5454/authors/1d698d25ff008f7538453c120f581471", "host":"http://127.0.0.1:5454/", "displayName":"Greg Johnson", "github": "http://github.com/gjohnson", "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" }, "object":{ "type":"author", "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "host":"http://127.0.0.1:5454/", "displayName":"Lara Croft", "url":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "github": "http://github.com/laracroft", "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" }, // Was the friend request rejected or accepted? "accepted": false } ``` - When a author unfollows someone they are following, it should send a `Unfollow` type inbox message to the unfollowed author's inbox. - Example format: ```json { "type": "Unfollow", "summary": "Greg no longer is following you", "actor": { "type":"author", "id":"http://127.0.0.1:5454/authors/1d698d25ff008f7538453c120f581471", "url":"http://127.0.0.1:5454/authors/1d698d25ff008f7538453c120f581471", "host":"http://127.0.0.1:5454/", "displayName":"Greg Johnson", "github": "http://github.com/gjohnson", "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" }, "object":{ "type":"author", // ID of the Author "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", // the home host of the author "host":"http://127.0.0.1:5454/", // the display name of the author "displayName":"Lara Croft", // url to the authors profile "url":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", // HATEOS url for Github API "github": "http://github.com/laracroft", // Image from a public domain "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" } } ``` ### Post - URL/api/authors/{AUTHOR_ID}/posts/{POST_ID} - GET [local, remote] get the public post whose id is POST_ID - friends-only posts: must be authenticated - Creation URL/api/authors/{AUTHOR_ID}/posts/ - GET [local, remote] get the recent posts from author AUTHOR_ID (paginated) - Not authenticated: only public posts. - Authenticated locally as author: all posts. - Authenticated locally as friend of author: public + friends-only posts. - Authenticated as remote server: This probably should not happen. Remember, the way remote server becomes aware of local posts is by local server pushing those posts to inbox, not by remote server pulling. - Be aware that Posts can be images that need base64 decoding. - posts can also hyperlink to images that are public - Example format: ```json { "type":"post", // title of a post "title":"A post title about a post about web dev", // id of the post "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e/posts/764efa883dda1e11db47671c4a3bbd9e" // where did you get this post from? "source":"<http://domain_y>/api/authors/<author_id_y>/posts/<post_id_y>", // where is it actually from "origin":"<http://domain_z>/api/authors/<author_id_z>/posts/<post_id_z>", // a brief description of the post "description":"This post discusses stuff -- brief", // The content type of the post // assume either // text/markdown -- common mark // text/plain -- UTF-8 // application/base64 // image/png;base64 # this is an embedded png -- images are POSTS. So you might have a user make 2 posts if a post includes an image! // image/jpeg;base64 # this is an embedded jpeg // for HTML you will want to strip tags before displaying "contentType":"text/plain", "content":"Þā wæs on burgum Bēowulf Scyldinga, lēof lēod-cyning, longe þrāge folcum gefrǣge (fæder ellor hwearf, aldor of earde), oð þæt him eft onwōc hēah Healfdene; hēold þenden lifde, gamol and gūð-rēow, glæde Scyldingas. Þǣm fēower bearn forð-gerīmed in worold wōcun, weoroda rǣswan, Heorogār and Hrōðgār and Hālga til; hȳrde ic, þat Elan cwēn Ongenþēowes wæs Heaðoscilfinges heals-gebedde. Þā wæs Hrōðgāre here-spēd gyfen, wīges weorð-mynd, þæt him his wine-māgas georne hȳrdon, oð þæt sēo geogoð gewēox, mago-driht micel. Him on mōd bearn, þæt heal-reced hātan wolde, medo-ærn micel men gewyrcean, þone yldo bearn ǣfre gefrūnon, and þǣr on innan eall gedǣlan geongum and ealdum, swylc him god sealde, būton folc-scare and feorum gumena. Þā ic wīde gefrægn weorc gebannan manigre mǣgðe geond þisne middan-geard, folc-stede frætwan. Him on fyrste gelomp ǣdre mid yldum, þæt hit wearð eal gearo, heal-ærna mǣst; scōp him Heort naman, sē þe his wordes geweald wīde hæfde. Hē bēot ne ālēh, bēagas dǣlde, sinc æt symle. Sele hlīfade hēah and horn-gēap: heaðo-wylma bād, lāðan līges; ne wæs hit lenge þā gēn þæt se ecg-hete āðum-swerian 85 æfter wæl-nīðe wæcnan scolde. Þā se ellen-gǣst earfoðlīce þrāge geþolode, sē þe in þȳstrum bād, þæt hē dōgora gehwām drēam gehȳrde hlūdne in healle; þǣr wæs hearpan swēg, swutol sang scopes. Sægde sē þe cūðe frum-sceaft fīra feorran reccan", // the author has an ID where by authors can be disambiguated "author":{ "type":"author", // ID of the Author "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", // the home host of the author "host":"http://127.0.0.1:5454/", // the display name of the author "displayName":"Lara Croft", // url to the authors profile "url":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", // HATEOS url for Github API "github": "http://github.com/laracroft", // Image from a public domain (optional, can be missing) "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" }, // comments about the post // return a maximum number of comments // total number of comments for this post "count": 1023, // the first page of comments "comments":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e/posts/de305d54-75b4-431b-adb2-eb6b9e546013/comments" // commentsSrc is OPTIONAL and can be missing // You should return ~ 5 comments per post. // should be sorted newest(first) to oldest(last) // this is to reduce API call counts "commentsSrc":{ "type":"comments", "page":1, "size":5, "post":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e/posts/de305d54-75b4-431b-adb2-eb6b9e546013" "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e/posts/de305d54-75b4-431b-adb2-eb6b9e546013/comments" "comments":[ { "type":"comment", "author":{ "type":"author", // ID of the Author (UUID) "id":"http://127.0.0.1:5454/authors/1d698d25ff008f7538453c120f581471", // url to the authors information "url":"http://127.0.0.1:5454/authors/1d698d25ff008f7538453c120f581471", "host":"http://127.0.0.1:5454/", "displayName":"Greg Johnson", // HATEOS url for Github API "github": "http://github.com/gjohnson", // Image from a public domain "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" }, "comment":"Sick Olde English", "contentType":"text/markdown", // ISO 8601 TIMESTAMP "published":"2015-03-09T13:07:04+00:00", // ID of the Comment (UUID) "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e/posts/de305d54-75b4-431b-adb2-eb6b9e546013/comments/f6255bb01c648fe967714d52a89e8e9c", } ] } // ISO 8601 TIMESTAMP "published":"2015-03-09T13:07:04+00:00", // visibility ["PUBLIC","FRIENDS","UNLISTED"] "visibility":"PUBLIC" // for visibility PUBLIC means it is open to the wild web // FRIENDS means if we're friends I can see the post // FRIENDS should've already been sent the post so they don't need this } ``` ### Image Posts Image Posts are just posts that are images. But they are encoded as base64 data. You can inline an image post using a data url or you can use this shortcut to get the image if authenticated to see it. - URL/api/authors/{AUTHOR_ID}/posts/{POST_ID}/image - GET [local, remote] get the public post converted to binary as an iamge - return 404 if not an image - This end point decodes image posts as images. This allows the use of image tags in markdown. - You can use this to proxy or cache images. ### Comments - URL/api/authors/{AUTHOR_ID}/posts/{POST_ID}/comments - GET [local, remote] get the list of comments of the post whose id is POST_ID (paginated) - return 404 if not an image - example comments from a post: ```json { "type":"comments", "page":1, "size":5, "post":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e/posts/de305d54-75b4-431b-adb2-eb6b9e546013" "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e/posts/de305d54-75b4-431b-adb2-eb6b9e546013/comments" "comments":[ { "type":"comment", "author":{ "type":"author", // ID of the Author (UUID) "id":"http://127.0.0.1:5454/authors/1d698d25ff008f7538453c120f581471", // url to the authors information "url":"http://127.0.0.1:5454/authors/1d698d25ff008f7538453c120f581471", "host":"http://127.0.0.1:5454/", "displayName":"Greg Johnson", // HATEOS url for Github API "github": "http://github.com/gjohnson", // Image from a public domain "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" }, "comment":"Sick Olde English", "contentType":"text/markdown", // ISO 8601 TIMESTAMP "published":"2015-03-09T13:07:04+00:00", // ID of the Comment (UUID) "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e/posts/de305d54-75b4-431b-adb2-eb6b9e546013/comments/f6255bb01c648fe967714d52a89e8e9c", } ] } ``` ### Likes - You can like posts and comments - Send them to the inbox of the author of the post or comment - URL/api/authors/{AUTHOR_ID}/inbox - POST [local, remote]: send a like object to AUTHOR_ID. - Example like object: ```json { "summary": "Lara Croft Likes your post", "type": "Like", "author":{ "type":"author", "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "host":"http://127.0.0.1:5454/", "displayName":"Lara Croft", "url":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "github":"http://github.com/laracroft", "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" }, "object":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e/posts/764efa883dda1e11db47671c4a3bbd9e" } ``` ### Liked - URL/api/authors/{AUTHOR_ID}/liked - GET [local, remote] list what public things AUTHOR_ID liked. - It's a list of of likes originating from this author - Note: be careful here private information could be disclosed. - URL/api/authors/{AUTHOR_ID}/posts/{POST_ID}/likes - GET [local, remote] a list of likes from other authors on AUTHOR_ID's post POST_ID. <!-- - URL/api/authors/{AUTHOR_ID}/posts/{POST_ID}/comments/{COMMENT_ID}/likes - GET [local, remote] a list of likes from other authors on AUTHOR_ID's post POST_ID comment COMMENT_ID --> - Example liked object: ```json { "type":"liked", "items":[ { "summary": "Lara Croft Likes your post", "type": "Like", "author":{ "type":"author", "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "host":"http://127.0.0.1:5454/", "displayName":"Lara Croft", "url":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "github":"http://github.com/laracroft", "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" }, "object":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e/posts/764efa883dda1e11db47671c4a3bbd9e" } ] } ``` ### Inbox - The inbox is all the new posts from who you follow, as well as follow requests, likes, and comments you should be aware of - The inbox is the API equivalent of the stream in the UI - URL/api/authors/{AUTHOR_ID}/inbox - POST [local, remote]: send a post to the author - if the type is "post" then add that post to AUTHOR_ID's inbox - if the type is "follow" then add that follow is added to AUTHOR_ID's inbox to approve later - if the type is "Like" then add that like to AUTHOR_ID's inbox - if the type is "comment" then add that comment to AUTHOR_ID's inbox - Example, retrieving an inbox: ```json { "type":"inbox", "author":"http://127.0.0.1:5454/authors/c1e3db8ccea4541a0f3d7e5c75feb3fb", "items":[ { "type":"post", "title":"A Friendly post title about a post about web dev", "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e/posts/764efa883dda1e11db47671c4a3bbd9e" "source":"http://lastplaceigotthisfrom.com/authors/xxxxxx/posts/yyyyy", "origin":"http://whereitcamefrom.com/authors/yyyyyy/posts/zzzzz", "description":"This post discusses stuff -- brief", "contentType":"text/plain", "content":"Þā wæs on burgum Bēowulf Scyldinga, lēof lēod-cyning, longe þrāge folcum gefrǣge (fæder ellor hwearf, aldor of earde), oð þæt him eft onwōc hēah Healfdene; hēold þenden lifde, gamol and gūð-rēow, glæde Scyldingas. Þǣm fēower bearn forð-gerīmed in worold wōcun, weoroda rǣswan, Heorogār and Hrōðgār and Hālga til; hȳrde ic, þat Elan cwēn Ongenþēowes wæs Heaðoscilfinges heals-gebedde. Þā wæs Hrōðgāre here-spēd gyfen, wīges weorð-mynd, þæt him his wine-māgas georne hȳrdon, oð þæt sēo geogoð gewēox, mago-driht micel. Him on mōd bearn, þæt heal-reced hātan wolde, medo-ærn micel men gewyrcean, þone yldo bearn ǣfre gefrūnon, and þǣr on innan eall gedǣlan geongum and ealdum, swylc him god sealde, būton folc-scare and feorum gumena. Þā ic wīde gefrægn weorc gebannan manigre mǣgðe geond þisne middan-geard, folc-stede frætwan. Him on fyrste gelomp ǣdre mid yldum, þæt hit wearð eal gearo, heal-ærna mǣst; scōp him Heort naman, sē þe his wordes geweald wīde hæfde. Hē bēot ne ālēh, bēagas dǣlde, sinc æt symle. Sele hlīfade hēah and horn-gēap: heaðo-wylma bād, lāðan līges; ne wæs hit lenge þā gēn þæt se ecg-hete āðum-swerian 85 æfter wæl-nīðe wæcnan scolde. Þā se ellen-gǣst earfoðlīce þrāge geþolode, sē þe in þȳstrum bād, þæt hē dōgora gehwām drēam gehȳrde hlūdne in healle; þǣr wæs hearpan swēg, swutol sang scopes. Sægde sē þe cūðe frum-sceaft fīra feorran reccan", "author":{ "type":"author", "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "host":"http://127.0.0.1:5454/", "displayName":"Lara Croft", "url":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "github": "http://github.com/laracroft", "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" }, "comments":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e/posts/de305d54-75b4-431b-adb2-eb6b9e546013/comments" "published":"2015-03-09T13:07:04+00:00", "visibility":"FRIENDS" }, { "type":"post", "title":"DID YOU READ MY POST YET?", "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e/posts/999999983dda1e11db47671c4a3bbd9e", "source":"http://lastplaceigotthisfrom.com/authors/xxxxxx/posts/yyyyy", "origin":"http://whereitcamefrom.com/authors/wwwwww/posts/zzzzz", "description":"Whatever", "contentType":"text/plain", "content":"Are you even reading my posts Arjun?", "author":{ "type":"author", "id":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "host":"http://127.0.0.1:5454/", "displayName":"Lara Croft", "url":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e", "github": "http://github.com/laracroft", "profileImage": "https://i.imgur.com/k7XVwpB.jpeg" }, "comments":"http://127.0.0.1:5454/authors/9de17f29c12e8f97bcbbd34cc908f1baba40658e/posts/de305d54-75b4-431b-adb2-eb6b9e546013/comments" "published":"2015-03-09T13:07:04+00:00", "visibility":"FRIENDS" } ] } ```

    Import from clipboard

    Paste your markdown or webpage here...

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lose their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template has been removed or transferred.
    Upgrade
    All
    • All
    • Team
    No template.

    Create a template

    Upgrade

    Delete template

    Do you really want to delete this template?
    Turn this template into a regular note and keep its content, versions, and comments.

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password

    or

    By clicking below, you agree to our terms of service.

    Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox Sign in with Wallet
    Wallet ( )
    Connect another wallet

    New to HackMD? Sign up

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Help & Tutorial

    How to use Book mode

    Slide Example

    API Docs

    Edit in VSCode

    Install browser extension

    Contacts

    Feedback

    Discord

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # Header Header 基本排版
    - Unordered List
    • Unordered List
    1. Ordered List
    1. Ordered List
    - [ ] Todo List
    • Todo List
    > Blockquote
    Blockquote
    **Bold font** Bold font
    *Italics font* Italics font
    ~~Strikethrough~~ Strikethrough
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions and GitHub Sync
    Get Full History Access

    • Edit version name
    • Delete

    revision author avatar     named on  

    More Less

    Note content is identical to the latest version.
    Compare
      Choose a version
      No search result
      Version not found
    Sign in to link this note to GitHub
    Learn more
    This note is not linked with GitHub
     

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub
        • Please sign in to GitHub and install the HackMD app on your GitHub repo.
        • HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.
        Learn more  Sign in to GitHub

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions
        Include title and tags
        Available push count

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully