CycloneDX / CycloneDX/transparency-exchange-api
404 clarification
- Dominant language
- Shell
- Stars
- 113
- Forks
- 22
- Avg merge
- 8d 12h
- Merged PRs (30d)
- 5
Description
- 404 is overloaded. The new error-handling section defines 404 as "discovery endpoint not present", while the unchanged text further down and the OpenAPI spec define a `/discovery` 404 as "TEI unknown". A client can't tell "fail over to the next endpoint" from "stop" -> I would recommend sticking with TEI unknown. Otherwise, let's discuss.
Mentioned by @taleodor in #261
Contributor guide
Research direction
Compare the new error-handling section, the unchanged text later in the specification, and the OpenAPI definition for the /discovery 404 response; review the context in #261. Confirm whether 404 means that the TEI is unknown or that the discovery endpoint is absent, then update the affected specification text so clients can distinguish failover from stopping.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100