Class StreamingEndpoint

Endpoint for a stream of entities using a persistent HTTP connection.

public class StreamingEndpoint : Endpoint, IEndpoint, IOpenApiSerializable, IOpenApiElement, IOpenApiExtension

Implements: IEndpoint

IOpenApiSerializable

IOpenApiElement

IOpenApiExtension

Inherited Members: Endpoint.Uri

Endpoint.Description

Endpoint.Children

Endpoint.ParseChildren(OpenApiObject, IEndpointParser)

Endpoint.Write(IOpenApiWriter, OpenApiSpecVersion)

Endpoint.SerializeAsV2(IOpenApiWriter)

Endpoint.SerializeAsV3(IOpenApiWriter)

Endpoint.ToString()

Properties

The kind/type of endpoint.

public override string Kind { get; }

Schema describing the representation of individual elements in the stream.

public OpenApiSchema? Schema { get; set; }

The character sequence used to detect that a new element starts in an HTTP stream.

public string? Separator { get; set; }

Fills the endpoint with information parsed from an OpenAPI Object.

public override void Parse(OpenApiObject data, IEndpointParser parser)

data OpenApiObject: The OpenAPI Object to parse.
parser IEndpointParser: The endpoint parser to use for parsing child objects.

public override void ResolveReferences(OpenApiComponents components)

components OpenApiComponents: The components that references can point to.

Writes this endpoint description to an OpenAPI document.

protected override void WriteBody(IOpenApiWriter writer, OpenApiSpecVersion specVersion)