Enum InputLocation

Namespace

Trellis

Assembly

Trellis.Core.dll

Identifies which part of an input an offending value came from.

public enum InputLocation

Fields

Body = 1

The value came from the request body, addressed by a JSON Pointer.

Header = 4

The value came from a request header, addressed by name.

Path = 3

The value came from a route (path) parameter, addressed by name.

Query = 2

The value came from a query-string parameter, addressed by name.

Unspecified = 0

The location is not known. Projects as "unknown".

Remarks

This is the in discriminator of a validation error's location on the wire. The default, Unspecified, projects as "unknown", which means "do not resolve the accompanying pointer as a document location" — the producer did not know where the value came from and says so rather than asserting a checkable claim that may be false.

Body locations carry an RFC 6901 JSON Pointer into the request document. Query, Path and Header locations carry a parameter name instead, because there is no document for a pointer to address.