OpenApiComponents Class

Definition

Components Object.

public class OpenApiComponents : Microsoft.OpenApi.Interfaces.IOpenApiExtensible, Microsoft.OpenApi.Interfaces.IOpenApiSerializable
type OpenApiComponents = class
    interface IOpenApiSerializable
    interface IOpenApiElement
    interface IOpenApiExtensible
Public Class OpenApiComponents
Implements IOpenApiExtensible, IOpenApiSerializable
Inheritance
OpenApiComponents
Implements

Constructors

OpenApiComponents()

Parameter-less constructor

OpenApiComponents(OpenApiComponents)

Initializes a copy of an OpenApiComponents object

Properties

Callbacks

An object to hold reusable OpenApiCallback Objects.

Examples

An object to hold reusable OpenApiExample Objects.

Extensions

This object MAY be extended with Specification Extensions.

Headers

An object to hold reusable OpenApiHeader Objects.

Links

An object to hold reusable OpenApiLink Objects.

Parameters

An object to hold reusable OpenApiParameter Objects.

RequestBodies

An object to hold reusable OpenApiRequestBody Objects.

Responses

An object to hold reusable OpenApiResponse Objects.

Schemas

An object to hold reusable OpenApiSchema Objects.

SecuritySchemes

An object to hold reusable OpenApiSecurityScheme Objects.

Methods

SerializeAsV2(IOpenApiWriter)

Serialize OpenApiComponents to Open Api v2.0.

SerializeAsV3(IOpenApiWriter)

Serialize OpenApiComponents to Open Api v3.0.

Extension Methods

Validate(IOpenApiElement, ValidationRuleSet)

Validate element and all child elements

Applies to