project-open-data / project-open-data.github.io

Open Data Policy — Managing Information as an Asset
https://project-open-data.cio.gov/
Other
1.34k stars 583 forks source link

bureauCode and programCode as If-Applicable? #445

Closed tomschenkjr closed 9 years ago

tomschenkjr commented 9 years ago

Because data.json is being used widely, including on all Socrata portals, that spread across municipal and state governments, does it make sense to require bureauCode and programCode as Always required in the documentation? Should it be changed to If-Applicable?

The impact is trivial, but semantically useful. In the case of Chicago, there will never be a bureauCode or programCode since it doesn't apply, breaking the recommendations of the format.

rebeccawilliams commented 9 years ago

Thanks @tomschenkjr!

Right now the way that is distinguished in the metadata is with a small USG note: https://project-open-data.cio.gov/v1.1/schema/#USG-note See the discussion in #247.

I think changing the distinction to 'If-Applicable' might confuse federal implementers, but please share any ideas about how to make this more conspicuous.

tomschenkjr commented 9 years ago

Ah, ok, that makes sense. I didn't notice that in the table at the beginning.

Satisfies my question. Only suggestion would be to asterisk* those--tends to get me looking for a footnote.

rebeccawilliams commented 9 years ago

Closing for now since there is a notation, but feel free to reopen.