index-spec icon indicating copy to clipboard operation
index-spec copied to clipboard

Metadata Key Name Ambiguity

Open jillesme opened this issue 1 year ago • 1 comments

At the end of the spec, there is a section around metadata. It has a field "The key name." which has no further description.

Are these valid key names?

  • Location
  • My Favorite Location
  • 199
  • cfb3f801-91b4-4307-af17-bb09f9a7c235
  • 🧠🥹
  • https://link

jillesme avatar Feb 27 '24 15:02 jillesme

I’d probably lean towards copying whatever The Popular Languages do, as they’ve thought about it more than I have.

JSON seems like a sensible baseline given the likelihood that one might encode one’s JD index using it?

https://json-schema.org/understanding-json-schema/reference/object

So, any string is my suggestion.

  • ✅ Location
  • ✅ My Favorite Location
  • ❌ 199 but ✅ “199”
  • ✅ cfb3f801-91b4-4307-af17-bb09f9a7c235
  • ❌ 🧠🥹
  • ✅ https://link/

This is not my field of expertise and I’m happy to be overridden by actual programmers. Pragmatism should rule here: what’s the simplest to encode, what causes the least issues, what’s going to be annoying or unexpected, etc.

johnnydecimal avatar Feb 27 '24 21:02 johnnydecimal