Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for metadata API #145

Open
tomschenkjr opened this issue Oct 19, 2017 · 0 comments
Open

Support for metadata API #145

tomschenkjr opened this issue Oct 19, 2017 · 0 comments
Assignees

Comments

@tomschenkjr
Copy link
Contributor

Socrata has rolled-out a new read/write metadata API that allows users to read metadata (e.g., name of data set, description, categories, tags, column descriptions, etc.)

Reading Metadata

You can read metadata on all the data sets (e.g., list name, description, categories, etc.) on a Socrata domain (e.g., data.cityofchicago.org) or you can list metadata for a single data set. Here is the metadata available to read on a data set.

Writing and Updating Metdata

Users with an API key that allows writing to Socrata can publish and update metadata over the API. Users can author new metadata or overwrite/update existing metadata.

Including in RSocrata

If we adopt this, I'm not sure the best way to approach it. Namely, I think there are two potential options. First, we can have reading/writing metadata to be standalone functions, such as read.socrataMetadata and write.socrataMetadata, respectively.

Otherwise, we could potentially include these as an optional switch within the existing read.socrata and write.socrata functions. For instance, listing all available metadata for a domain would be read.socrata(url = data.domain.gov, metadata = T) while as writing metadata would take the form of write.socrata( ... , metadata = T).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant