OneDrive / samples

Contains samples, scenarios, and guidance for integrating with OneDrive and SharePoint drives, drive items, and files.
MIT License
49 stars 48 forks source link

File Browser: Browser Configuration Schema in documentation differs from code sample #56

Closed ottD closed 3 months ago

ottD commented 9 months ago

Issue description The File Browser configuration schema in the documentation differs from the schema used in the typescript-react sample.. In the documentation, the entry parameter includes the authentication, breadcrumb, commands etc. parameters whereas in the actual code sample these are separate entries in the JSON schema.

Also note, that the link to the code sample from the documentation page is broken.

Steps To Reproduce Inspect the Browser Configuration schema in the documentation and compare it to the schema used in the typescript-react File Browser sample code. Note that in the documentation the authenticationand breadcrumbparameter are under the entryparameter whereas this is not the case in the code sample where they are at the same level as the entryparameter. It looks like the Browser Configuration Schema in the documentation is not correct.

Expected behavior Code sample corresponds to documentation and documentation links correctly to sample repo.

Screenshots code sample:

image

Schema used in documentation:

entry: {
        sharePoint?: {
            byPath?: {
                web?: string;
                list?: string;
                folder?: string;
                fallbackToRoot?: boolean;
            };
        };

        oneDrive?: {
            files?: {
                folder?: string;
                fallbackToRoot?: boolean;
            };
        };
        authentication: {
            claimsChallenge?: {
                enabled?: boolean;
            };
        };
        breadcrumb?: {

            root?: {
                sharePoint?: {
                    byPath?: {
                        web?: string;
                        list?: string;
                        folder?: string;
                    };
                };
            };
        };
JCrew0 commented 6 months ago

@ottD Sorry for the delay here as well, hope this hasn't been blocking you! I've logged this internally for myself and will go make edits when I get a chance. Thanks!

JCrew0 commented 6 months ago

I have this PR that I've been trying to get merged for a bit: https://github.com/OneDrive/onedrive-api-docs/pull/1762