search

johnnydecimal / index-spec

A 'formal' specification for the index file. And any other data structures.
MIT License
20 stars 0 forks source link

Metadata Key Name Ambiguity #3

Open jillesme opened 8 months ago

jillesme commented 8 months ago

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?

johnnydecimal commented 8 months ago

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.

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.