swagger-api / swagger-api/validator-badge

Validator badges not being rendered on Github

Open
#110 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
227
Forks
81
Avg merge
2h 3m
Merged PRs (30d)
1

Description

GitHub seems to proxy images and for some reason the badge is not making it through that process correctly. So, you see a broken image on the page and a link going to a URL like https://camo.githubusercontent.com/<long_hash_string> that is 404ing. You can see the failure on your own README. I have tried flipping it to use a https URL instead (since camo is for wrapping insecure image requests), but that doesn't seem to have made a difference. Given that many people put badges on their README.md, this is likely to affect many users. Thanks!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the broken badge from the README.md on GitHub and inspect the generated badge URL and the camo.githubusercontent.com response. Done means identifying a change that makes the validator badge render correctly on GitHub and verifying the result in a README.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.