microsoftgraph / microsoftgraph/msgraph-sdk-java
SDK returns site `name` inconsistently: sometimes same as `displayName` instead of correct value and sometimes the correct value
まだ誰も着手していません。
- 主要言語
- Java
- スター
- 444
- フォーク
- 154
- 平均マージ
- 18時間 28分
- マージ済み PR(30日)
- 4
説明
Describe the bug
Doing different site lists returns different values in the name field.
Doing a search limited to a smaller set of sites returns the correct / expected value in the name field.
Doing a list of all sites returns the displayName in the name field.
Expected behavior
The SDK should return values in the name field consistently.
How to reproduce
- Return sites using this code:
graphClient.sites().get()
The return value in the MSGraph API response is:
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#sites",
"value": [
{
"createdDateTime": "2025-03-31T16:03:30Z",
"id": "mytenant.sharepoint.com,d0536e25-0c9c-4a9c-b879-cefdc46dc82d,9f7ed8fa-4175-4a6c-80ae-2e19f19f5948",
"name": "Test Site Many Names Site Info Name",
"webUrl": "https://mytenant.sharepoint.com/sites/TestSiteManyNames",
"displayName": "Test Site Many Names Site Info Name",
"isPersonalSite": false,
"siteCollection": {
"hostname": "mytenant.sharepoint.com"
},
"root": {}
},
{
"createdDateTime": "2025-02-23T17:46:07Z",
"id": "mytenant.sharepoint.com,c65bebd0-1a50-4d31-8ef8-51d067f95ca8,00577abf-eccb-44ae-ba22-1542cc3249e3",
"name": "Apps",
"webUrl": "https://mytenant.sharepoint.com/sites/appcatalog",
"displayName": "Apps",
"isPersonalSite": false,
"siteCollection": {
"hostname": "mytenant.sharepoint.com"
},
"root": {}
},
{
"createdDateTime": "2025-02-20T01:38:39Z",
"id": "mytenant.sharepoint.com,09ed6654-3505-4561-a2e7-8d2776480abb,4d074863-0c38-46e8-b60a-156446947967",
"name": "Team Site",
"webUrl": "https://mytenant.sharepoint.com/sites/contentTypeHub",
"displayName": "Team Site",
"isPersonalSite": false,
"siteCollection": {
"hostname": "mytenant.sharepoint.com"
},
"root": {}
},
{
"createdDateTime": "2025-02-20T01:38:32Z",
"id": "mytenant.sharepoint.com,ff2ad436-8677-4cfb-91d6-67d7344474a0,9fda6e4f-a65f-4cc1-ba2b-3d11d30dccd7",
"webUrl": "https://mytenant.sharepoint.com/search",
"isPersonalSite": false,
"siteCollection": {
"hostname": "mytenant.sharepoint.com"
},
"root": {}
},
{
"createdDateTime": "2025-02-20T01:37:56Z",
"id": "mytenant-my.sharepoint.com,5a898f19-31d7-4f38-abd7-d7342535cb7d,6baab3c4-1e9a-4c52-bf5d-49f46471726d",
"name": "My Name",
"webUrl": "https://mytenant-my.sharepoint.com/personal/myid_mytenant_com",
"displayName": "My Name",
"isPersonalSite": true,
"siteCollection": {
"hostname": "mytenant-my.sharepoint.com"
},
"root": {}
},
{
"createdDateTime": "2025-02-20T01:35:31Z",
"id": "mytenant.sharepoint.com,e24ba8dd-ec64-4930-b9d3-6a4a542d4114,e69c54e0-3df2-4d80-a2f9-48f75cc5a825",
"name": "All Company",
"webUrl": "https://mytenant.sharepoint.com/sites/allcompany",
"displayName": "All Company",
"isPersonalSite": false,
"siteCollection": {
"hostname": "mytenant.sharepoint.com"
},
"root": {}
},
{
"createdDateTime": "2025-02-20T01:32:07Z",
"id": "mytenant.sharepoint.com,e3bb292d-6bce-419a-8f50-c98b996d3b34,965c6dcd-d66f-4f05-b23a-5274bd961199",
"name": "Communication site",
"webUrl": "https://mytenant.sharepoint.com/",
"displayName": "Communication site",
"isPersonalSite": false,
"siteCollection": {
"hostname": "mytenant.sharepoint.com"
},
"root": {}
}
]
}
- Return just one of the above sites, example here is the one with "Many" in the display name (Kotlin):
graphClient.sites().get {
it.queryParameters.search = "Many"
}
and the return value in the MSGraph API response is now:
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#sites",
"value": [
{
"createdDateTime": "2025-03-31T16:03:30Z",
"description": "Test Site Many Names Description",
"id": "mytenant.sharepoint.com,d0536e25-0c9c-4a9c-b879-cefdc46dc82d,9f7ed8fa-4175-4a6c-80ae-2e19f19f5948",
"lastModifiedDateTime": "2025-03-31T16:03:38Z",
"name": "TestSiteManyNames",
"webUrl": "https://mytenant.sharepoint.com/sites/TestSiteManyNames",
"displayName": "Test Site Many Names Site Info Name",
"root": {},
"siteCollection": {
"hostname": "mytenant.sharepoint.com"
}
}
]
}
Note the difference in the Name fields. The first response contains "name": "Test Site Many Names Site Info Name" while the second response contains "name": "TestSiteManyNames".
Note also that the second response does not contain isPersonalSite: false (even if isPersonalSite is requested explicitly via $select).
SDK Version
6.33.0
Latest version known to work for scenario above?
No response
Known Workarounds
Extract the last path segment from the webUrl field to get the name consistently, after filtering out the root site.
Debug output
No response
Configuration
No response
Other information
No response
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
graphClient.sites().get() のエントリポイントから開始し、SDK が取得された 2 つの Microsoft Graph レスポンスをどのように表現しているかを、name と isPersonalSite を含めて比較します。報告されている一覧レスポンスと検索レスポンスを使用して期待される一貫性を定義します。完了条件は、SDK が両方のフィールドに対して安定した値を公開するか、upstream の制限を明確に文書化することです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- java, kotlin
- 領域
- api, backend
- issue の種類
- バグ
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 42/100