Class RestEndpointRuntimeDescriptor

Namespace: Cephalon.Abstractions.Transports
Assembly: Cephalon.Abstractions.dll

Describes one resolved public REST endpoint visible to the current runtime.

public sealed class RestEndpointRuntimeDescriptor

Inheritance

object ← RestEndpointRuntimeDescriptor

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Constructors

RestEndpointRuntimeDescriptor(string, string, string, string, string, string?, string?, int?, string?, string?, string?, int?, IReadOnlyList<string>?, string?, string?, string?, string?, string?, string?, RestEndpointCandidateProjectionDescriptor?, IReadOnlyList<RestEndpointBindingDescriptor>?, RestEndpointBindingFallbackMode?, IReadOnlyDictionary<string, string>?, string?, string?, string?, string?, string?, string?, string?, string?, IReadOnlyList<string>?, string?, RestEndpointGovernanceRuleSelectionBasis?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<RestEndpointOverrideActionKind>?, IReadOnlyList<RestEndpointOverrideActionKind>?, IReadOnlyList<string>?, IReadOnlyList<string>?)

Creates a resolved REST endpoint runtime descriptor.

public RestEndpointRuntimeDescriptor(string id, string transportId, string sourceKind, string method, string routePattern, string? sourceModuleId = null, string? sourceModuleVersion = null, int? sourceModuleVersionMajor = null, string? behaviorId = null, string? endpointName = null, string? openApiDocumentName = null, int? apiVersionMajor = null, IReadOnlyList<string>? tags = null, string? summary = null, string? description = null, string? originalEndpointName = null, string? originalSummary = null, string? originalDescription = null, string? candidateId = null, RestEndpointCandidateProjectionDescriptor? originalProjection = null, IReadOnlyList<RestEndpointBindingDescriptor>? bindingDescriptors = null, RestEndpointBindingFallbackMode? bindingFallbackMode = null, IReadOnlyDictionary<string, string>? metadata = null, string? authoringStyle = null, string? routeGroupPrefix = null, string? relativePattern = null, string? behaviorType = null, string? sourceId = null, string? requiredCapabilityKey = null, string? originalRequiredCapabilityKey = null, string? appliedOverrideId = null, IReadOnlyList<string>? matchedOverrideIds = null, string? selectedOverrideId = null, RestEndpointGovernanceRuleSelectionBasis? overrideSelectionBasis = null, IReadOnlyList<string>? skippedSuppressionIds = null, IReadOnlyList<string>? skippedOverrideIds = null, IReadOnlyList<RestEndpointOverrideActionKind>? selectedOverrideActionKinds = null, IReadOnlyList<RestEndpointOverrideActionKind>? appliedOverrideActionKinds = null, IReadOnlyList<string>? requiredFeatureFlagIds = null, IReadOnlyList<string>? originalRequiredFeatureFlagIds = null)

Parameters

id string

The stable endpoint identifier.

transportId string

The stable transport identifier that published the endpoint.

sourceKind string

The source kind that produced the endpoint, such as module-dsl or manual.

method string

The resolved HTTP method.

routePattern string

The resolved route pattern including the host REST prefix.

sourceModuleId string?

The stable source-module identifier when one is known.

sourceModuleVersion string?

The declared source-module version when one is available.

sourceModuleVersionMajor int?

The parsed source-module major version when one is available.

behaviorId string?

The stable behavior identifier when the endpoint dispatches through a Cephalon behavior.

endpointName string?

The resolved endpoint or operation name when one is available.

openApiDocumentName string?

The resolved OpenAPI document name when one is available.

apiVersionMajor int?

The resolved public API major version when one is available.

tags IReadOnlyList<string>?

The resolved OpenAPI tags when any are published.

summary string?

The resolved endpoint summary when one is available.

description string?

The resolved endpoint description when one is available.

originalEndpointName string?

The original endpoint or operation name before later endpoint-governance rewrites when the runtime can classify that source answer.

originalSummary string?

The original endpoint summary before later endpoint-governance rewrites when the runtime can classify that source answer.

originalDescription string?

The original endpoint description before later endpoint-governance rewrites when the runtime can classify that source answer.

candidateId string?

The stable originating candidate identifier when this endpoint was published from the module-owned behavior projection pipeline.

originalProjection RestEndpointCandidateProjectionDescriptor?

The original projection shape before later host-level overrides are applied when the endpoint was published from the module-owned behavior projection pipeline.

bindingDescriptors IReadOnlyList<RestEndpointBindingDescriptor>?

The resolved request-binding descriptors when the endpoint exposes an explicit binding plan.

bindingFallbackMode RestEndpointBindingFallbackMode?

The resolved request-binding fallback mode when the endpoint preserves deterministic request-binding behavior beyond the explicit binding plan, such as preserved source implicit-query fallback or preserved remaining request-body fallback.

metadata IReadOnlyDictionary<string, string>?

Optional additive metadata.

authoringStyle string?

The normalized authoring style such as behavior-module-profile or minimal-api when the runtime can classify how the endpoint was published.

routeGroupPrefix string?

The resolved route-group prefix including the host REST prefix when the runtime can classify the grouped publication boundary that produced the endpoint.

relativePattern string?

The resolved route pattern relative to the grouped publication boundary when the runtime can classify that source shape.

behaviorType string?

The concrete behavior implementation type name when the endpoint dispatches through a Cephalon behavior and the runtime can classify that implementation identity.

sourceId string?

The stable source identity for the published endpoint when the runtime can classify the authored source shape behind that publication.

requiredCapabilityKey string?

The required Cephalon capability key enforced at the REST boundary when one is available.

originalRequiredCapabilityKey string?

The original required Cephalon capability key before later endpoint-governance rewrites when the runtime can classify that source answer.

appliedOverrideId string?

The host-level override identifier when runtime governance actually changes the published endpoint answer.

matchedOverrideIds IReadOnlyList<string>?

The ordered override identifiers that matched this endpoint’s originating candidate before one winner was selected.

selectedOverrideId string?

The selected override identifier when one winning override rule was resolved for this endpoint’s originating candidate, even if that winning rule became a runtime no-op.

overrideSelectionBasis RestEndpointGovernanceRuleSelectionBasis?

The earliest decisive specificity rule that selected the winning override rule when one was resolved for this endpoint’s originating candidate.

skippedSuppressionIds IReadOnlyList<string>?

The ordered suppression identifiers that otherwise target this endpoint’s originating candidate but were skipped because the original projection did not allow host governance to participate.

skippedOverrideIds IReadOnlyList<string>?

The ordered override identifiers that otherwise target this endpoint’s originating candidate but were skipped because the original projection did not allow host governance to participate.

selectedOverrideActionKinds IReadOnlyList<RestEndpointOverrideActionKind>?

The normalized action dimensions declared by the selected override rule when one winning override rule was resolved for this endpoint’s originating candidate.

appliedOverrideActionKinds IReadOnlyList<RestEndpointOverrideActionKind>?

The normalized action dimensions that materially changed the published endpoint answer when the selected override rule was not a runtime no-op.

requiredFeatureFlagIds IReadOnlyList<string>?

The required Cephalon feature-flag identifiers enforced at the REST boundary when any are available.

originalRequiredFeatureFlagIds IReadOnlyList<string>?

The original required Cephalon feature-flag identifiers before later endpoint-governance rewrites when the runtime can classify that source answer.

Properties

ApiVersionMajor

Gets the resolved public API major version when one is available.

public int? ApiVersionMajor { get; }

Property Value

int?

AppliedOverrideActionKinds

Gets the normalized action dimensions that materially changed the published endpoint answer when the selected override rule was not a runtime no-op.

public IReadOnlyList<RestEndpointOverrideActionKind> AppliedOverrideActionKinds { get; }

Property Value

IReadOnlyList<RestEndpointOverrideActionKind>

AppliedOverrideId

Gets the host-level override identifier when runtime governance actually changes the published endpoint answer.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? AppliedOverrideId { get; }

Property Value

string?

AuthoringStyle

Gets the normalized authoring style such as behavior-module-profile or minimal-api when the runtime can classify how the endpoint was published.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? AuthoringStyle { get; }

Property Value

string?

BehaviorId

Gets the stable behavior identifier when the endpoint dispatches through a Cephalon behavior.

public string? BehaviorId { get; }

Property Value

string?

BehaviorType

Gets the concrete behavior implementation type name when the endpoint dispatches through a Cephalon behavior and the runtime can classify that implementation identity.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? BehaviorType { get; }

Property Value

string?

BindingDescriptors

Gets the resolved request-binding descriptors when the endpoint exposes an explicit binding plan.

public IReadOnlyList<RestEndpointBindingDescriptor> BindingDescriptors { get; }

Property Value

IReadOnlyList<RestEndpointBindingDescriptor>

BindingFallbackMode

Gets the resolved request-binding fallback mode when the endpoint preserves deterministic request-binding behavior beyond the explicit binding plan, such as preserved source implicit-query fallback or preserved remaining request-body fallback.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public RestEndpointBindingFallbackMode? BindingFallbackMode { get; }

Property Value

RestEndpointBindingFallbackMode?

CandidateId

Gets the stable originating candidate identifier when this endpoint was published from the module-owned behavior projection pipeline.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? CandidateId { get; }

Property Value

string?

Description

Gets the resolved endpoint description when one is available.

public string? Description { get; }

Property Value

string?

EndpointName

Gets the resolved endpoint or operation name when one is available.

public string? EndpointName { get; }

Property Value

string?

Id

Gets the stable endpoint identifier.

public string Id { get; }

Property Value

string

MatchedOverrideIds

Gets the ordered override identifiers that matched this endpoint’s originating candidate before one winner was selected.

public IReadOnlyList<string> MatchedOverrideIds { get; }

Property Value

IReadOnlyList<string>

Metadata

Gets optional additive metadata. Stable REST endpoint keys are defined by .

public IReadOnlyDictionary<string, string> Metadata { get; }

Property Value

IReadOnlyDictionary<string, string>

Method

Gets the resolved HTTP method.

public string Method { get; }

Property Value

string

OpenApiDocumentName

Gets the resolved OpenAPI document name when one is available.

public string? OpenApiDocumentName { get; }

Property Value

string?

OriginalDescription

Gets the original endpoint description before later endpoint-governance rewrites when the runtime can classify that source answer.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? OriginalDescription { get; }

Property Value

string?

OriginalEndpointName

Gets the original endpoint or operation name before later endpoint-governance rewrites when the runtime can classify that source answer.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? OriginalEndpointName { get; }

Property Value

string?

OriginalProjection

Gets the original projection shape before later host-level overrides are applied when the endpoint was published from the module-owned behavior projection pipeline, including whether host governance was allowed to participate for that source route.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public RestEndpointCandidateProjectionDescriptor? OriginalProjection { get; }

Property Value

RestEndpointCandidateProjectionDescriptor?

OriginalRequiredCapabilityKey

Gets the original required Cephalon capability key before later endpoint-governance rewrites when the runtime can classify that source answer.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? OriginalRequiredCapabilityKey { get; }

Property Value

string?

OriginalRequiredFeatureFlagIds

Gets the original required Cephalon feature-flag identifiers before later endpoint-governance rewrites when the runtime can classify that source answer.

public IReadOnlyList<string> OriginalRequiredFeatureFlagIds { get; }

Property Value

IReadOnlyList<string>

OriginalSummary

Gets the original endpoint summary before later endpoint-governance rewrites when the runtime can classify that source answer.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? OriginalSummary { get; }

Property Value

string?

OverrideSelectionBasis

Gets the earliest decisive specificity rule that selected the winning override rule when one was resolved for this endpoint’s originating candidate.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public RestEndpointGovernanceRuleSelectionBasis? OverrideSelectionBasis { get; }

Property Value

RestEndpointGovernanceRuleSelectionBasis?

RelativePattern

Gets the resolved route pattern relative to the grouped publication boundary when the runtime can classify that source shape.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? RelativePattern { get; }

Property Value

string?

RequiredCapabilityKey

Gets the required Cephalon capability key enforced at the REST boundary when one is available.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? RequiredCapabilityKey { get; }

Property Value

string?

RequiredFeatureFlagIds

Gets the required Cephalon feature-flag identifiers enforced at the REST boundary when any are available.

public IReadOnlyList<string> RequiredFeatureFlagIds { get; }

Property Value

IReadOnlyList<string>

RouteGroupPrefix

Gets the resolved route-group prefix including the host REST prefix when the runtime can classify the grouped publication boundary that produced the endpoint.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? RouteGroupPrefix { get; }

Property Value

string?

RoutePattern

Gets the resolved route pattern including the host REST prefix.

public string RoutePattern { get; }

Property Value

string

SelectedOverrideActionKinds

Gets the normalized action dimensions declared by the selected override rule when one winning override rule was resolved for this endpoint’s originating candidate.

public IReadOnlyList<RestEndpointOverrideActionKind> SelectedOverrideActionKinds { get; }

Property Value

IReadOnlyList<RestEndpointOverrideActionKind>

SelectedOverrideId

Gets the selected override identifier when one winning override rule was resolved for this endpoint’s originating candidate, even if that winning rule became a runtime no-op.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? SelectedOverrideId { get; }

Property Value

string?

SkippedOverrideIds

Gets the ordered override identifiers that otherwise target this endpoint’s originating candidate but were skipped because the original projection did not allow host governance.

public IReadOnlyList<string> SkippedOverrideIds { get; }

Property Value

IReadOnlyList<string>

SkippedSuppressionIds

Gets the ordered suppression identifiers that otherwise target this endpoint’s originating candidate but were skipped because the original projection did not allow host governance.

public IReadOnlyList<string> SkippedSuppressionIds { get; }

Property Value

IReadOnlyList<string>

SourceId

Gets the stable source identity for the published endpoint when the runtime can classify the authored source shape behind that publication.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? SourceId { get; }

Property Value

string?

SourceKind

Gets the source kind that produced the endpoint.

public string SourceKind { get; }

Property Value

string

SourceModuleId

Gets the stable source-module identifier when one is known.

public string? SourceModuleId { get; }

Property Value

string?

SourceModuleVersion

Gets the declared source-module version when one is available.

public string? SourceModuleVersion { get; }

Property Value

string?

SourceModuleVersionMajor

Gets the parsed source-module major version when one is available.

public int? SourceModuleVersionMajor { get; }

Property Value

int?

Summary

Gets the resolved endpoint summary when one is available.

public string? Summary { get; }

Property Value

string?

Tags

Gets the resolved OpenAPI tags when any are published.

public IReadOnlyList<string> Tags { get; }

Property Value

IReadOnlyList<string>

TransportId

Gets the stable transport identifier that published the endpoint.

public string TransportId { get; }

Property Value

string