mirror of
https://github.com/andwati/zitadel.git
synced 2026-11-16 02:35:12 +00:00
# Which Problems Are Solved As part of https://github.com/zitadel/zitadel/issues/11917 we want to introduce error slugs so (API) clients can rely on stable, machine-readable errors and act accordingly. # How the Problems Are Solved - Added a `NewSlug` helper function in the domain package. - Added `ErrorDetails` to the `ZitadelError` - Added an `zitadel.error.v2.ErrorDetail` proto message - Updated the connectRPC error interceptor to map new slug based errors to the new `ErrorDetail` - Defined some common slugs and error functions like internal errors - Defined (session) specific slugs used in the `DeleteSession` and `CheckUser` functions and replaced old implementations - Updated integration tests to check specific errors if the relation database feature is enabled - Updated doc and guideline to reflect the latest changes and decisions - Updated DeleteSession endpoint API to list possible slugs # Additional Changes None # Additional Context - closes #11957 --------- Co-authored-by: Wim Van Laer <[email protected]>
29 lines
1.7 KiB
Protocol Buffer
29 lines
1.7 KiB
Protocol Buffer
syntax = "proto3";
|
|
|
|
package zitadel.error.v2;
|
|
|
|
import "google/protobuf/struct.proto";
|
|
|
|
option go_package = "github.com/zitadel/zitadel/pkg/grpc/error/v2;errorpb";
|
|
|
|
// ErrorDetail is the ZITADEL standard for rich error responses.
|
|
message ErrorDetail {
|
|
// The slug is a stable, machine-readable, two-part identifier (e.g., "user.already_exists").
|
|
// It is intended for programmatic use and does not change across versions, making it suitable for clients to use in their error handling logic.
|
|
// It is built from a namespace / resource (e.g., "user") and a specific error condition (e.g., "already_exists"), separated by a dot.
|
|
string slug = 1;
|
|
|
|
// The message is a human-readable message in English.
|
|
// This message is intended for developers and should provide a clear explanation of the error.
|
|
// It is not meant for end-users and should not be localized.
|
|
// Clients are encouraged not to present this to their end-users, but rather use their own translation logic based on the slug.
|
|
string message = 2;
|
|
|
|
// The details field is a structured object that can contain additional information about the error.
|
|
// It is intended to provide more context for developers and can include any relevant data that may help in diagnosing the issue
|
|
// or clients can use it to provide additional context in their error handling logic.
|
|
// The content of the details field is not standardized and can vary depending on the error type.
|
|
// While object details should remain consistent across versions, there's no guarantee that the structure will remain unchanged,
|
|
// so clients should not rely on a specific structure within the details field.
|
|
google.protobuf.Struct details = 3;
|
|
} |