Pageable endpoints with missing schema information

オープン

#496 2024年2月21日に作成コメント 0 件リアクション 0 件担当者 0 名 GitHub で見る

まだ誰も着手していません。

type:bug

主要言語: C#
スター: 240
フォーク: 70
平均マージ: 7時間 59分
マージ済み PR（30日）: 13

説明

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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
リポジトリをフォークし、ブランチを切って変更します。
issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、OpenAPI 生成フローから提供された beta MSGraph エンドポイントを再現し、その空の 2XX レスポンスと x-ms-pageable メタデータがどのように出力されるかを確認します。関連する Kiota の議論を確認し、エンドポイントの pageable ステータスを調べます。生成された説明に意図したレスポンス情報が含まれているか、またはそれが正しい動作であると確認された場合にエンドポイントが pageable としてマークされなくなっていれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック: csharp, openapi
領域: api
issue の種類: バグ
難易度: 3/5
見積もり時間: 1〜2日
活発さ: 停滞
明瞭さ: おおむね明確
初心者へのやさしさ: 35/100