NEnerds-odd-e
notebook-folder-controller

Get folder page payload

Changed on

Notebook chrome, folder metadata, parent folder id when nested, and optional folder readme content when present.

get/api/notebooks/{notebook}/folders/{folder}

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/notebooks/{notebook}/folders/{folder}
  • Auth
    none declared

Path parameters

notebookinteger required
folderinteger required

Response

OK

scopedReadmeContentstring

Full markdown of the container readme that supplies the nearest non-blank title_pattern (inner scope toward notebook root). Omitted when none applies.

parentFolderIdinteger

Parent folder id when this folder is nested; omitted at notebook root.

readmeContentstring

Container-owned folder readme markdown. Omitted when absent.

Changes

  • 482412c3c1b0Revision changes
    • breaking

      the // response property's maxLength was unset from 512 for the response status

    • breaking

      the // response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

  • 761d42f61982Revision changes
    • info

      api tag notebook-folder-controller added

    • info

      api tag notebook-controller removed