AppSurface Search
Section API Reference
API Reference Language: C# Component: Tests Audience: developer

CanaryConsumerFixture

Type

CanaryConsumerResult

Source

Represents the required compatibility core and selected operator action parsed by a public consumer.

Parameters

  • Name
    The exact registered canary name.
  • Status
    The defined lowercase wire status.
  • Ready
    The compatibility projection of whether Status is pass .
  • ReasonCode
    The optional response-only machine reason.
  • Action
    The operator action selected from the semantic envelope.
Type

CanaryEnvelopeConsumer

Source

Parses named-canary JSON by semantic field name without depending on property order or optional fields.

Method

Parse

CanaryConsumerResult Parse(string json)
Source

Parses and validates the required named-canary compatibility core.

Parameters

  • json
    The non-null JSON envelope to parse.

Returns

The validated core fields and selected operator action.

Exceptions

  • ArgumentNullException
    json is null.
  • JsonException
    A required field is absent, invalid, or semantically inconsistent.
Type

CanarySnapshotConsumerItem

Source

Represents one parsed aggregate snapshot item.

Parameters

  • Name
    The exact registered canary name.
  • Outcome
    The aggregate outcome: completed, failed, timed-out, or not-started.
  • Result
    The nested completed envelope, present only for completed items.
  • Code
    The safe aggregate diagnostic, present only for non-completed items.
Type

CanarySnapshotConsumerResult

Source

Represents the required aggregate snapshot compatibility core.

Parameters

  • Ready
    Whether every selected canary completed with pass evidence.
  • OverallTimedOut
    Whether the overall deadline stopped or canceled any selected evaluation.
  • ElapsedMilliseconds
    The non-negative aggregate elapsed time.
  • Results
    The ordered settled result for every selected canary.
Type

CanarySnapshotEnvelopeConsumer

Source

Parses the bounded aggregate snapshot by required field names and outcome-specific omission rules.

Method

Parse

CanarySnapshotConsumerResult Parse(string json)
Source

Parses and validates the aggregate snapshot compatibility core.

Parameters

  • json
    The non-null aggregate JSON envelope to parse.

Returns

The validated aggregate fields and settled item results.

Exceptions

  • ArgumentNullException
    json is null.
  • JsonException
    A required aggregate field or outcome-specific item shape is invalid.
Type

CanaryFixtureScenario

Source

Configures one public consumer-fixture evaluation.

Parameters

  • Status
    The result status returned by the evaluator.
  • Ambiguous
    Whether the forwarding fixture should return multiple ambiguous matches.
Type

StatusOnlyCanaryEvaluator

Source

Proves the original status-only result constructor remains usable from a non-friend assembly.

Parameters

  • scenario
    The evaluation scenario.
Type

ForwardingProofCanaryEvaluator

Source

Produces forwarding-proof evidence using only the public named-canary API.

Parameters

  • scenario
    The evaluation scenario.
Type

MigrationCompletionCanaryEvaluator

Source

Produces migration-completion evidence using only the public named-canary API.

Parameters

  • scenario
    The evaluation scenario.
Type

ForwardingProofSnapshot

Source

Describes application-owned forwarding proof returned by a protected proof store.

Parameters

  • Status
    The named-canary status derived by the application.
  • ObservedAt
    The time the proof was observed, when meaningful.
  • MatchedCount
    The number of matching proof records.
  • ReasonCode
    The stable, operator-safe reason code.
  • Summary
    The bounded, operator-safe summary.
  • CorrelationId
    The non-secret application correlation identifier.
Type

IForwardingProofReader

Source

Reads existing forwarding proof without triggering the workflow under evaluation.

Method

ReadAsync

ValueTask<ForwardingProofSnapshot> ReadAsync(string marker, DateTimeOffset freshSince, CancellationToken cancellationToken)
Source

Finds proof for the exact marker and freshness boundary supplied by the deploy caller.

Parameters

  • marker
    The required opaque, potentially sensitive deploy marker. Do not log, persist, expose in telemetry, or return the raw value in a response; use only a redacted or fingerprinted representation outside the proof lookup.
  • freshSince
    The required proof freshness boundary.
  • cancellationToken
    The request cancellation token.

Returns

The application-owned proof decision and bounded evidence.

Type

CompleteForwardingCanaryEvaluator

Source

Evaluates existing forwarding proof without triggering forwarding itself.

Remarks

During AddAppSurfaceCanary registration, call both RequireMarker() and RequireFreshSince() before mapping the endpoint. Missing required HTTP headers fail as ASCAN201 before evaluation. Direct evaluation validates marker and then freshness and throws InvalidOperationException with a registration diagnostic when either input is absent.

Type

GraphiteThemeWebConsumerFixture

Source

Provides the isolated Web-only consumer registration for the shared Graphite theme pair.

Remarks

This fixture intentionally owns the direct Web package reference. It does not reference AppSurface Docs so the registration proves that a Web consumer can configure and render the shared pair independently.

Method

AddGraphiteThemeWebConsumer

IServiceCollection AddGraphiteThemeWebConsumer(this IServiceCollection services)
Source

Registers Graphite as the System-mode default theme and enables its Web document provider.

Parameters

  • services
    The service collection receiving the Graphite Web registration.

Returns

The original services instance.

Exceptions

  • ArgumentNullException
    Thrown when services is null .
Enum

CanaryOperatorAction

Source

Lists the next operator action selected from a semantic named-canary envelope.