gitpoint/git-point

Use conditional requests for API requests

Open

#178 opened on Jul 27, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (4,684 stars) (837 forks)batch import
enhancementhelp wanted

Description

https://developer.github.com/v3/#conditional-requests

Allows us to drastically cut down on the number of API requests we've made if there aren't any changes since the last time we accessed the endpoint.

Contributor guide

Tech stack
javascriptreact native
Domain
mobileapiperformance
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of HTTP conditional requestsFamiliarity with GitHub API v3
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue requests implementing conditional requests for API calls to reduce bandwidth. Review GitHub API documentation on conditional requests (using ETags and If None Match headers). The change should be made in the API client module, likely in files like 'src/api/client.js' or similar. Check existing test files for guidance on mocking HTTP responses. Ensure that when a 304 Not Modified is returned, the cached response is used instead.