NatLabRockies / NatLabRockies/api-umbrella
Indicate API usage restrictions
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 2.2k
- Forks
- 373
- PR merge metrics
- No merged PRs in 30d
Description
Story
As an API consumer
I would like to know of any usage restrictions on any given API
So that I may determine whether the API is open access, commercial, copyrighted, etc..
Example
While browsing the list of available APIs, I
- Click on a specific API
- View details about usage restrictions (key requirements, financial requirements, data usage, etc.)
Depends
- Meta-data about usage restrictions
Related issue: #53
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with related issue #53 and the dependency on metadata about usage restrictions. Trace the API list-to-detail flow described in the example and identify where restrictions should appear; done means consumers can see key, financial, and data-usage requirements for each API.
Written by the indexing model from the issue text.
Assessment
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100