Table of Contents

Class ConsumerEndpoint

Namespace
TypedRest.CodeGeneration.Endpoints.Rpc
Assembly
TypedRest.CodeGeneration.dll

RPC endpoint that takes an entity as input when invoked.

public class ConsumerEndpoint : Endpoint, IEndpoint, IOpenApiSerializable, IOpenApiElement, IOpenApiExtension
Inheritance
object
ConsumerEndpoint
Implements
Inherited Members

Properties

Kind

The kind/type of endpoint.

public override string Kind { get; }

Property Value

string

Schema

Schema describing the entity taken as input.

public OpenApiSchema? Schema { get; set; }

Property Value

OpenApiSchema

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.

ResolveReferences(OpenApiComponents)

Resolves OpenApiReferences.

public override void ResolveReferences(OpenApiComponents components)

Parameters

components OpenApiComponents

The components that references can point to.

WriteBody(IOpenApiWriter, OpenApiSpecVersion)

Writes this endpoint description to an OpenAPI document.

protected override void WriteBody(IOpenApiWriter writer, OpenApiSpecVersion specVersion)

Parameters

writer IOpenApiWriter

The write to write to.

specVersion OpenApiSpecVersion

The OpenAPI Spec version to use.