Class UploadEndpoint

Endpoint that accepts binary uploads.

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

Implements: IEndpoint

IOpenApiSerializable

IOpenApiElement

IOpenApiExtension

Inherited Members: Endpoint.Uri

Endpoint.Description

Endpoint.Children

Endpoint.ParseChildren(OpenApiObject, IEndpointParser)

Endpoint.ResolveReferences(OpenApiComponents)

Endpoint.Write(IOpenApiWriter, OpenApiSpecVersion)

Endpoint.SerializeAsV2(IOpenApiWriter)

Endpoint.SerializeAsV3(IOpenApiWriter)

Endpoint.ToString()

Properties

The name of the form field to place the uploaded data into. Leave empty for upload of raw bodies.

public string? FormField { get; set; }

The kind/type of endpoint.

public override string Kind { get; }

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.

Writes this endpoint description to an OpenAPI document.

protected override void WriteBody(IOpenApiWriter writer, OpenApiSpecVersion specVersion)