Enum SseSpecVersion 

pub enum SseSpecVersion {
    V3_1,
    V3_2,
}

OpenAPI spec version used to render Server-Sent Event (SSE) responses in the generated document.

The runtime layer (crate::SseStream, crate::SseEventMeta) is version-agnostic — the only effect of this choice is the shape of the text/event-stream response in the rendered OpenAPI JSON and, with Self::V3_2, the document’s root openapi field.

Variant	Root openapi	SSE response key	Typical consumer
Self::V3_2	"3.2.0"	itemSchema	Scalar, Swagger UI 5.32+
Self::V3_1	"3.1.0"	schema	Redoc, openapi-generator, older tooling

Default is Self::V3_2 because Scalar — the UI this crate mounts — supports it natively and itemSchema is the documented way to describe SSE streams. Downstream consumers that still need 3.1 (Redoc, openapi-generator, anything on swagger-parser < 3.2) should opt out via ApiDocBuilder::sse_openapi_version.

Variants

V3_1

Emit OpenAPI 3.1-compatible SSE responses (schema under text/event-stream, root openapi left at utoipa’s default "3.1.0").

V3_2

Emit OpenAPI 3.2 SSE responses (itemSchema under text/event-stream, root openapi set to "3.2.0").

Trait Implementations

impl Clone for SseSpecVersion

fn clone(&self) -> SseSpecVersion

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SseSpecVersion

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SseSpecVersion

fn default() -> SseSpecVersion

Returns the “default value” for a type.

impl PartialEq for SseSpecVersion

fn eq(&self, other: &SseSpecVersion) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SseSpecVersion

impl Eq for SseSpecVersion

impl StructuralPartialEq for SseSpecVersion