IOpenApiReferenceable Interface

Reference

Definition

Namespace:: Microsoft.OpenApi.Interfaces

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v1.6.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents an Open API element is referenceable.

public interface IOpenApiReferenceable : Microsoft.OpenApi.Interfaces.IOpenApiSerializable

type IOpenApiReferenceable = interface
    interface IOpenApiSerializable
    interface IOpenApiElement

Public Interface IOpenApiReferenceable
Implements IOpenApiSerializable

Derived: Microsoft.OpenApi.Models.OpenApiCallback

Microsoft.OpenApi.Models.OpenApiExample

Microsoft.OpenApi.Models.OpenApiHeader

Microsoft.OpenApi.Models.OpenApiLink

Microsoft.OpenApi.Models.OpenApiParameter

More…

Implements: IOpenApiElement IOpenApiSerializable

Properties

Reference	Reference object.
UnresolvedReference	Indicates if object is populated with data or is just a reference to the data

Methods

SerializeAsV2(IOpenApiWriter)	Serialize Open API element to v2.0. (Inherited from IOpenApiSerializable)
SerializeAsV2WithoutReference(IOpenApiWriter)	Serialize to OpenAPI V2 document without using reference.
SerializeAsV3(IOpenApiWriter)	Serialize Open API element to v3.0. (Inherited from IOpenApiSerializable)
SerializeAsV3WithoutReference(IOpenApiWriter)	Serialize to OpenAPI V3 document without using reference.

Extension Methods

Validate(IOpenApiElement, ValidationRuleSet)	Validate element and all child elements
ResolveReference(IOpenApiReferenceable, JsonPointer)	Resolves a JSON Pointer with respect to an element, returning the referenced element.

Applies to

Share via