docs: fix URN examples #718
Conversation
…ccording to the linked RFC 8141 and its associated IANA URN namespaces registry.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
|
Kudos, SonarCloud Quality Gate passed!
|
|
This pull request has been automatically marked as stale because it has not had recent activity 😴 It will be closed in 120 days if no further activity occurs. To unstale this pull request, add a comment with detailed explanation. There can be many reasons why some specific pull request has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model. Let us figure out together how to push this pull request forward. Connect with us through one of many communication channels we established here. Thank you for your patience ❤️ |
|
@mike-schenk hi, I'm really sorry for getting so late here. Can you solve merge conflicts please 🙏🏼 |
There was a problem hiding this comment.
looks good
@mike-schenk - would you like some help with the merge conflicts?
|
Kudos, SonarCloud Quality Gate passed!
|
|
Merge conflicts resolved. |
|
/rtm |
|
🎉 This PR is included in version 2.5.0-next-major-spec.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
|
Forget about the last comment saying it was released in version 2.5.0-next-major-spec.1. I made a mistake and it created this version but it should actually be |
|
🎉 This PR is included in version 2.5.0-next-spec.5 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
|
Recent comments about the release from the bot were added by mistake. More details in #899 |
title: "Use valid URIs or URNs in Identifier examples"
Changes invalid URN examples to either valid URIs or to valid URNs according to the linked RFC 8141 and its associated IANA URN namespaces registry.
Reverse DNS names do not form valid URNs. The registry of defined URN namespace identifiers is quite limited. Because of that, it seems unlikely that a valid URN will actually be useful in the context of an AsyncAPI document, but to make the minimal change in the spec document, I used the
examplenamespace identifier.Instead of a URN, a URI with the registered
tagscheme seems to apply better. Since the semantics of the tag URI scheme appear to match the desired intent of a universally-unique and long-lived identifier.This is an editorial change, but I apparently can't set that label myself.
Related issue(s):