OpenApiPagingExtension Class

Definition

Namespace:: Microsoft.OpenApi.MicrosoftExtensions

Assembly:: Microsoft.OpenApi.dll

Package:: Microsoft.OpenApi v3.1.1

Source:: OpenApiPagingExtension.cs

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.

Extension element for OpenAPI to add pageable information. Based of the AutoRest specification https://github.com/Azure/autorest/blob/main/docs/extensions/readme.md#x-ms-pageable

public class OpenApiPagingExtension : Microsoft.OpenApi.IOpenApiExtension

type OpenApiPagingExtension = class
    interface IOpenApiExtension

Public Class OpenApiPagingExtension
Implements IOpenApiExtension

Inheritance: Object
OpenApiPagingExtension

Implements: IOpenApiExtension

Constructors

Name	Description
OpenApiPagingExtension()

Properties

Name	Description
ItemName	The name of the property that provides the collection of pageable items.
Name	Name of the extension as used in the description.
NextLinkName	The name of the property that provides the next link (common: nextLink)
OperationName	The name (operationId) of the operation for retrieving the next page.

Methods

Name	Description
Parse(JsonNode)	Parse the extension from the raw IOpenApiAny object.
Write(IOpenApiWriter, OpenApiSpecVersion)	Write out contents of custom extension

Applies to