SignalROptions record

Customization options for the OpenAPI metadata generated for the SignalR hub endpoint.

public record SignalROptions

Public Members

name description
SignalROptions() The default constructor.
static Default { get; } Gets a default configuration for the SignalR hub OpenAPI metadata.
Description { get; set; } OpenAPI description for the endpoint.
DocId { get; set; } Customization options for the OpenAPI metadata generated for the SignalR hub endpoint.
HubName { get; set; } Name of the SignalR hub.
IncludeNegotiateEndpoint { get; set; } If true, includes the SignalR negotiate endpoint in OpenAPI documentation.
Path { get; set; } The path for the SignalR hub endpoint.
SkipOpenApi { get; set; } If true, the OpenAPI documentation for this endpoint will be skipped.
Summary { get; set; } OpenAPI summary for the endpoint.
Tags { get; set; } OpenAPI tags for the endpoint.
const DefaultDescription The default description for the SignalR hub endpoint.
const DefaultHubName The default name for the SignalR hub.
const DefaultPath The default path for the SignalR hub endpoint.
const DefaultSummary The default summary for the SignalR hub endpoint.
const DefaultTag The default OpenAPI tags for the SignalR hub endpoint.

See Also