Class CollectionEndpoint

Namespace

TypedRest.CodeGeneration.Endpoints.Generic

Assembly

TypedRest.CodeGeneration.dll

Endpoint for a collection of entities addressable as ElementEndpoints.

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

Inheritance

object

Endpoint

CollectionEndpoint

Implements

IEndpoint

IOpenApiSerializable

IOpenApiElement

IOpenApiExtension

Derived

StreamingCollectionEndpoint

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

Element

A template for child endpoints addressable by ID.

public ElementEndpoint? Element { get; set; }

Property Value

ElementEndpoint

Kind

The kind/type of endpoint.

public override string Kind { get; }

Property Value

string

Schema

Schema describing the representation of individual elements in the collection.

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.