diff --git a/docs/_entities/comment.md b/docs/_entities/comment.md index 7b8851a..27e8891 100644 --- a/docs/_entities/comment.md +++ b/docs/_entities/comment.md @@ -2,7 +2,8 @@ title: Comment --- -This entity represents a comment to some kind of [Post][post] ([StatusMessage][status_message] or [Reshare][reshare]). +This entity represents a comment to some kind of [Post][post] ([StatusMessage][status_message] +or currently still a [Reshare][reshare]). See also: [Relayable][relayable] diff --git a/docs/_entities/like.md b/docs/_entities/like.md index fcc635d..5772267 100644 --- a/docs/_entities/like.md +++ b/docs/_entities/like.md @@ -6,7 +6,7 @@ This entity represents a like to some kind of post (e.g. status message). The `parent_type` can be one of: -* [Post][post] ([StatusMessage][status_message] or [Reshare][reshare]) +* [Post][post] ([StatusMessage][status_message] or currently still a [Reshare][reshare]) * [Comment][comment] (diaspora\* doesn't support this at the moment) See also: [Relayable][relayable] diff --git a/docs/_entities/post.md b/docs/_entities/post.md index 961b751..1c113ea 100644 --- a/docs/_entities/post.md +++ b/docs/_entities/post.md @@ -2,7 +2,14 @@ title: Post --- -This is the abstract parent type of [StatusMessage][status_message] and [Reshare][reshare]. +This is the abstract parent type of [StatusMessage][status_message] and currently still [Reshare][reshare]. + +{% include warning_box.html + title="Future of reshares" + content="
Reshare will not inherit from Post in the future anymore! More information about this + can be found here or + in this issue.
" +%} ## Common Properties diff --git a/docs/_entities/reshare.md b/docs/_entities/reshare.md index dc08931..e6f15df 100644 --- a/docs/_entities/reshare.md +++ b/docs/_entities/reshare.md @@ -2,15 +2,25 @@ title: Reshare --- -This entity represents a reshare of a [StatusMessage][status_message]. It inherits from [Post][post]. +This entity represents a reshare of a [StatusMessage][status_message]. + +{% include warning_box.html + title="Future of reshares" + content="Current versions of diaspora* handle reshares like they inherit from + Post and allow interactions (Comments and + Likes) on the reshare. In the future, the reshare entity will only be used to increase the spread of a + Post, more information about this can be found in + this issue.
+There currently exists a special case for reshares with a deleted root post. It is valid when the
+ reshare doesn't include root_author and root_guid. If only one of
+ root_author and root_guid is present, the entity is not valid. Once
+ reshares are only used to increase the reach of a post, reshares without root_author and
+ root_guid will no longer be valid and reshares will be deleted if the original post is deleted.