Placement of `@OData.NextLink` property breaks paging support for AutoREST based code generators

[peombwa]

Starting in Microsoft.OpenApi.OData v1.1.0, @OData.NextLink property of response collection schema was moved to a base collection pagination and count responses schema. Unfortunately, AutoREST does not support this representation at the moment. See how AutoREST supports paging at https://github.com/microsoftgraph/microsoft-graph-devx-api/issues/199.

Assemblies affected

Microsoft.OpenApi.OData v1.1.0

Expected result

paths:
  /applications:
    get:
      tags:
        - applications.application
      summary: List applications
      operationId: applications.application_ListApplication
      responses:
        '200':
          $ref: '#/components/responses/microsoft.graph.applicationCollectionResponse'
        default:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink' # REQUIRED: property name for next page URL
        operationName: listMore
      x-ms-docs-operation-type: operation
components:
  responses:
    microsoft.graph.applicationCollectionResponse:
      description: Retrieved collection
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.applicationCollectionResponse'
  schemas:
    microsoft.graph.applicationCollectionResponse:
      title: Collection of application
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.application'
        '@odata.nextLink':   # REQUIRED: next page URL (referred to by "nextLinkName")
          type: string
      additionalProperties:
        type: object

Actual result

paths:
  /applications:
    get:
      tags:
        - applications.application
      summary: List applications
      operationId: applications.application_ListApplication
      responses:
        '200':
          $ref: '#/components/responses/microsoft.graph.applicationCollectionResponse'
        default:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink' # REQUIRED: property name for next page URL
        operationName: listMore
      x-ms-docs-operation-type: operation
components:
  responses:
    microsoft.graph.applicationCollectionResponse:
      description: Retrieved collection
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.applicationCollectionResponse'
  schemas:
    microsoft.graph.applicationCollectionResponse:
      title: Collection of application
      type: object
      allOf:
        - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
        - type: object
          properties:
            value:
              type: array
              items:
                $ref: '#/components/schemas/microsoft.graph.application'
          additionalProperties:
            type: object
      additionalProperties:
        type: object
    BaseCollectionPaginationCountResponse:
      title: Base collection pagination and count responses
      type: object
      properties:
        '@odata.nextLink': # NOT supported by AutoREST.
          type: string
          nullable: true
      additionalProperties:
        type: object

[baywet]

Instead of reverting the change, could we drive it with an option? This is saving a lot of duplication on the Kiota based SDKs

[peombwa]

Having a converting setting to control the placement of @OData.NextLink sounds like a solid plan! Let's get this prioritized given its time sensitivity (Ignite).

[baywet]

CC @CarolKigoonya