metalicious icon indicating copy to clipboard operation
metalicious copied to clipboard

Add API functionality

Open tomschenkjr opened this issue 12 years ago • 5 comments

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.

tomschenkjr avatar Oct 15 '13 00:10 tomschenkjr

What are some use cases for such an API?

jpvelez avatar Oct 23 '13 17:10 jpvelez

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

tomschenkjr avatar Oct 23 '13 21:10 tomschenkjr

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

athornburg avatar Oct 28 '13 20:10 athornburg

@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?

tomschenkjr avatar Oct 29 '13 00:10 tomschenkjr

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

athornburg avatar Oct 29 '13 01:10 athornburg