schema

type ErrorCode int32

type Schema struct {

	// schema_id: Unique identifier for this schema family.
	// All versions of the same schema share this ID.
	// Example: "order-schema", "user-event-schema"
	SchemaId string `protobuf:"bytes,1,opt,name=schema_id,json=schemaId,proto3" json:"schema_id,omitempty"`
	// version: Schema version number (positive integer).
	// Increment when making changes to the schema.
	// Semantic versioning recommended:
	//
	//	v1 -> v2: backward compatible changes (add optional fields)
	//	v2 -> v3: breaking changes (remove/rename fields, change types)
	Version int32 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
	// name: Human-readable schema name.
	// Example: "Order Validation Schema v2", "User Registration Event"
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// description: Detailed description of what this schema validates.
	// Include changelog for new versions.
	// Example: "v2: Added optional 'discountCode' field. Removed deprecated 'legacyField'."
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// content: The actual validation schema.
	// Format depends on content_type.
	// For "json-schema": JSON Schema Draft 7 (https://json-schema.org/)
	// For "protobuf": Base64-encoded FileDescriptorSet
	// Size limit: 1MB
	Content string `protobuf:"bytes,5,opt,name=content,proto3" json:"content,omitempty"`
	// content_type: Schema format identifier.
	// Supported values:
	//
	//	"json-schema" (default): JSON Schema Draft 7
	//	"protobuf": Protocol Buffers schema
	//	"avro": Apache Avro schema
	//
	// ChronoQueue validates content syntax when registering schema.
	ContentType string `protobuf:"bytes,6,opt,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
	// created_at: When this schema version was registered (Unix milliseconds).
	// Automatically set by ChronoQueue.
	CreatedAt int64 `protobuf:"varint,7,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// updated_at: When this schema was last modified (Unix milliseconds).
	// Schemas are immutable after creation; updates create new versions.
	// This tracks metadata changes (name, description, is_active).
	UpdatedAt int64 `protobuf:"varint,8,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// is_active: Whether this schema version can be used for validation.
	// Set to false to deprecate old versions.
	// Queues configured with this schema_id will use the highest active version.
	// Use case: Deactivate v1 after all clients migrate to v2.
	IsActive bool `protobuf:"varint,9,opt,name=is_active,json=isActive,proto3" json:"is_active,omitempty"`
	// metadata: Additional schema metadata.
	// Use for:
	//
	//	"owner": "team-checkout"
	//	"deprecation_date": "2025-01-01"
	//	"changelog_url": "https://..."
	//	"contact": "checkout-team@example.com"
	Metadata map[string]string `` /* 144-byte string literal not displayed */
	// contains filtered or unexported fields
}

type ValidationError struct {

	// field: JSON path to the field that failed validation.
	// Uses dot notation: "payload.data.orderId", "payload.data.items[0].productId"
	// Root level: "payload.data"
	Field string `protobuf:"bytes,1,opt,name=field,proto3" json:"field,omitempty"`
	// error_code: Standardized error code from ErrorCode enum.
	// Enables programmatic error handling across different schema types.
	ErrorCode string `protobuf:"bytes,2,opt,name=error_code,json=errorCode,proto3" json:"error_code,omitempty"`
	// message: Human-readable error explanation.
	// Safe to show to end users or log for debugging.
	// Example: "Field 'orderId' must match pattern '^ORD-[0-9]+$', got 'invalid'"
	Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	// details: Additional context about the error.
	// Contents depend on error_code:
	//
	//	INVALID_TYPE: {"expected": "integer", "actual": "string"}
	//	PATTERN_MISMATCH: {"pattern": "^[A-Z]+$", "value": "abc"}
	//	VALUE_OUT_OF_RANGE: {"min": "0", "max": "100", "value": "150"}
	Details map[string]string `` /* 141-byte string literal not displayed */
	// contains filtered or unexported fields
}

type ValidationResult struct {

	// valid: True if payload passed validation, false otherwise.
	Valid bool `protobuf:"varint,1,opt,name=valid,proto3" json:"valid,omitempty"`
	// errors: List of validation errors (empty if valid = true).
	// Each error describes one validation rule violation.
	Errors []*ValidationError `protobuf:"bytes,2,rep,name=errors,proto3" json:"errors,omitempty"`
	// validated_at: When validation was performed (Unix milliseconds).
	ValidatedAt int64 `protobuf:"varint,3,opt,name=validated_at,json=validatedAt,proto3" json:"validated_at,omitempty"`
	// schema_id: Which schema was used for validation.
	SchemaId string `protobuf:"bytes,4,opt,name=schema_id,json=schemaId,proto3" json:"schema_id,omitempty"`
	// schema_version: Which schema version was used.
	// Helps debug validation failures after schema upgrades.
	SchemaVersion int32 `protobuf:"varint,5,opt,name=schema_version,json=schemaVersion,proto3" json:"schema_version,omitempty"`
	// contains filtered or unexported fields
}