Skip to content

Conversation

@handrews
Copy link
Contributor

@handrews handrews commented Jan 6, 2017

When we had more formats in earlier drafts, all compound names
(such as "date-time") were hyphenated. Draft 05 added "uriref"
without a hyphen, which started looking weird when we added
"uritemplate" and "jsonpointer" without hyphens to match it.
This makes everything hyphenated (note "hostname" was deemed
to be a single word in this context).

Addresses issue #207.

@handrews handrews requested a review from awwright January 6, 2017 18:42
@handrews handrews added this to the draft-next (draft-6) milestone Jan 6, 2017
@handrews
Copy link
Contributor Author

handrews commented Jan 6, 2017

Paging @awwright as he had not weighed in on issue #207 before I made this PR.

@handrews
Copy link
Contributor Author

@awwright this has been out for almost two weeks and everyone else involved in the discussion has approved this approach either here or (two more people) in issue #207. Any thoughts?

@awwright
Copy link
Member

@handrews Sorry for being so slow this week! I've been dealing with some server issues (if you stopped by the IRC channel you probably noticed I'm not there at the moment).

I'd like to look over how these terms are used in the wild, usually "uriref" is a single word, for example (formally "URI-Reference"); whereas an RFC3339 string is "date-time" and RFC6570 specifies "URI-Template". I think it makes sense to copy how they're defined in their respective specifications, which mostly seem to prefer the hyphen format.

I would vote to keep uriref a single term, but it doesn't matter too much, this is mostly OK.

@handrews
Copy link
Contributor Author

@awwright

I've been dealing with some server issues (if you stopped by the IRC channel you probably noticed I'm not there at the moment).

Ugh, hope that clears up soon- I had looked on IRC to try to get you there before paging you on the PRs today.

I'm looking at RFC 3986 "uriref" anywhere. Nor "uri-ref", just "URI-Reference". Am I missing something? If we're going by the spec, it should be "uri-reference" which seems reasonable to shorten to "uri-ref" (although I'd be fine with "uri-reference").

RFC 6570 uses "URI-Template" but never "uritemplate" (in any capitalization).

RFC 6901 uses "json-pointer" and never "jsonpointer".

So unless there's a source for "uriref" that I'm missing, I think all-hyphenated is clearly the way to go. Let me know if you object, have another reference, or would prefer "uri-reference". Otherwise I'll merge this after it reaches the 2-week mark on Friday since you're objection doesn't seem strong and there's otherwise consensus.

When we had ore formats in earlier drafts, all compound names
(such as "date-time") were hyphenated.  Draft 05 added "uriref"
without a hyphen, which started looking weird when we added
"uritemplate" and "jsonpointer" without hyphens to match it.
This makes everything hyphenated (note "hostname" was deemed
to be a single word in this context).

"uriref" became "uri-reference" as that is the form that is
most common in other RFCs.
@handrews
Copy link
Contributor Author

From IRC: @awwright feels "uri-reference" is more consistent, as it is what is used in other RFCs. I'm fine with this, it's still doing what the issue filers asked, so we're good to merge.

@awwright awwright merged commit dabf8c0 into json-schema-org:master Jan 23, 2017
@handrews handrews deleted the formatformat branch January 24, 2017 21:19
@gregsdennis gregsdennis added clarification Items that need to be clarified in the specification and removed Type: Bug labels Jul 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clarification Items that need to be clarified in the specification Priority: High

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants