From 4f48f4345513b3a6ca78e669af1483f552b46637 Mon Sep 17 00:00:00 2001 From: Benjamin Neff Date: Tue, 12 Sep 2017 23:33:56 +0200 Subject: [PATCH] Add author parameter for diaspora:// URLs to the documentation --- docs/federation/diaspora_scheme.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/federation/diaspora_scheme.md b/docs/federation/diaspora_scheme.md index 86a945c..80ee32e 100644 --- a/docs/federation/diaspora_scheme.md +++ b/docs/federation/diaspora_scheme.md @@ -13,20 +13,25 @@ it as software specific URL. The format is similar to the route used for [fetching][fetching], so if the receiving server doesn't know the linked entity yet, it can just be fetched. +When the entity with that `guid` is already available locally, the recipient +should validate that it's from `author` before linking to it. + ### Format -`diaspora://:type/:guid` +`diaspora://:author/:type/:guid` #### Parameters -| Name | Description | -| ------ | ---------------------------------------------- | -| `type` | The type of the linked entity in `snake_case`. | -| `guid` | The [GUID][guid] of the linked entity. | +| Name | Description | +| -------- | -------------------------------------------------------------------- | +| `author` | The [diaspora\* ID][diaspora-id] of the author of the linked entity. | +| `type` | The type of the linked entity in `snake_case`. | +| `guid` | The [GUID][guid] of the linked entity. | #### Example -`diaspora://post/17faf230675101350d995254001bd39e` +`diaspora://alice@example.org/post/17faf230675101350d995254001bd39e` [fetching]: {{ site.baseurl }}/federation/fetching.html +[diaspora-id]: {{ site.baseurl }}/federation/types.html#diaspora-id [guid]: {{ site.baseurl }}/federation/types.html#guid