Pageable endpoints with missing schema information

Mô tả

The current OpenAPI file for the beta MSGraph endpoint results in descriptions with empty response information for some endpoints. An example is shown below.

Assemblies affected

Which assemblies and versions are known to be affected? 1.0.9.0

Expected result

For endpoints that have paging information (x-ms-pageable), the response shape should be known for kiota to generate paging code. @baywet also says that this endpoint isn't actually pageable. See https://github.com/microsoft/kiota/issues/4207#issuecomment-1956755281

Actual result

Failing snippet


openapi: 3.0.1
# ...
paths:
  '/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/graph.onAttributeCollectionExternalUsersSelfServiceSignUp':
    description: Casts the previous resource to onAttributeCollectionExternalUsersSelfServiceSignUp.
    get:
      tags:
        - identity.authenticationEventsFlow
      summary: Get the items of type microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp in the microsoft.graph.onAttributeCollectionHandler collection
      operationId: identity.authenticationEventsFlows.GetOnAttributeCollection.AsOnAttributeCollectionExternalUsersSelfServiceSignUp
      responses:
        2XX: { }
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
    parameters:
      - name: authenticationEventsFlow-id
        in: path
        description: The unique identifier of authenticationEventsFlow
        required: true
        schema:
          type: string
        x-ms-docs-key-type: authenticationEventsFlow

Additional detail

Bắt đầu từ đâu

Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.

Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.

Fork repository và làm thay đổi trên một nhánh.

Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách tái hiện endpoint beta MSGraph được cung cấp từ quy trình tạo OpenAPI và kiểm tra cách phản hồi 2XX trống cùng siêu dữ liệu x-ms-pageable của endpoint được phát ra. Kiểm tra cuộc thảo luận Kiota liên quan để xác định trạng thái pageable của endpoint. Được xem là hoàn tất khi mô tả được tạo có thông tin phản hồi như dự kiến, hoặc endpoint không còn được đánh dấu là pageable nếu xác nhận rằng đó là hành vi đúng.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ

csharp, openapi

Lĩnh vực

api

Loại issue

Lỗi

Độ khó

3/5

Thời gian dự kiến

1-2 ngày

Mức độ hoạt động

Đình trệ

Độ rõ ràng

Khá rõ ràng

Mức phù hợp với người mới

35/100