ID
In This Topic
| Draft 04 | Draft 06 | Draft 07 | Draft 2019-09 | Draft 2020-12 |
 |
|
|
|
|
Validation
The value for this keyword MUST be a string, and MUST be a valid URI. This URI MUST be normalized, and SHOULD NOT be an empty fragment (#) or the empty URI.
The 'id' property changes the current resolution scope.
Typically it is only used on the root schema in order to place everything within that schema within a specified scope.
The subtleties of this attribute are beyond the scope of this documentation and only hinted at within the Json schema standard.
It is not recommended that it is used outside of the root schema.
If it is used outside the root schema, then it is recommended that you do a lot more reading on its implications and effects, as it can be a source of errors and inconsistent behavior in validating JSON parsers.
Changes in Draft 6 and above
In Draft 4 and below the ID property is called 'id', in Draft 6 and above it is called '$id'.
Graphical Representation
The property is represented in line within the diagram, properties with the icon 
.
The properties are also shown in the property grid when the containing schema is selected.
The constraint values are also shown on the tooltips (select and hover over an item in the diagram).
Editing
Its value can be edited in the following ways
- In place on the schema object by expanding the properties and clicking on it once it is already selected.
- Edited via the properties window when the containing schema is selected
- Edited directly in the Json Source view.
It can be deleted by selecting it and pressing delete, or right clicking it an pressing delete.
See Also