microsoftgraph / microsoftgraph/dataconnect-solutions

BasicDataSet_v0.SharePointPermissions_v1 dataset inaccurate documentation and samples

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

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
72
Forks
52
PR merge metrics
No merged PRs in 30d

Description

Describe the bug
The documentation of the dataset BasicDataSet_v0.SharePointPermissions_v1 has 2 issues:

  1. The ItemType field in the documentation states it only reports the values "Site", "Folder", "File". However, the extracted data have also other values for the fields, such as: "Web", "LIst", "SiteAdmin".

To Reproduce
Steps to reproduce the behavior:

  1. Run a ADF pipeline that extracts the sharepoint permissions dataset.
  2. Open the produced JSON file.
  3. Check the returned values for the ItemType field.

Expected behavior
Please, keep the documentation of the datasets in sync with the dataset that MGDC returns, or it will be very difficult to implement applications that rely on MGDC datasets.

  1. The provided sample section is not correctly formatted: the "Sample datasets" section shows some JSON objects as they would be returned by the MGDC dataset itself. However, this section is not well formatted. There are rows with multiple JSON object in them.

To reproduce
Simply browse the section in the documentation of the dataset:

  1. Scroll down to the section
  2. Scroll horizontally inside the section
  3. Not all rows have the same length
  4. The longer lines have multiple JSON object one after the other in the same line

Expected behavior
The section should show 1 JSON object per line.

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

Open the documentation for the BasicDataSet_v0.SharePointPermissions_v1 dataset and review the ItemType field and its Sample datasets section. Confirm the returned values against a produced JSON file from an Azure Data Factory extraction. Done means the documentation includes the observed ItemType values and the sample displays one JSON object per line.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.