OpenApiCallback Class
Definition
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.
Callback Object: A map of possible out-of band callbacks related to the parent operation.
public class OpenApiCallback : Microsoft.OpenApi.Interfaces.IEffective<Microsoft.OpenApi.Models.OpenApiCallback>, Microsoft.OpenApi.Interfaces.IOpenApiExtensible, Microsoft.OpenApi.Interfaces.IOpenApiReferenceabletype OpenApiCallback = class
interface IOpenApiSerializable
interface IOpenApiElement
interface IOpenApiReferenceable
interface IOpenApiExtensible
interface IEffective<OpenApiCallback>Public Class OpenApiCallback
Implements IEffective(Of OpenApiCallback), IOpenApiExtensible, IOpenApiReferenceable- Inheritance
-
OpenApiCallback
- Implements
Constructors
| OpenApiCallback() |
Parameter-less constructor |
| OpenApiCallback(OpenApiCallback) |
Initializes a copy of an OpenApiCallback object |
Properties
| Extensions |
This object MAY be extended with Specification Extensions. |
| PathItems |
A Path Item Object used to define a callback request and expected responses. |
| Reference |
Reference pointer. |
| UnresolvedReference |
Indicates if object is populated with data or is just a reference to the data |
Methods
| AddPathItem(RuntimeExpression, OpenApiPathItem) |
Add a OpenApiPathItem into the PathItems. |
| GetEffective(OpenApiDocument) |
Returns an effective OpenApiCallback object based on the presence of a $ref |
| SerializeAsV2(IOpenApiWriter) |
Serialize OpenApiCallback to Open Api v2.0 |
| SerializeAsV2WithoutReference(IOpenApiWriter) |
Serialize to OpenAPI V2 document without using reference. |
| SerializeAsV3(IOpenApiWriter) |
Serialize OpenApiCallback to Open Api v3.0 |
| 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. |