Interface IBackendForFrontendRestDocumentRuntimeCatalog
Namespace: Cephalon.Abstractions.Transports
Assembly: Cephalon.Abstractions.dll
Exposes the client-aware REST documentation surfaces derived from the active backend-for-frontend bindings and published REST endpoint catalog.
public interface IBackendForFrontendRestDocumentRuntimeCatalogRemarks
Section titled “Remarks”This runtime surface keeps filtered OpenAPI JSON and Scalar materialization aligned with the existing backend-for-frontend binding and REST endpoint runtime catalogs instead of introducing a host-only documentation registry.
Properties
Section titled “Properties”Documents
Section titled “ Documents”Gets all client-aware REST documentation surfaces visible to the current runtime.
IReadOnlyList<BackendForFrontendRestDocumentRuntimeDescriptor> Documents { get; }Property Value
Section titled “Property Value”IReadOnlyList<BackendForFrontendRestDocumentRuntimeDescriptor>
Methods
Section titled “Methods”GetByBindingId(string)
Section titled “ GetByBindingId(string)”Gets all binding-scoped REST documentation surfaces owned by the requested binding.
IReadOnlyList<BackendForFrontendRestDocumentRuntimeDescriptor> GetByBindingId(string bindingId)Parameters
Section titled “Parameters”bindingId string
The backend-for-frontend binding identifier to filter by.
Returns
Section titled “Returns”IReadOnlyList<BackendForFrontendRestDocumentRuntimeDescriptor>
The matching runtime descriptors, or an empty list when the binding is not active.
GetByClientId(string)
Section titled “ GetByClientId(string)”Gets all client-scoped REST documentation surfaces owned by the requested client.
IReadOnlyList<BackendForFrontendRestDocumentRuntimeDescriptor> GetByClientId(string clientId)Parameters
Section titled “Parameters”clientId string
The client identifier to filter by.
Returns
Section titled “Returns”IReadOnlyList<BackendForFrontendRestDocumentRuntimeDescriptor>
The matching runtime descriptors, or an empty list when the client is not active.
GetById(string)
Section titled “ GetById(string)”Gets one client-aware REST documentation surface by its stable identifier.
BackendForFrontendRestDocumentRuntimeDescriptor? GetById(string documentId)Parameters
Section titled “Parameters”documentId string
The documentation-surface identifier to resolve.
Returns
Section titled “Returns”BackendForFrontendRestDocumentRuntimeDescriptor?
The matching runtime descriptor, or null when it is not active.