search

Chicago / metalicious

An open source data dictionary which can be deployed to track the metadata of one or more databases.
Other
65 stars 22 forks source link

Add API functionality #15

Open tomschenkjr opened 10 years ago

tomschenkjr commented 10 years ago

Such a system will need to provide database information, schema, and associated descriptions. An API functionality will add machine-readable capabilities to the portal to enable third-party access and avoid the inevitable screen scraper (please put down the Python script).

Often, APIs could be used to create separate applications that provide different functionality, such as: an application that allows you to "upvote" fields to be the publish wishes to see on to the data portal, help integrate the data portal and data dictionary (see #19), integration with other tools (e.g., enterprise asset management), or simply redisplay the information.

jpvelez commented 10 years ago

What are some use cases for such an API?

tomschenkjr commented 10 years ago

@jpvelez - Updated the issue so you don't have to dig in comments to see the full thought.

athornburg commented 10 years ago

Are you looking for a REST API, an API to be deployed as a Maven dependency, or something else? Do you have a preference?

tomschenkjr commented 10 years ago

@athornburg my thought was a REST API as the city's API services have been REST services so far (e.g., data portal, ServiceTracker API, ClearPath API).

Your thoughts?

athornburg commented 10 years ago

@tomschenkjr I agree, a REST API is always good. Just wanted to make sure. Ill take a look if I get some time.