syntax = "proto3";

package controller.api.v1;

option go_package = "github.com/hashicorp/watchtower/internal/gen/controller/api;api";

message ErrorDetails {
	string TraceId = 1 [json_name="TraceId"];
	string request_id = 2 [json_name="request_id"];
	repeated FieldError request_fields = 3 [json_name="request_fields"];
}

// FieldErrors contains error information on a per field basis.
message FieldError {
	string name = 1;
	string description= 2;
}

// Error is returned by the JSON API when an error occurs.
message Error {
	// The HTTP Status code applicable to this error
	int32 status = 1;
	// An application-specific error string
	string code = 2;
	// A human readable explanation specific to this occurrence of the error
	string message = 3;
	// Additional metadata regarding the error. Depending on the error
	// different fields will be populated.
	ErrorDetails details = 4;
}