source-cooperative / source-cooperative/docs.source.coop
Document API limit informaiton
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1
- Forks
- 2
- Avg merge
- 25m
- Merged PRs (30d)
- 2
Description
A user asked:
Where can I find information about API limits? How many requests can I make? Should i refer for AWS limits?
The way I intend to use Source involves a large number of callbacks, even though the data volume isn't large, it will be accessed very frequently.
It would be very useful to add this information to the documentation.
The answer right now is: We don't currently impose any limits. That may change in the near future and would likely be able to be mitigated by a user by authenticating. The exact strategy of how we impose limits is a business decision that we would need to make.
To the topic of documentation, a simple summary of ☝️ could be shared somewhere with a strong emphasis on the fact that this may change in the future
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
No documentation file or test is named. Start by locating the API documentation entry point, then review nearby guidance for request limits and authentication. Done means adding a clearly placed summary of the current limit policy and noting that it may change.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100