CycloneDX / CycloneDX/transparency-exchange-api

Discovery - Document other HTTP response codes for error scenarios

Open
#165 1 comment 0 reactions 1 assignee Claimed by @oej View on GitHub
documentation hackathon Prio 1 TEI Discovery
Dominant language
Shell
Stars
113
Forks
22
Avg merge
8d 12h
Merged PRs (30d)
5

Description

It is possible that a TEA Client may have cached a TEA Server for a TEI, or in talking with a TEA Service, there are errors encountered.

It is suggested that other HTTP response codes are documented and their purposes within TEA defined.

For discussion - above and beyond what is already defined in the Beta 1 API Specification and the standard HTTP specification:

| HTTP Response Code | Permitted ? | Description |
| ---------------------- | ------------ | ----------- |
| 400 | Y | |
| 401 | Y | Not authorized |
| 402 | ? | Payment Required - might be implemented by Commercial TEA Services |
| 403 | Y | Authenticated, but not authorized |
| 404 | Y | To be defined - see also #163 |
| 503 | Y | Can be used to tell a TEA Client that the TEA Service no longer supports the requested TEI |

Others are welcome to add / discuss please.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.