Class EntryEndpoint

Namespace

TypedRest.CodeGeneration.Endpoints

Assembly

TypedRest.CodeGeneration.dll

Represent the top-level URI of an API.

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

Inheritance

object

Endpoint

EntryEndpoint

Implements

IEndpoint

IOpenApiSerializable

IOpenApiElement

IOpenApiExtension

Inherited Members

Endpoint.Uri

Endpoint.Description

Endpoint.Children

Endpoint.ParseChildren(OpenApiObject, IEndpointParser)

Endpoint.ResolveReferences(OpenApiComponents)

Endpoint.WriteBody(IOpenApiWriter, OpenApiSpecVersion)

Endpoint.SerializeAsV2(IOpenApiWriter)

Endpoint.SerializeAsV3(IOpenApiWriter)

Endpoint.ToString()

Properties

Kind

The kind/type of endpoint.

public override string Kind { get; }

Property Value

string

Methods

Parse(OpenApiObject, IEndpointParser)

Fills the endpoint with information parsed from an OpenAPI Object.

public override void Parse(OpenApiObject data, IEndpointParser parser)

Parameters

data OpenApiObject

The OpenAPI Object to parse.

parser IEndpointParser

The endpoint parser to use for parsing child objects.

Write(IOpenApiWriter, OpenApiSpecVersion)

Write out contents of custom extension

public override void Write(IOpenApiWriter writer, OpenApiSpecVersion specVersion)

Parameters

writer IOpenApiWriter

specVersion OpenApiSpecVersion

Version of the OpenAPI specification that that will be output.