SseBroadcastOptions record
Customization options for the OpenAPI metadata generated for the SSE broadcast endpoint.
public record SseBroadcastOptions
Public Members
| name | description |
|---|---|
| SseBroadcastOptions() | The default constructor. |
| static Default { get; } | Gets a default configuration for the SSE broadcast OpenAPI metadata. |
| ContentType { get; set; } | Response content type for the SSE stream (default: text/event-stream). |
| Description { get; set; } | OpenAPI description for the endpoint. |
| DocId { get; set; } | Customization options for the OpenAPI metadata generated for the SSE broadcast endpoint. |
| ItemSchemaFormat { get; set; } | Optional OpenAPI schema format for the stream payload (e.g. “uuid”, “date-time”). |
| ItemSchemaType { get; set; } | OpenAPI schema type for the stream payload items (default: string). |
| KeepAliveSeconds { get; set; } | The path for the SSE broadcast endpoint. |
| OperationId { get; set; } | OpenAPI operationId for the endpoint. |
| Path { get; set; } | The path for the SSE broadcast endpoint. |
| ResponseDescription { get; set; } | Response description shown in OpenAPI. |
| SkipOpenApi { get; set; } | If true, the OpenAPI documentation for this endpoint will be skipped. |
| StatusCode { get; set; } | Status code used for the SSE response (default: 200). |
| Summary { get; set; } | OpenAPI summary for the endpoint. |
| Tags { get; set; } | OpenAPI tags for the endpoint. |
| const DefaultDescription | The default description for the SSE broadcast endpoint. |
| const DefaultKeepAliveSeconds | The default keep-alive interval in seconds for the SSE connection. |
| const DefaultOperationId | The default operationId for the SSE broadcast endpoint. |
| const DefaultPath | The default path for the SSE broadcast endpoint. |
| const DefaultResponseDescription | The default response description for the SSE broadcast endpoint. |
| const DefaultSummary | The default summary for the SSE broadcast endpoint. |
| const DefaultTag | The default tag for the SSE broadcast endpoint. |