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

API Builder #2

Open
i-am-waseem opened this issue Jun 2, 2023 · 0 comments
Open

API Builder #2

i-am-waseem opened this issue Jun 2, 2023 · 0 comments

Comments

@i-am-waseem
Copy link

Project Description
FarmStack is an open source no code data exchange platform to streamline collaboration between key players in the agriculture sector. It supports government actors to run a data exchange as well as the participants who can publish, discover and consume data to build better solutions that unlock the potential of data for farmers.

Farmstack is suite of suite of tools that help explore datasets to enable participant to pinpoint ideal dataset with smart search.It also helps create data pipelines, thereby automating movement of data across different systems that can range from DBs (SQL, postgre) or file servers or APIs. It enhances the usability of data by intuitive data categorisation builder, standardisation and click based integration.

As part of FarmStack, participants want to publish the data as the rest API so that other data consumers can use these APIs for building dynamic use cases efficiently.

List of features
As a user, I want to select datapoints to be exposed as Rest APIs as key value pair
As a user, I want to apply usage policy of secret key required for accessing the APIs
As a user, I want to request for the secret key to access the rest APIs of the specific dataset available as Rest APIs
Learning
Complexity: Medium
Skills: Python, django, reactjs, RestAPI
Project size: 6 weeks

Documentation
https://github.com/digitalgreenorg/datahub-api/tree/fs_eth_prod

Acceptance Criteria
When the user selects the columns of the imported data, then the app should create Rest API endpoints
When the user adds the description of the API, then the app should allow the user to provide a 250 character description for the endpoint
When the user clicks on submit button, then the app should navigate user to the usage policies screen
When the user selects the secret key usage policy to be applied to the APIs, then the app should record this usage policy against the dataset
When the user requests for the secret key, then the app should show the secret key once to the user and allow her to copy to clipboard

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

No branches or pull requests

1 participant