Skip to content

HYPERFLEET-1231: align error-model.md detail field with RFC 9457 and TypeSpec #175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kuudori wants to merge 1 commit into
base: main
Choose a base branch
from
Open

HYPERFLEET-1231: align error-model.md detail field with RFC 9457 and TypeSpec #175

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions hyperfleet/standards/error-model.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
Status: Active
Owner: HyperFleet Platform Team
Last Updated: 2026-01-02
Last Updated: 2026-06-26
---

# HyperFleet Error Model and Codes Standard
Expand Down Expand Up @@ -110,9 +110,11 @@ HyperFleet APIs MUST return errors using the [RFC 9457](https://www.rfc-editor.o
| `type` | URI | Yes | URI reference identifying the problem type |
| `title` | string | Yes | Short, human-readable summary of the problem type |
| `status` | integer | Yes | HTTP status code (100-599) |
| `detail` | string | Yes | Human-readable explanation specific to this occurrence |
| `detail` | string | No | Human-readable explanation specific to this occurrence |
| `instance` | URI | No | URI reference identifying the specific occurrence |

> HyperFleet implementations SHOULD always populate `detail` to provide actionable context to API consumers. The field is schema-optional per [RFC 9457 Section 3.1](https://www.rfc-editor.org/rfc/rfc9457.html#section-3.1), but omitting it degrades the developer experience for partners consuming error responses.

### HyperFleet Extension Fields

In addition to RFC 9457 standard fields, HyperFleet errors include these extension fields:
Expand Down