Interface IEndpoint

Represents a TypedRest endpoint.

public interface IEndpoint : IOpenApiSerializable, IOpenApiElement, IOpenApiExtension

Inherited Members: IOpenApiSerializable.SerializeAsV3(IOpenApiWriter)

IOpenApiSerializable.SerializeAsV2(IOpenApiWriter)

IOpenApiExtension.Write(IOpenApiWriter, OpenApiSpecVersion)

Properties

The child endpoints of this endpoint.

IDictionary<string, IEndpoint> Children { get; }

A short description of the endpoint.

string? Description { get; set; }

The kind/type of endpoint.

string Kind { get; }

The relative URI of the endpoint.

string? Uri { get; set; }

Fills the endpoint with information parsed from an OpenAPI Object.

void Parse(OpenApiObject data, IEndpointParser parser)

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

void ResolveReferences(OpenApiComponents components)

components OpenApiComponents: The components that references can point to.