polyphony/polyproto-dot-org
polyphony/polyproto-dot-org
7
15
Fork 10
Code Issues 21 Pull requests 6 Projects Activity Actions

PURR-2026-0006: Namespacing guidelines #162

Merged
ava merged 2 commits from cyrneko/namespace-naming-guidelines into main 2026-04-13 15:17:46 +02:00
Conversation 5 Commits 2 Files changed 1 +14 -5
cyrneko commented 2026-04-07 21:19:21 +02:00
Owner
Copy link

This is basically #138 but without aGit, as aGit doesn't allow me to push follow-up patches it seems

This PURR introduces proper guidelines about how to format URLs, as well as how implementations should behave when encountering URLs without an explicit scheme (i.e https://).

This is basically #138 but without aGit, as aGit doesn't allow me to push follow-up patches it seems --- This PURR introduces proper guidelines about how to format URLs, as well as how implementations should behave when encountering URLs without an explicit scheme (i.e `https://`).
Expand on namespaces syntax
Some checks failed
Lint, Build, Smoketest Run / Lint (pull_request) Failing after 1m28s
Details
Lint, Build, Smoketest Run / Build and Run (pull_request) Successful in 1m43s
Details
Lint, Build, Smoketest Run / Deploy (pull_request) Has been skipped
Details
9a9c15b5bb 
Aims to fix #51
feat: URL-based namespacing
All checks were successful
Lint, Build, Smoketest Run / Lint (pull_request) Successful in 1m20s
Details
Lint, Build, Smoketest Run / Build and Run (pull_request) Successful in 1m48s
Details
Lint, Build, Smoketest Run / Deploy (pull_request) Has been skipped
Details
42551ba713 
Namespaces are now defined as a URL, like this:
polyproto.org/chat
or like this:
https://polyproto.org/chat

the https:// is supposed to be implied, unless explicitly set to
http://, and the namespace should never be parsed without the prefix.

do note that pre-commit hooks did a bunch of changes here that I cannot
100% verify are intentional :woozy:
cyrneko force-pushed cyrneko/namespace-naming-guidelines from 42551ba713
All checks were successful
Lint, Build, Smoketest Run / Lint (pull_request) Successful in 1m20s
Details
Lint, Build, Smoketest Run / Build and Run (pull_request) Successful in 1m48s
Details
Lint, Build, Smoketest Run / Deploy (pull_request) Has been skipped
Details
to 7fa7fec7af
Some checks failed
Flake check, build, deploy / nix flake check (pull_request) Failing after 2m28s
Details
Flake check, build, deploy / Build the project (pull_request) Successful in 3m23s
Details
Flake check, build, deploy / Deploy page (pull_request) Has been skipped
Details
2026-04-07 21:29:12 +02:00 Compare
ava commented 2026-04-08 14:14:52 +02:00
Owner
Copy link

For clarificatin, in case that was maybe accidentally misread: I meant URIs, not (just) URLs, because a URI can also be URL, but it could also be an OID, which I'd really like to have the option of using :)

For clarificatin, in case that was maybe accidentally misread: I meant [`URIs`](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier), not (just) `URLs`, because a URI can also be URL, but it could also be an OID, which I'd really like to have the option of using :)
cyrneko commented 2026-04-08 14:27:32 +02:00
Author
Owner
Copy link

ah, I assumed a URL would have been fine as I had assumed OIDs could be referred to by URL

alright, I'll fix that up :)

ah, I assumed a URL would have been fine as I had assumed OIDs could be referred to by URL alright, I'll fix that up :)
URIs instead of URLs
Some checks failed
Flake check, build, deploy / nix flake check (pull_request) Failing after 1m58s
Details
Flake check, build, deploy / Build the project (pull_request) Successful in 2m55s
Details
Flake check, build, deploy / Deploy page (pull_request) Has been skipped
Details
6d4e5f7c69 
- Clarifies that *any* URI can be used, not just URLs
- Clarifies that if no scheme is given, HTTPs is to be assumed
- Polyproto → polyproto

<small>Yet again, pre-commit forced me to commit a bunch of stuff I
don't care about for this commit</small>
ava reviewed 2026-04-08 15:52:50 +02:00
docs/protocols/core.md Outdated
@ -2617,6 +2617,18 @@ taken by an officially endorsed extension, a different namespace must be chosen.
collision exists between an officially endorsed extension and a regular P2 extension, the officially
endorsed extension has priority.
Namespaces are constructed as URIs, such as HTTP(s) URLs or OID references. When no scheme is
ava commented 2026-04-08 15:52:49 +02:00
Owner
Copy link

Maybe we could also leave the whole "defining what it looks like" out of the spec, and just refer to https://www.rfc-editor.org/rfc/rfc3986 instead??

Maybe we could also leave the whole "defining what it looks like" out of the spec, and just refer to <https://www.rfc-editor.org/rfc/rfc3986> instead??
cyrneko commented 2026-04-08 16:23:26 +02:00
Author
Owner
Copy link

Well I'm not redefining how to parse a URI here, just:

  • we use URIs for namespaces
  • give an example of URIs
  • clarify that if no scheme is given HTTPs is to be assumed
Well I'm not redefining how to parse a URI here, just: - we use URIs for namespaces - give an example of URIs - clarify that if no scheme is given HTTPs is to be assumed
cyrneko commented 2026-04-08 16:23:46 +02:00
Author
Owner
Copy link

I guess perhaps I should make the URIs a link back to that RFC?

I guess perhaps I should make the `URIs` a link back to that RFC?
ava commented 2026-04-08 18:31:52 +02:00
Owner
Copy link

That would be fine, yeah. Alright, if that's the intention, then it's good this way :)

That would be fine, yeah. Alright, if that's the intention, then it's good this way :)
cyrneko marked this conversation as resolved
ava requested changes 2026-04-09 13:13:41 +02:00
Dismissed
ava left a comment
Copy link

I re-read the PR and I like how you worded things :) However, I think the rest of the text in that same section is now perhaps a little outdated, and should be looked at again before this can be merged. One example: I think the 2-64 character limit is no longer applicable.

I re-read the PR and I like how you worded things :) However, I think the rest of the text in that same section is now perhaps a little outdated, and should be looked at again before this can be merged. One example: I think the 2-64 character limit is no longer applicable.
remove old namespace guidelines, clarify URI RFC that is referred to
Some checks failed
Flake check, build, deploy / nix flake check (pull_request) Failing after 1m56s
Details
Flake check, build, deploy / Build the project (pull_request) Successful in 3m0s
Details
Flake check, build, deploy / Deploy page (pull_request) Has been skipped
Details
e9446e3aa6
cyrneko commented 2026-04-12 02:47:47 +02:00
Author
Owner
Copy link

alright, made the requested changes! Been hanging a bit behind lately, lotsa stuff happening outside of Polyproto and my main PC isn't usable rn, but I'll try to catch up.

alright, made the requested changes! Been hanging a bit behind lately, lotsa stuff happening outside of Polyproto and my main PC isn't usable rn, but I'll try to catch up.
❤️ 1
ava approved these changes 2026-04-13 14:32:38 +02:00
ava left a comment
Copy link

I like this! Thank you very much :)

I like this! Thank you very much :)
❤️ 1
ava changed title from WIP: PURR-2026-0006: Namespacing guidelines to PURR-2026-0006: Namespacing guidelines 2026-04-13 14:33:20 +02:00
ava force-pushed cyrneko/namespace-naming-guidelines from e9446e3aa6
Some checks failed
Flake check, build, deploy / nix flake check (pull_request) Failing after 1m56s
Details
Flake check, build, deploy / Build the project (pull_request) Successful in 3m0s
Details
Flake check, build, deploy / Deploy page (pull_request) Has been skipped
Details
to 8fde52825a
Some checks failed
Flake check, build, deploy / nix flake check (pull_request) Failing after 2m27s
Details
Flake check, build, deploy / Build the project (pull_request) Successful in 3m18s
Details
Flake check, build, deploy / Deploy page (pull_request) Has been skipped
Details
2026-04-13 14:37:14 +02:00 Compare
ava force-pushed cyrneko/namespace-naming-guidelines from 8fde52825a
Some checks failed
Flake check, build, deploy / nix flake check (pull_request) Failing after 2m27s
Details
Flake check, build, deploy / Build the project (pull_request) Successful in 3m18s
Details
Flake check, build, deploy / Deploy page (pull_request) Has been skipped
Details
to 49085bf97f
Some checks failed
Flake check, build, deploy / nix flake check (pull_request) Successful in 2m11s
Details
Flake check, build, deploy / Build the project (pull_request) Has been cancelled
Details
Flake check, build, deploy / Deploy page (pull_request) Has been cancelled
Details
2026-04-13 14:45:49 +02:00 Compare
ava force-pushed cyrneko/namespace-naming-guidelines from 49085bf97f
Some checks failed
Flake check, build, deploy / nix flake check (pull_request) Successful in 2m11s
Details
Flake check, build, deploy / Build the project (pull_request) Has been cancelled
Details
Flake check, build, deploy / Deploy page (pull_request) Has been cancelled
Details
to 0e6d7842b5
Some checks failed
Flake check, build, deploy / nix flake check (pull_request) Has been cancelled
Details
Flake check, build, deploy / Build the project (pull_request) Has been cancelled
Details
Flake check, build, deploy / Deploy page (pull_request) Has been cancelled
Details
2026-04-13 14:48:43 +02:00 Compare
ava force-pushed cyrneko/namespace-naming-guidelines from 0e6d7842b5
Some checks failed
Flake check, build, deploy / nix flake check (pull_request) Has been cancelled
Details
Flake check, build, deploy / Build the project (pull_request) Has been cancelled
Details
Flake check, build, deploy / Deploy page (pull_request) Has been cancelled
Details
to fea433deff
All checks were successful
Flake check, build, deploy / nix flake check (pull_request) Successful in 1m50s
Details
Flake check, build, deploy / Build the project (pull_request) Successful in 3m22s
Details
Flake check, build, deploy / Deploy page (pull_request) Successful in 4s
Details
2026-04-13 14:49:41 +02:00 Compare
ava merged commit cc1f03db17 into main 2026-04-13 15:17:46 +02:00
ava deleted branch cyrneko/namespace-naming-guidelines 2026-04-13 15:17:48 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
ava
Labels
Clear labels   
🗒️ PURR
Stage A: Idea
 PURR is still in a very early stage. It's a defined idea with a clear goal, requiring discussion and further input, but there is barely any written spec, if any.

  
🗒️ PURR
Stage B: Drafting
 Specification text for this PURR is being written, distilling the discussion into specification text. Discussion and input is still very much happening, and the core idea could still change at any sec

  
🗒️ PURR
Stage C: Finalization
 The spec is written. Focus shifts from ideation to refining wording and catching edge cases.

  
dependencies
Pull requests that update a dependency file

Archived

  
Difficulty: Complex

Archived

  
Difficulty: Easy

Archived

  
Difficulty: Medium

Archived

  
Difficulty: Trivial

Archived

  
Difficulty: what

Archived

  
Priority: Critical

Archived

  
Priority: High

Archived

  
Priority: Low

Archived

  
Priority: Medium

Archived

  
Status: Abandoned

Archived

  
Status: Accepted

Archived

  
Status: Available

Archived

  
Status: Blocked

Archived

  
Status: Completed

Archived

  
Status: In Progress

Archived

  
Status: On Hold

Archived

  
Status: Pending

Archived

  
Status: Review Needed

Archived

  
Status: Revision Needed

Archived

  
Target/polyproto-auth
Issues concerning the polyproto-auth specification

  
Target/polyproto-chat
Issues concerning the polyproto-chat specification

  
Target/polyproto-core
Issues concerning the polyproto-core specification

  
Target/polyproto-mls
Issues concerning the polyproto-mls specification

  
Target
website
 Does not affect any protocol specification; issues, which target the website itself

  
Type: Bug

Archived

  
Type: Enhancement

Archived

  
Type: Maintenance

Archived

  
Type: Question

Archived

  
Type
PURR
 A PURR is a polyproto Update & Revision Request, i.e. a change proposal for p2 specs.

Archived

  
⚠️Priority
A (Highest)
 Highest priority issue

  
⚠️Priority
C (High)
 High priority issue

  
⚠️Priority
D (Medium-High)
 Medium to high priority issue

  
⚠️Priority
E (Medium)
 Medium priority issue

  
⚠️Priority
G (Low)
 Low priority issue

  
⚠️Priority
H (Lowest)
 Lowest priority issue

  
🏷️Kind
Bug
 Something is not working as expected

  
🏷️Kind
Chore
 Regular maintainance tasks, version bumps, lint fixes

  
🏷️Kind
Documentation
 Documentation changes

  
🏷️Kind
Epic
 This issue is a collection of other, related issues.

  
🏷️Kind
Feature
 New functionality

  
🏷️Kind
Improvement
 Improve existing functionality

  
🏷️Kind
Testing and CI
 Change related to CI or testing

  
👁️Reviewed
Duplicate
 This issue or pull request already exists

  
👁️Reviewed
Invalid
 Invalid issue

  
👁️Reviewed
Won't Fix
 This issue won't be fixed

  
📋️Kind/Security
This is security issue

Archived

  
📋️Status
Abandoned
 Somebody has started to work on this but abandoned work

  
📋️Status
Blocked
 Something is blocking this issue or pull request

Archived

  
📋️Status
In Progress
 This label is intended to be used when an outside collaborator is pursuing the completion of this issue, since they cannot be directly assigned to the task.

  
📋️Status
Need More Info
 Feedback is required to reproduce issue or to continue work

  
🔧Difficulty
A (Very hard)
 Measure of time-to-implement and cognitive complexity of the task. "Hard" tasks usually take >15h to complete. Extremely unlikely to be suitable for first-time-contributors.

  
🔧Difficulty
B (Hard)
 Measure of time-to-implement and cognitive complexity of the task. "Hard" tasks usually take 3h-15h to complete. Very likely not suitable for first-time-contributors.

  
🔧Difficulty
C (Medium)
 Measure of time-to-implement and cognitive complexity of the task. "Medium" tasks usually take 30min-3h to complete. Likely not suitable for first-time-contributors.

  
🔧Difficulty
D (Easy)
 Measure of time-to-implement and cognitive complexity of the task. "Easy" tasks usually take 15-30min to complete. Likely suitable for first-time-contributors.

  
🔧Difficulty
E (Trivial)
 Measure of time-to-implement and cognitive complexity of the task. "Trivial" tasks usually take 1-15min to complete. Very likely suitable for first-time-contributors.

  
Compat/Breaking
Breaking change that won't be backward compatible

  
Good First Issue
This issue is a good task to take on if you are new to the project or the repository and looking to contribute.

No labels
🗒️ PURR
Stage A: Idea
🗒️ PURR
Stage B: Drafting
🗒️ PURR
Stage C: Finalization
dependencies
Difficulty: Complex
Difficulty: Easy
Difficulty: Medium
Difficulty: Trivial
Difficulty: what
Priority: Critical
Priority: High
Priority: Low
Priority: Medium
Status: Abandoned
Status: Accepted
Status: Available
Status: Blocked
Status: Completed
Status: In Progress
Status: On Hold
Status: Pending
Status: Review Needed
Status: Revision Needed
Target/polyproto-auth
Target/polyproto-chat
Target/polyproto-core
Target/polyproto-mls
Target
website
Type: Bug
Type: Enhancement
Type: Maintenance
Type: Question
Type
PURR
⚠️Priority
A (Highest)
⚠️Priority
C (High)
⚠️Priority
D (Medium-High)
⚠️Priority
E (Medium)
⚠️Priority
G (Low)
⚠️Priority
H (Lowest)
🏷️Kind
Bug
🏷️Kind
Chore
🏷️Kind
Documentation
🏷️Kind
Epic
🏷️Kind
Feature
🏷️Kind
Improvement
🏷️Kind
Testing and CI
👁️Reviewed
Duplicate
👁️Reviewed
Invalid
👁️Reviewed
Won't Fix
📋️Kind/Security
📋️Status
Abandoned
📋️Status
Blocked
📋️Status
In Progress
📋️Status
Need More Info
🔧Difficulty
A (Very hard)
🔧Difficulty
B (Hard)
🔧Difficulty
C (Medium)
🔧Difficulty
D (Easy)
🔧Difficulty
E (Trivial)
Compat/Breaking
Good First Issue
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
polyphony/polyproto-dot-org!162
No description provided.