-
Notifications
You must be signed in to change notification settings - Fork 14
feat(60/STATUS-URL-SCHEME): initial draft #602
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,70 @@ | ||||||
--- | ||||||
slug: 60 | ||||||
title: 60/STATUS-URL-SCHEME | ||||||
name: Status URL Scheme | ||||||
status: draft | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
category: Standards Track | ||||||
tags: waku-application | ||||||
editor: Felicio Mununga <felicio@status.im> | ||||||
contributors: | ||||||
--- | ||||||
|
||||||
# Abstract | ||||||
|
||||||
This document describes URL scheme for previewing and deep linking content as well as for triggering actions. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Assuming this RFC is planned to grow into a normative specification. |
||||||
|
||||||
# Background / Rationale / Motivation | ||||||
|
||||||
## Requirements | ||||||
|
||||||
### Related scope | ||||||
|
||||||
#### Features | ||||||
|
||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These features would need more context. E.g. what is an onboarding website, etc. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||||||
- Onboarding website | ||||||
- Link preview | ||||||
- Link sharing | ||||||
- Deep linking | ||||||
- Routing and navigation | ||||||
- Payment requests | ||||||
- Chat creation | ||||||
|
||||||
# Wire Format Specification / Syntax | ||||||
|
||||||
## Schemes | ||||||
|
||||||
- Internal `status-app://` | ||||||
- External `https://` (i.e. univers/deep links) | ||||||
|
||||||
## Paths | ||||||
|
||||||
| Name | Url | Description | | ||||||
| ----- | ---- | ---- | | ||||||
| User profile | `/u/<encoded_data>#<user_chat_key>` | Preview/Open user profile | | ||||||
| | `/u#<user_chat_key>` | | | ||||||
| | `/u#<ens_name>` | | | ||||||
| Community | `/c/<encoded_data>#<community_chat_key>` | Preview/Open community | | ||||||
| | `/c#<community_chat_key>` | | | ||||||
| Community channel | `/cc/<encoded_data>#<community_chat_key >`| Preview/Open community channel | | ||||||
| | `/cc/<channel_uuid>#<community_chat_key>` | | | ||||||
|
||||||
<!-- # Security/Privacy Considerations | ||||||
|
||||||
A standard track RFC in `stable` status MUST feature this section. | ||||||
A standard track RFC in `raw` or `draft` status SHOULD feature this section. | ||||||
Informational RFCs (in any state) may feature this section. | ||||||
If there are none, this section MUST explicitly state that fact. | ||||||
This section MAY contain additional relevant information, e.g. an explanation as to why there are no security consideration for the respective document. --> | ||||||
|
||||||
# Discussions | ||||||
|
||||||
- See <https://github.com/status-im/specs/pull/159> | ||||||
- See <https://github.com/status-im/status-web/issues/327> | ||||||
|
||||||
# Copyright | ||||||
|
||||||
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/). | ||||||
|
||||||
# References | ||||||
|
||||||
- [59/STATUS-URL-DATA](/spec/59/) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See #600 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This reference should be used somewhere in the text. I assume /59 specifies the encoding which is used to encode the URL scheme specified in this doc? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Right. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@fryorcraken and what do you suggest?
a. Use https:// deep links instead of status-im:// - Windows status-im/status-desktop#9549
b. Use https:// deep links instead of status-im:// - MacOS status-im/status-desktop#7957
c. Make deep links work for Linux status-im/status-desktop#8027
This should grow with more paths being supported post MVP, and personally I wouldn't mind keeping it separate, simple and serve more as an overview with references.