microsoftgraph / microsoftgraph/msgraph-metadata

Some report functions have wrong return types for their default response

Open
#304 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area: SDK priority:p2
Dominant language
XSLT
Stars
166
Forks
55
Avg merge
16h 12m
Merged PRs (30d)
14

Description

The service returns a JSON response for requests to /beta//reports/microsoft.graph.getFormsUserActivityUserDetail(period='D7'), yet the CSDL metadata says the function should return an Edm.Stream (file) type:

<Function Name="getFormsUserActivityUserDetail" IsBound="true">
  <Parameter Name="reportRoot" Type="graph.reportRoot" />
  <Parameter Name="date" Type="Edm.Date" Nullable="false" />
  <ReturnType Type="Edm.Stream" Nullable="false" />
</Function>
<Function Name="getFormsUserActivityUserDetail" IsBound="true">
  <Parameter Name="reportRoot" Type="graph.reportRoot" />
  <Parameter Name="period" Type="Edm.String" Nullable="false" Unicode="false" />
  <ReturnType Type="Edm.Stream" Nullable="false" />
</Function>

The response type mismatch leads to generated clients incorrectly handling responses for GET /beta//reports/microsoft.graph.getFormsUserActivityUserDetail(period='D7').

Related to https://github.com/microsoftgraph/msgraph-metadata/issues/223

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the CSDL definition for getFormsUserActivityUserDetail and compare both the date and period overloads with the response for the named beta endpoint. Read related issue #223 for context, then verify that the metadata and generated-client interpretation agree on the default response type. Done means the mismatch is corrected and the endpoint is represented as returning Edm.Stream.

Written by the indexing model from the issue text.

Assessment

Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.