[feature request] Add id to html elements so that we can link to them in the url

[sbalay]

It would be nice if we could use # in the url to link directly to specific fields in the json schema representation

[jy95]

Hello @sbalay,

Welcome - the anchor idea was something I started reflexion but I may be biased - I'm open for discussion .
In JSON Schema specs, there are multiple ways to achieve what you ask.

In my personal opinion, Json-Pointer as id seems the wise choice :

1. You don't have to modify your JSON Schema (like putting $anchor for example)
2. It should support nested paths
3. Little trade-off are the encoding rules for the id in urls but it is better than nothing

Let's take some examples to illustrate my thinking :

Object properties

Given this JSON Schema :

{
  "$id": "https://example.com/schemas/address",
  "type": "object",
  "properties": {
    "street_address":
      { "type": "string" },
    "city": { "type": "string" },
    "state": { "type": "string" }
  },
  "required": ["street_address", "city", "state"]
}

I would like to target the street_address property so JSON Pointer is /properties/street_address
Url would be something like /something#/properties/street_address

Array Properties

Given this JSON Schema :

{
  "type": "array",
  "prefixItems": [
    { "type": "number" },
    { "type": "string" },
    { "enum": ["Street", "Avenue", "Boulevard"] },
    { "enum": ["NW", "NE", "SW", "SE"] }
  ]
}

I would like to target the 3rd entry of the array so JSON Pointer is /prefixItems/3
Url would be something like /something#/prefixItems/3

Example of escaped attribute

Given this JSON Schema :

{
  "$id": "https://example.com/schemas/address",
  "type": "object",
  "properties": {
    "street_address":
      { "type": "string" },
    "city": { "type": "string" },
    "country/state": { "type": "string" }
  },
  "required": ["street_address", "city", "state"]
}

I would like to target the country/state property so JSON Pointer is /properties/country~1state
Because of encoding rules, url would be something like /something#/properties/country~1state

I'm curious on how Docusaurus Collapsible component behalves for nested levels but I guess it is worthy an try ...

Feel free to share your thoughts ;)

[jy95]

@sbalay #234 should solve your issue with fields - could you give a look with the preview playground before I release the 1.10.0 version ?

[sbalay]

Hey @jy95, thanks for the hard work!

I played around with the deploy preview and it looks really good!

[jy95]

@sbalay 1.10.0 is out : have fun ;)