diff --git a/docs/legacy/plex/AutoUpdates.md b/docs/legacy/plex/AutoUpdates.md index ba9b2c6..731898a 100644 --- a/docs/legacy/plex/AutoUpdates.md +++ b/docs/legacy/plex/AutoUpdates.md @@ -5,33 +5,37 @@ Updates to the status can be observed via the Event API. ### Querying status of updates [GET /updater/status] -+ Response 200 (application/xml;charset=utf-8) +- Response 200 (application/xml;charset=utf-8) + + - Body - + Body ```xml - + ``` + ### Checking for updates [PUT /updater/check] -+ Parameters - + download: `0` (bool, optional) - Indicate that you want to start download any updates found. +- Parameters -+ Response 200 + - download: `0` (bool, optional) - Indicate that you want to start download any updates found. + +- Response 200 ### Applying updates [PUT /updater/apply{?tonight/skip}] -+ Parameters - + tonight: `1` (bool, optional) - Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install immediately. - + skip: `0` (bool, optional) - Indicate that the latest version should be marked as skipped. The entry for this version will have the `state` set to `skipped`. +- Parameters + - tonight: `1` (bool, optional) - Indicate that you want the update to run during the next Butler execution. Omitting this or setting it to false indicates that the update should install immediately. + - skip: `0` (bool, optional) - Indicate that the latest version should be marked as skipped. The entry for this version will have the `state` set to `skipped`. Note that these two parameters are effectively mutually exclusive. The `tonight` parameter takes precedence and `skip` will be ignored if `tonight` is also passed. -+ Response 200 +- Response 200 If the update process started correctly - + Body -+ Response 500 + - Body + +- Response 500 If the update process failed to start - + Body + - Body diff --git a/sidebars.js b/sidebars.js index ca1d0a3..ff2302c 100644 --- a/sidebars.js +++ b/sidebars.js @@ -15,6 +15,25 @@ const sidebars = { }, items: require("./docs/plex/sidebar.js"), }, + { + type: "category", + label: "Legacy Markdown", + collapsible: true, + collapsed: true, + link: { + type: "generated-index", + title: "Legacy API Markdown", + description: + "This documentation is the source markdown data used to create the open API Document", + slug: "/legacy", + }, + items: [ + { + type: "autogenerated", + dirName: "legacy/plex", // generate sidebar + }, + ], + }, ], };