Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

murray's proposed change to "example.org" #70

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

murray's proposed change to "example.org" #70

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion draft-ietf-httpapi-rfc7807bis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ For example, if the two resources "https://api.example.org/foo/bar/123" and "htt
The type URI is allowed to be a non-resolvable URI. For example, the tag URI scheme {{TAG}} can be used to uniquely identify problem types:

~~~
tag:mnot@mnot.net,2021-09-17:OutOfLuck
tag:mnot@example.org,2021-09-17:OutOfLuck
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
tag:mnot@example.org,2021-09-17:OutOfLuck
tag:example@example.org,2021-09-17:OutOfLuck

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was debating that one. I think it's fine either way, it felt like the domain name was the main issue.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just put it in without thinking -- example@example.org is clearest

~~~

However, resolvable type URIs are encouraged by this specification because it might become desirable to resolve the URI in the future. For example, if an API designer used the URI above and later adopted a tool that resolves type URIs to discover information about the error, taking advantage of that capability would require switching to a resolvable URI, creating a new identity for the problem type and thus introducing a breaking change.
Expand Down