swagger-api / swagger-api/validator-badge
Publish a privacy policy
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 227
- Forks
- 81
- Avg merge
- 2h 3m
- Merged PRs (30d)
- 1
Description
As the validator is fetching specs that may be private (for example from a privately hosted version of swagger-ui), this may lead users to leak private API specs to your service.
It would be helpful for trust to publish a privacy policy about what the public instance of validator at online.swagger.io does server-side:
- how are handled the URIs of spec file submitted to the validator? (logged? for how long?)
- how are handled the content of spec downloaded by the validator? (cached? stored?)
- what is the
User-agentof the validator in HTTP headers? Does it respects/robots.txt?
Contributor guide
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 by reviewing the public validator instance at online.swagger.io and the issue's questions about URI handling, downloaded spec content, request User-Agent, and robots.txt behavior. Done means publishing a privacy policy that answers those questions for users of the public service.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, security
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100