Class BehaviorApiSurfaceDescriptor
Namespace: Cephalon.Abstractions.Behaviors
Assembly: Cephalon.Abstractions.dll
Describes the logical public API surface projected by a behavior across transport adapters.
public sealed class BehaviorApiSurfaceDescriptorInheritance
Section titled “Inheritance”object ← BehaviorApiSurfaceDescriptor
Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Remarks
Section titled “Remarks”This descriptor stays transport-agnostic. Route-shaped non-REST adapters such as JSON-RPC, GraphQL-over-SSE, GraphQL-over-WebSocket, Server-Sent Events, and WebSocket can project canonical routes from the same logical surface without forcing transport-specific path details into behavior identifiers. Public REST stays module-owned.
Constructors
Section titled “Constructors”BehaviorApiSurfaceDescriptor(string, string)
Section titled “ BehaviorApiSurfaceDescriptor(string, string)”Initializes a new
public BehaviorApiSurfaceDescriptor(string groupPath, string operationPath)Parameters
Section titled “Parameters”groupPath string
The logical group path, such as cart or orders/status.
operationPath string
The logical operation path, such as get or remove-item.
Properties
Section titled “Properties”GroupPath
Section titled “ GroupPath”Gets the logical group path shared by transport-specific projections.
public string GroupPath { get; }Property Value
Section titled “Property Value”OperationPath
Section titled “ OperationPath”Gets the logical operation path shared by transport-specific projections.
public string OperationPath { get; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”CreateDefault(string)
Section titled “ CreateDefault(string)”Creates a default API surface descriptor from the supplied behavior identifier.
public static BehaviorApiSurfaceDescriptor CreateDefault(string behaviorId)Parameters
Section titled “Parameters”behaviorId string
The stable behavior identifier.
Returns
Section titled “Returns”The default logical API surface derived from the identifier.
Remarks
Section titled “Remarks”Behavior identifiers such as cart.get become group cart plus operation get.
Identifiers with more than two segments join all but the final segment into the group path.