microsoft / microsoft/powerbi-powershell

Get Dataset Refresh History response contains filed "Id" which does not exist in the documentation

Open
#380 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
413
Forks
134
Avg merge
33m
Merged PRs (30d)
1

Description

I should, according to the documentation, expect these keys in the refresh history response:
(https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/get-refresh-history-in-group, https://learn.microsoft.com/en-us/rest/api/power-bi/datasets/get-refresh-history)

'endTime', 'refreshType', 'requestId', 'serviceExceptionJson', 'startTime', 'status'

However, currently, I am also getting an 'id' field where the value is of type int, there is no information on what this field is.

Even if it is intentional, why doesn't it use datatype str instead of int to stay consistent with the rest of the api.

Contributor guide

Open the contributing guide

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

Compare the linked Microsoft REST API documentation with the actual refresh-history response described in the issue, including the undocumented integer id field. Confirm whether id should be documented and what it represents, then update the relevant documentation or record the required API correction; done means the documented response matches the observed contract.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
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.