Skip to content

Commit b54602e

Browse files
committed
Document width and height query parameters for driveitem content format API
Add the required width and height (Int32) query parameters to the driveitem-get-content-format docs for both v1.0 and beta. These parameters are required when using format=jpg to specify the desired image dimensions in pixels. Also add the jpg format option to v1.0 (it was already documented in beta but missing from v1.0) with its supported source extensions.
1 parent de3ab84 commit b54602e

2 files changed

Lines changed: 5 additions & 0 deletions

File tree

api-reference/beta/api/driveitem-get-content-format.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ GET /drive/root:/{path and filename}:/content?format={format}
4343
| Parameter | Type | Description |
4444
|:----------|:-------|:---------------------------------------------------------------|
4545
| _format_ | string | Specify the format the item's content should be downloaded as. |
46+
| _width_ | Int32 | The desired width of the converted image in pixels. Required when `format=jpg`. |
47+
| _height_ | Int32 | The desired height of the converted image in pixels. Required when `format=jpg`. |
4648

4749
The following values are valid for the **format** parameter:
4850

api-reference/v1.0/api/driveitem-get-content-format.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,16 @@ GET /drive/root:/{path and filename}:/content?format={format}
4141
| Parameter | Type | Description |
4242
|:----------|:-------|:---------------------------------------------------------------|
4343
| _format_ | string | Specify the format the item's content should be downloaded as. |
44+
| _width_ | Int32 | The desired width of the converted image in pixels. Required when `format=jpg`. |
45+
| _height_ | Int32 | The desired height of the converted image in pixels. Required when `format=jpg`. |
4446

4547
### Format options
4648

4749
The following values are valid for the **format** parameter:
4850

4951
| Format value | Description | Supported source extensions
5052
|:-------------|:-----------------------------------|----------------------------
53+
| jpg | Converts the item into JPG format. | 3g2, 3gp, 3gp2, 3gpp, 3mf, ai, arw, asf, avi, bas, bash, bat, bmp, c, cbl, cmd, cool, cpp, cr2, crw, cs, css, csv, cur, dcm, dcm30, dic, dicm, dicom, dng, doc, docx, dwg, eml, epi, eps, epsf, epsi, epub, erf, fbx, fppx, gif, glb, h, hcp, heic, heif, htm, html, ico, icon, java, jfif, jpeg, jpg, js, json, key, log, m2ts, m4a, m4v, markdown, md, mef, mov, movie, mp3, mp4, mp4v, mrw, msg, mts, nef, nrw, numbers, obj, odp, odt, ogg, orf, pages, pano, pdf, pef, php, pict, pl, ply, png, pot, potm, potx, pps, ppsx, ppsxm, ppt, pptm, pptx, ps, ps1, psb, psd, py, raw, rb, rtf, rw1, rw2, sh, sketch, sql, sr2, stl, tif, tiff, ts, txt, vb, webm, wma, wmv, xaml, xbm, xcf, xd, xml, xpm, yaml, yml
5154
| pdf | Converts the item into PDF format. | doc, docx, dot, dotx, dotm, dsn, dwg, eml, epub, fluidframework, form, htm, html, loop, loot, markdown, md, msg, note, odp, ods, odt, page, pps, ppsx, ppt, pptx, pulse, rtf, task, tif, tiff, wbtx, whiteboard, xls, xlsm, xlsx
5255
| html | Converts the item into HTML format.| loop, fluid, wbtx
5356

0 commit comments

Comments
 (0)