Class BackendForFrontendRestDocumentRuntimeDescriptor
Namespace: Cephalon.Abstractions.Transports
Assembly: Cephalon.Abstractions.dll
Describes one backend-for-frontend REST documentation surface materialized for one scope and one published OpenAPI document.
public sealed class BackendForFrontendRestDocumentRuntimeDescriptorInheritance
Section titled “Inheritance”object ← BackendForFrontendRestDocumentRuntimeDescriptor
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”These runtime descriptors keep client-aware REST documentation surfaces introspectable without turning OpenAPI JSON or Scalar page routes into a second source of truth outside the shared backend-for-frontend and REST runtime catalogs.
Constructors
Section titled “Constructors”BackendForFrontendRestDocumentRuntimeDescriptor(string, string, string, string, string, string, string, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?)
Section titled “ BackendForFrontendRestDocumentRuntimeDescriptor(string, string, string, string, string, string, string, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?, IReadOnlyList<string>?)”Creates a backend-for-frontend REST documentation runtime descriptor.
public BackendForFrontendRestDocumentRuntimeDescriptor(string id, string kind, string scopeId, string clientId, string documentName, string openApiPath, string scalarPath, IReadOnlyList<string>? bindingIds = null, IReadOnlyList<string>? sourceModuleIds = null, IReadOnlyList<string>? runtimeEndpointIds = null, IReadOnlyList<string>? restEndpointIds = null)Parameters
Section titled “Parameters”id string
The stable documentation-surface identifier.
kind string
The stable scope kind. Supported values are
scopeId string
The stable scope identifier. For binding-scoped surfaces this is the binding identifier, while client-scoped surfaces use the client identifier.
clientId string
The stable client identifier served by the materialized document.
documentName string
The resolved OpenAPI document name.
openApiPath string
The rooted OpenAPI JSON path for the filtered document.
scalarPath string
The rooted Scalar page path for the filtered document.
bindingIds IReadOnlyList<string>?
The backend-for-frontend binding identifiers that contribute to the materialized document. Binding-scoped surfaces contain one value, while client-scoped surfaces can aggregate more than one binding.
sourceModuleIds IReadOnlyList<string>?
The published-endpoint source-module identifiers represented in the materialized document.
runtimeEndpointIds IReadOnlyList<string>?
The client-aware runtime endpoint identifiers included in the materialized document.
restEndpointIds IReadOnlyList<string>?
The published REST endpoint identifiers included in the materialized document.
Fields
Section titled “Fields”BindingKind
Section titled “ BindingKind”The stable kind identifier used when the documentation surface is scoped to one binding.
public const string BindingKind = "binding"Field Value
Section titled “Field Value”ClientKind
Section titled “ ClientKind”The stable kind identifier used when the documentation surface is scoped to one client.
public const string ClientKind = "client"Field Value
Section titled “Field Value”Properties
Section titled “Properties”BindingId
Section titled “ BindingId”Gets the binding identifier when the surface is scoped to one binding.
public string? BindingId { get; }Property Value
Section titled “Property Value”BindingIds
Section titled “ BindingIds”Gets the contributing backend-for-frontend binding identifiers.
public IReadOnlyList<string> BindingIds { get; }Property Value
Section titled “Property Value”ClientId
Section titled “ ClientId”Gets the stable client identifier represented by the materialized document.
public string ClientId { get; }Property Value
Section titled “Property Value”DocumentName
Section titled “ DocumentName”Gets the resolved OpenAPI document name.
public string DocumentName { get; }Property Value
Section titled “Property Value”Gets the stable documentation-surface identifier.
public string Id { get; }Property Value
Section titled “Property Value”Gets the stable scope kind.
public string Kind { get; }Property Value
Section titled “Property Value”OpenApiPath
Section titled “ OpenApiPath”Gets the rooted OpenAPI JSON path for the filtered document.
public string OpenApiPath { get; }Property Value
Section titled “Property Value”RestEndpointIds
Section titled “ RestEndpointIds”Gets the included published REST endpoint identifiers.
public IReadOnlyList<string> RestEndpointIds { get; }Property Value
Section titled “Property Value”RuntimeEndpointIds
Section titled “ RuntimeEndpointIds”Gets the included client-aware runtime endpoint identifiers.
public IReadOnlyList<string> RuntimeEndpointIds { get; }Property Value
Section titled “Property Value”ScalarPath
Section titled “ ScalarPath”Gets the rooted Scalar page path for the filtered document.
public string ScalarPath { get; }Property Value
Section titled “Property Value”ScopeId
Section titled “ ScopeId”Gets the stable scope identifier.
public string ScopeId { get; }Property Value
Section titled “Property Value”SourceModuleIds
Section titled “ SourceModuleIds”Gets the published-endpoint source-module identifiers represented in the materialized document.
public IReadOnlyList<string> SourceModuleIds { get; }