google / openintent

Apache License 2.0
27 stars 3 forks source link

openintent-wifi-access_points.schema.json formatting review #4

Open benea11 opened 1 year ago

benea11 commented 1 year ago

Hi Jake,

I've spent some time reading through the access_point schema, without paying too much attention to anything other than the formatting of the file. Here are some notes to consider

jsnyder81 commented 1 year ago

minItems, oneOf are part of the jsonschema keywords, and cannot be changed. Which they likely came from JS notation which prefers this style

I'm interested in why you would want to version each property, instead of the schema as a whole. This gets really messy when it comes to which things you support from which version. I think our current plan is to implement versioning per schema, and then bundle the schemas into a release so you can say "i support bundle 1.0" and you know what all the schema files look like. This will get more critical as we break some of the schemas apart so they can be versioned.

benea11 commented 1 year ago

Thx for correcting me on the JSON keywords, completely missed that, have removed those 2 points.

regarding the versioning, I don't mean to version each individual property, but rather add the version as a property. I think this is a personal preference thing. In the past, I have added the version as a property to make it a little easier to query later in code (arguably negligible). In reality, I think there is little difference to have it at the top level or as a property - other than having at the top level is going to be more prominent.