taers232c / GAMADV-XTD3

Command line tool to manage Google Workspace
687 stars 86 forks source link

[Documentation] Missing / Wrong BNF syntax for Update Sheet / Doc #400

Closed jay-eleven closed 3 months ago

jay-eleven commented 4 months ago

Hi Ross!

I was just reviewing your recent addition in 6.71.07 Added command to upload changes to Google Docs and found some inconsistencies.

I already updated the Wiki with some minor typos but I think there's still stuff missing.

Upload changes to Google Documents

gam <UserTypeEntity> update document <DriveFileEntity>
        ((json [charset <Charset>] <SpreadsheetJSONUpdateRequest>) |
         (json file <FileName> [charset <Charset>]))
        [formatjson]

<SpreadsheetJSONUpdateRequest> is not defined on this page. So I browsed to Users - Spreadsheets and, sure enough, I found the definition:

<SpreadsheetJSONUpdateRequest> ::=
        '{"requests": [{<Request>}(,{<Request>})], "includeSpreadsheetInResponse": true|false,
          "responseRanges": ["<SpreadsheetRange>"(,"<SpreadsheetRange>")],
          "responseIncludeGridData": true|false}

This raised a new question as I couldn't find the definition of <Request>.

Furthermore, I don't think <SpreadsheetJSONUpdateRequest> is suitable for gam update document (Docs) as it contains Sheets specific options which don't apply to Docs: includeSpreadsheetInResponse, responseRanges and responseIncludeGridData, so a new <DocumentJSONUpdateRequest> is needed. 🤓

So, to sum up, I think the following symbols are needed:

  1. Create a new <DocumentJSONUpdateRequest> for gam update document
  2. Define <Request> (or <DocumentRequest>) for <DocumentJSONUpdateRequest>
  3. Define <Request> (or <SpreadsheetRequest>) for <SpreadsheetJSONUpdateRequest>

As always, if I can be of any assistance, just let me know. Thanks for your hard work!

taers232c commented 4 months ago

Thanks. I made some updates.

Ross Scroggs @.***

On Mar 1, 2024, at 10:18 AM, Jay @.***> wrote:

Hi Ross!

I was just reviewing your recent addition in 6.71.07 Added command to upload changes to Google Docs https://github.com/taers232c/GAMADV-XTD3/wiki/Users-Drive-Files-Manage#upload-changes-to-google-documents and found some inconsistencies.

I already updated the Wiki with some minor typos but I think there's still stuff missing.

Upload changes to Google Documents https://github.com/taers232c/GAMADV-XTD3/wiki/Users-Drive-Files-Manage#upload-changes-to-google-documents gam update document ((json [charset ] ) | (json file [charset ])) [formatjson]

is not defined on this page. So I browsed to Users - Spreadsheets and, sure enough, I found the definition : ::= '{"requests": [{}(,{})], "includeSpreadsheetInResponse": true|false, "responseRanges": [""(,"")], "responseIncludeGridData": true|false} This raised a new question as I couldn't find the definition of . Furthermore, I don't think is suitable for gam update document (Docs) as it contains Sheets specific options which don't apply to Docs: includeSpreadsheetInResponse, responseRanges and responseIncludeGridData, so a new is needed. 🤓 So, to sum up, I think the following symbols are needed: Create a new for gam update document Define (or ) for ` Define (or ) for ` As always, if I can be of any assistance, just let me know. Thanks for your hard work! — Reply to this email directly, view it on GitHub , or unsubscribe . You are receiving this because you are subscribed to this thread.