romshark / jscan

High performance JSON iterator & validator for Go
BSD 3-Clause "New" or "Revised" License
88 stars 7 forks source link

Path format is not documented #12

Closed dolmen closed 1 year ago

dolmen commented 1 year ago

The format for paths returned by Iterator.Path and IteratorBytes.Path is not documented. Is it JSON Pointer (RFC 6901)? Some other format?

romshark commented 1 year ago

The path was a tertiary feature that I didn't pay much attention to. It's not RFC compliant, it's just a custom format. I even thought about removing it because tidwall/gjson for example does a much better job at getting values by path, but I decided to still keep it in v1 because it was already working. RFC compliance may only be possible in v2.

romshark commented 1 year ago

v2.0 will feature RFC-6901 JSON pointers.