nocebo/diaspora_federation
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add author parameter for diaspora:// URLs to the documentation

Browse source
This commit is contained in:
Benjamin Neff 2017-09-12 23:33:56 +02:00
parent b6ec405e55
commit 67a2ba7449
No known key found for this signature in database
GPG key ID: 971464C3F1A90194
1 changed files with 11 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/federation/diaspora_scheme.md
View file

@ -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