Change "id" to "$id", retain "id" as deprecated. #154
Conversation
|
Note: If we end up going in the direction of #155 (which I posted to illustrate the approach- it's not a final proposal) then this PR becomes irrelevant. |
|
I suggest not including it into v6, see #137 (comment) |
|
@epoberezkin having read #160 I see no reason to keep this small (and for v6, backwards-compatible) change out of v6. #160 would be a radical departure whether we have "id" or "$id", so let's start being consistent about core keyword naming ("$schema", "$id", "$ref"). There is already at least one implementation that uses "$id" instead of "id", and at least one other that can't handle instance properties called "id" because of the naming overlap- that's a bug, but indicative of the problems of the current name. Plus, we already managed to get broad agreement on this rename. |
| "id": { | ||
| "description": "This keyword has been deprecated in favor of \"$id\"", |
There was a problem hiding this comment.
That's probably a good idea, though the patch does include a comment saying it'll likely get removed in the future.
And of course, just because it's removed doesn't mean that implementations can't still support it (i.e. silently upgrade it).
Lemme think about this some, unless you can elaborate more
There was a problem hiding this comment.
I don't have strong feelings on this. The deprecation option came in response to migration concerns, although as you note there are several easy options for handling the change. If y'all decide to drop id entirely I'll be happy to update the PR.
There was a problem hiding this comment.
I think dropping from spec and optionally supporting in implementations addresses migration issues. I'd rather we keep it simple here, so new implementations don't have to carry this baggage...
There was a problem hiding this comment.
@awwright @epoberezkin I've submitted PR #212 as a version of this that drops "id" entirely.
handrews
force-pushed
the
id
branch
2 times, most recently
from
9c249aa to
aad514d
Compare
Relequestual
added
Priority: Medium
Status: Review Needed
Type: Enhancement
and removed
Status: Review Needed
labels
This addresses issue json-schema-org#20. "$id" matches "$schema" and "$ref", establishing a clear naming pattern for all keywords defined in the core specification. This also reduces confusion in the very common case where objects described by the schema have an "id" property. The current plan is to continue to allow for "id" until a migration tool can be provided.
|
See also #212 for an alternative that does not retain |
|
Since @awwright and @epoberezkin have both approved #212, I'm going to close this to reduce noise. |
This addresses issue #20.
"$id" matches "$schema" and "$ref", establishing a clear naming
pattern for all keywords defined in the core specification. This
also reduces confusion in the very common case where objects
described by the schema have an "id" property.
The current plan is to continue to allow for "id" until a migration
tool can be provided.