kubernetes-sigs/kubectl-validate

GitHub downloader subject to rate limits

Open

#17 opened on May 4, 2023

View on GitHub
 (2 comments) (0 reactions) (1 assignee)Go (56 forks)auto 404
good first issue

Repository metrics

Stars
 (268 stars)
PR merge metrics
 (PR metrics pending)

Description

For unsupported schemas we have the option of downloading them from GitHub. This requires 1 or 2 api calls to list Kubernetes source directories. GitHub responses support E-Tags in their responses so can be cached without affecting the rate limit. We should add an on-disk cache similar to kubectl that stores the etags.

Another improvement would be to use the GitHub api key if supplied in envar or argument. That way the test suite would not ever be subject to rate limiting.

Contributor guide

Research direction
Implement an on disk cache for GitHub API responses using ETags, and optionally read a GitHub API key from environment variable or command line argument.
Tech stack
go
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoHTTP
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65