dataconnect-solutions icon indicating copy to clipboard operation
dataconnect-solutions copied to clipboard

BasicDataSet_v0.SharePointPermissions_v1 dataset inaccurate documentation and samples

Open pxmonti opened this issue 6 months ago • 0 comments

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.

pxmonti avatar Aug 23 '24 16:08 pxmonti