ErrorDetails
HTTP API schema
Optional typed context for an error. Fields are additive and only populated when the error can safely expose that context to API clients.
ErrorDetails fields
- endpointId
string Port OS endpoint ID involved in the failed dispatch.
- discoveryEndpointId
string Port OS provider endpoint (type ENDPOINT_PLUGIN) of the connection to send `discover-routes` to when `code` is `TARGET_UNSUPPORTED` because the route must be rediscovered.
- pluginId
string Port OS plugin ID that reported the failure.
- pluginRouteId
string Plugin-owned route identifier involved in the failed dispatch.
- provider
string Third-party provider or bridge name that reported the failure.
- directive
string Message namespace and name or provider directive that failed.
- parameter
string Request parameter or capability value that caused the failure.
- minimum
number Minimum accepted value when `code` is `VALUE_OUT_OF_RANGE`.
- maximum
number Maximum accepted value when `code` is `VALUE_OUT_OF_RANGE`.
- actual
string String representation of the submitted value when the plugin can safely report it.
- currentMode
string Current endpoint mode when `code` is `NOT_SUPPORTED_IN_CURRENT_MODE`.
- retryAfterSeconds
integer Suggested retry delay for rate-limit or provider-unavailable failures.
minimum: 0
- correlationId
string Provider or plugin correlation ID useful for support.
- providerCode
string The third-party provider's own error code, for support. It is opaque and provider-specific; branch on `code` and `family` instead.
- correlationToken
string Token that correlates an outcome-unknown dispatch with its eventual result.
- fieldErrors
array<ErrorFieldError> The request fields that were rejected, when the error is about the request's content.
- ItemErrorFieldError
fieldErrors[]: Reference ErrorFieldError