Skip to content

RHCLOUD-47192- create kessel error codes page#100

Open
Adam0Brien wants to merge 4 commits into
mainfrom
docs/error-codes-reference
Open

RHCLOUD-47192- create kessel error codes page#100
Adam0Brien wants to merge 4 commits into
mainfrom
docs/error-codes-reference

Conversation

@Adam0Brien

@Adam0Brien Adam0Brien commented May 25, 2026

Copy link
Copy Markdown
Member

Summary

  • Adds a new reference page documenting all gRPC error codes and messages returned by the Inventory API
  • Organized into tabbed sections (Error Codes, Stable Messages, Variable Messages, Examples) for quick lookup
  • Cross-referenced against error_mapping.go, auth middleware, validation middleware, and all handler/service paths in inventory-api
  • Includes client handling guidance (retry/no-retry/escalate) per code

What's covered

  • Stable messages from centralized error mapping (safe for dashboards)
  • Variable messages from request conversion, protovalidate, sanitization, and bulk operations
  • Known streaming RPC edge case (meta authorization context missing as UNKNOWN)
  • Response examples showing real grpcurl output

@Adam0Brien Adam0Brien force-pushed the docs/error-codes-reference branch from 89e5a27 to e9d9d45 Compare June 9, 2026 10:51
@Adam0Brien Adam0Brien force-pushed the docs/error-codes-reference branch from a5e6199 to ec7aa3a Compare June 11, 2026 10:09
Comment thread src/content/docs/building-with-kessel/reference/error-codes.mdx Outdated
@Adam0Brien Adam0Brien force-pushed the docs/error-codes-reference branch from a3db00d to 7faf6c7 Compare June 12, 2026 13:41
| `UNIMPLEMENTED` | RPC not available | Wrong API version or disabled feature | Confirm service version |
| `INTERNAL` | Server failure | DB error, meta-authorizer down, bulk mismatch | Check logs; verify backend health |
| `UNAVAILABLE` | Cannot accept traffic | Read-only mode, process down | Retry; check read-only flag |
| `UNAUTHENTICATED` | No valid auth | No credentials, middleware reject, missing stream metadata | Configure [authentication](/building-with-kessel/how-to/authenticate-with-python-sdk/) |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

consequence of timing but this was just merged to be

Suggested change
| `UNAUTHENTICATED` | No valid auth | No credentials, middleware reject, missing stream metadata | Configure [authentication](/building-with-kessel/how-to/authenticate-with-python-sdk/) |
| `UNAUTHENTICATED` | No valid auth | No credentials, middleware reject, missing stream metadata | Configure [authentication](/building-with-kessel/how-to/authenticate-with-sdks/) |

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants