From 509bc4efb3c1329a7d5a8cbc9b47d84bd0ed6d9f Mon Sep 17 00:00:00 2001
From: github-actions <github-actions@github.com>
Date: Fri, 22 Mar 2024 02:27:52 +0000
Subject: [PATCH] chore(docs): update admin API docs [skip ci]

---
 docs/admin-preview.html | 4 ++--
 docs/admin.html         | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/docs/admin-preview.html b/docs/admin-preview.html
index 04ca7c37..2402d119 100644
--- a/docs/admin-preview.html
+++ b/docs/admin-preview.html
@@ -390,7 +390,7 @@
           55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
           -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
           -104.0616 -231.873,-231.248 z
-        " fill="currentColor"></path></g></svg></div></div><div class="sc-dwcvcB dPIjnf api-content"><div class="sc-eCstZk kxmVZO"><div class="sc-iBPTVF keMybc"><div class="sc-hKgKIp gvoNGN api-info"><h1 class="sc-fubDmA sc-eGCbyA djltfY hWeMwQ">AEM Admin API (Feature Preview)<!-- --> <span>(<!-- -->11.31.2<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-ctaXUJ gUXnfH">Download</a></p><div class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG"><div class="sc-bsioJn jddSMs"><div class="sc-gIntVs cWZmJq"> <!-- --> <span class="sc-dFJsne hlKxkW">License:<!-- --> <a href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache 2.0</a></span> </div></div></div><div data-role="redoc-summary" html="" class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG"></div><div data-role="redoc-description" html="&lt;p&gt;AEM Admin API is used to manage the lifecycle of content and code.&lt;/p&gt;
+        " fill="currentColor"></path></g></svg></div></div><div class="sc-dwcvcB dPIjnf api-content"><div class="sc-eCstZk kxmVZO"><div class="sc-iBPTVF keMybc"><div class="sc-hKgKIp gvoNGN api-info"><h1 class="sc-fubDmA sc-eGCbyA djltfY hWeMwQ">AEM Admin API (Feature Preview)<!-- --> <span>(<!-- -->11.31.3<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-ctaXUJ gUXnfH">Download</a></p><div class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG"><div class="sc-bsioJn jddSMs"><div class="sc-gIntVs cWZmJq"> <!-- --> <span class="sc-dFJsne hlKxkW">License:<!-- --> <a href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache 2.0</a></span> </div></div></div><div data-role="redoc-summary" html="" class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG"></div><div data-role="redoc-description" html="&lt;p&gt;AEM Admin API is used to manage the lifecycle of content and code.&lt;/p&gt;
 " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG"><p>AEM Admin API is used to manage the lifecycle of content and code.</p>
 </div></div></div></div><div id="tag/snapshot" data-section-id="tag/snapshot" class="sc-eCstZk kxmVZO"><div class="sc-iBPTVF keMybc"><div class="sc-hKgKIp gvoNGN"><h1 class="sc-fubDmA djltfY"><a class="sc-crrtmM jGBpue" href="#tag/snapshot" aria-label="tag/snapshot"></a>snapshot</h1></div></div><div class="sc-hKgKIp jIkZBx"><div class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG redoc-markdown " html="&lt;p&gt;Snapshot operations&lt;/p&gt;
 "><p>Snapshot operations</p>
@@ -936,7 +936,7 @@
 " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG sc-citwID bzkUsW"><p>Operation failed due to an internal error.</p>
 </div></button></div></div></div><div class="sc-jSguLX sc-gKsecS QymcT bZqtR"><div class="sc-bQdSiB bhuodb"><button class="sc-FyfbU jlriCd"><span type="delete" class="sc-jXkspL cHWaxK http-verb delete">delete</span><span class="sc-fXoxOd jzevEV">/config/{org}/users.json</span><svg class="sc-dQpIV hHbBnT" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-eFtZDC ciRGmD"><div class="sc-fmlKft buTZbL"><div html="" class="sc-iJuWdM sc-cBNeRQ gpkGbA dujygE"></div><div tabindex="0" role="button"><div class="sc-ljRaSg uePtT"><span>https://admin.hlx.page</span>/config/{org}/users.json</div></div></div></div></div></div></div></div></div><div class="sc-jtHLPo gfiMgB"></div></div></div>
       <script>
-      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"version":"11.31.2","title":"AEM Admin API (Feature Preview)","description":"AEM Admin API is used to manage the lifecycle of content and code.","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://admin.hlx.page"}],"tags":[{"name":"snapshot","description":"Snapshot operations"}],"paths":{"/snapshot/{owner}/{repo}/main/{snapshotId}":{"get":{"operationId":"getSnapshotManifest","tags":["snapshot"],"summary":"Snapshot Manifest","description":"Returns the snapshot manifest","security":[{"AuthCookie":["snapshot:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"}],"responses":{"200":{"description":"The snapshot manifest","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snapshotManifest"},{"$ref":"#/components/schemas/snapshotLinksInfo"}]},"examples":{"success":{"description":"Success response of a snapshot manifest.","value":{"manifest":{"id":"12345","title":"Test Review","description":"ignore this review","created":"2021-04-31T23:00:00Z","lastModified":"2021-05-31T23:00:00Z","lastUpdated":"2021-05-31T23:00:00Z","resources":[{"path":"/foo"},{"path":"/bar"}]},"links":{"snapshot":"https://admin.hlx.page/snapshot/adobe/blog/main/12345"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}},"post":{"operationId":"updateSnapshotManifest","tags":["snapshot"],"summary":"Update snapshot Manifest","description":"Updates the Snapshot manifest and allows to lock or unlock the snapshot. Note that in order to lock the snapshot, the request role also needs to include the `preview:write` permission, and in order to unlock the snapshot, the `live:write` permission is needed.\n","security":[{"AuthCookie":["snapshot:write","preview:write","live:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"locked":{"type":"boolean"},"title":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"200":{"description":"The snapshot manifest","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snapshotManifest"},{"$ref":"#/components/schemas/snapshotLinksInfo"}]},"examples":{"success":{"description":"Success response of a snapshot manifest.","value":{"manifest":{"title":"December release","id":"12345","created":"2021-04-31T23:00:00Z","lastModified":"2021-05-31T23:00:00Z","lastUpdated":"2021-05-31T23:00:00Z","resources":[{"path":"/foo"},{"path":"/bar"}]},"links":{"snapshot":"https://admin.hlx.page/snapshot/adobe/blog/main/12345"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/snapshot/{owner}/{repo}/main/{snapshotId}/{path}":{"get":{"operationId":"getSnapshot","tags":["snapshot"],"summary":"Snapshot status","description":"Returns the snapshot status of the respective resource.","security":[{"AuthCookie":["snapshot:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"The snapshot status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/previewInfo"},{"$ref":"#/components/schemas/snapshotInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of a snapshot document.","value":{"webPath":"/.snapshot/12345/en/2021/blog","resourcePath":"/.snapshot/12345/en/2021/blog.md","preview":{"status":200,"url":"https://main--repo--owner.hlx.page/.snapshot/12345/en/2021/blog","lastModified":"2021-05-31T23:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/.snapshot/12345/preview/en/2021/blog.md","permissions":["read","write"]},"snapshot":{"id":"12345","locked":"2021-05-31T23:00:00Z"},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}},"post":{"operationId":"createSnapshot","tags":["snapshot"],"summary":"Create snapshot","description":"Creates a snapshot of the specified resource and stores it in the preview partition below the `.snapshot/snapshotId` folder. If the path param ends with a `*`, a snapshot of the entire subtree is created. If the snapshot is locked, a `409` response is returned.\n","security":[{"AuthCookie":["snapshot:read","snapshot:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/snFilterParam"}],"responses":{"200":{"description":"Successful snapshot response"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteSnapshot","tags":["snapshot"],"summary":"Delete snapshot","description":"Deletes a snapshot resource from the `preview` partition in the content-bus.  If the path param ends with a `*`, the entire subtree is deleted. If the snapshot is locked, a `409` response is returned.\n","security":[{"AuthCookie":["snapshot:read","snapshot:delete"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}},"/snapshot/{owner}/{repo}/main/{snapshotId}/{path}?publish=true":{"post":{"operationId":"publishSnapshotResource","tags":["snapshot"],"summary":"Publish snapshot resource","description":"Publish snapshot resources by copying the resource content from the snapshot location to the `live` content-bus partition. It additionally purges the _live_ cdn and the _byo_ cdn, if configured. If the path param ends with a `*` the resources of the path's entire subtree is published.\n","security":[{"AuthCookie":["snapshot:read","live:read","live:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/snPublishParam"}],"responses":{"200":{"description":"Resources published.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of the published document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read","write"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"202":{"description":"Snapshot publish job started","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snapshotJob"},{"$ref":"#/components/schemas/snapshotLinksPublishJob"}]},"examples":{"success":{"description":"Response of the created publish job.","value":{"job":{"topic":"publish","name":"job-2024-01-16t22-39-20-813z","state":"stopped","createTime":"2024-01-16T22:39:20.813Z","startTime":"2024-01-16T22:39:21.971Z","stopTime":"2024-01-16T22:39:24.693Z","invocationId":"96669ae6-cf90-530a-ac36-c4c7c85d27c8","data":{"paths":["/foo"],"snapshotId":"name","phase":"completed","resources":[{"path":"/foo","lastModified":"2024-01-16T22:39:24.693Z","status":200}]},"progress":{"total":1,"processed":1,"failed":0}},"links":{"list":"https://admin.hlx.page/job/owner/repo/main/publish","self":"https://admin.hlx.page/job/owner/repo/main/publish/job-2024-01-16t22-39-20-813z"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/snapshot/{owner}/{repo}/main/{snapshotId}?publish=true":{"post":{"operationId":"publishSnapshot","tags":["snapshot"],"summary":"Publish snapshot","description":"Publish a snapshot by copying all resources from the snapshot location to the `live` content-bus partition. It additionally purges the _live_ cdn and the _byo_ cdn, if configured.\n","security":[{"AuthCookie":["snapshot:read","live:read","live:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/snPublishParam"}],"responses":{"200":{"description":"Snapshot published.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of the published document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read","write"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"202":{"description":"Snapshot publish job started","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snapshotJob"},{"$ref":"#/components/schemas/snapshotLinksPublishJob"}]},"examples":{"success":{"description":"Response of the created publish job.","value":{"job":{"topic":"publish","name":"job-2024-01-16t22-39-20-813z","state":"stopped","createTime":"2024-01-16T22:39:20.813Z","startTime":"2024-01-16T22:39:21.971Z","stopTime":"2024-01-16T22:39:24.693Z","invocationId":"96669ae6-cf90-530a-ac36-c4c7c85d27c8","data":{"paths":["/foo"],"snapshotId":"name","phase":"completed","resources":[{"path":"/foo","lastModified":"2024-01-16T22:39:24.693Z","status":200}]},"progress":{"total":1,"processed":1,"failed":0}},"links":{"list":"https://admin.hlx.page/job/owner/repo/main/publish","self":"https://admin.hlx.page/job/owner/repo/main/publish/job-2024-01-16t22-39-20-813z"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}.json":{"get":{"operationId":"getConfigOrg","tags":["config"],"summary":"Read Organisation Config","description":"Returns the organisation level configuration.","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigOrg","tags":["config"],"summary":"Update Organisation Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"put":{"operationId":"createConfigOrg","tags":["config"],"summary":"Create Organisation Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Resource created."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteConfigOrg","tags":["config"],"summary":"Delete Organisation Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/sites/{site}.json":{"get":{"operationId":"getConfigSite","tags":["config"],"summary":"Read Site Config","description":"Returns the site level configuration.","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigSite","tags":["config"],"summary":"Update Site Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"put":{"operationId":"createSiteSite","tags":["config"],"summary":"Create Site Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Resource created."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteConfigSite","tags":["config"],"summary":"Delete Site Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/profiles/{profile}.json":{"get":{"operationId":"getConfigProfile","tags":["config"],"summary":"Read Profile Config","description":"Returns the Profile level configuration.","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigProfile","tags":["config"],"summary":"Update Profile Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"put":{"operationId":"createConfigProfile","tags":["config"],"summary":"Create Profile Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Resource created."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteConfigProfile","tags":["config"],"summary":"Delete Profile Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/secrets/{secret}.json":{"get":{"operationId":"getConfigSecret","tags":["config"],"summary":"Read Secret Config","description":"Returns the Secret level configuration.","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/secretParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigSecret","tags":["config"],"summary":"Update Secret Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/secretParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"put":{"operationId":"createConfigSecret","tags":["config"],"summary":"Create Secret Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/secretParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Resource created."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteConfigSecret","tags":["config"],"summary":"Delete Secret Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/secretParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/users.json":{"get":{"operationId":"getConfigUser","tags":["config"],"summary":"Read User Config","description":"Returns the user level configuration.","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigUser","tags":["config"],"summary":"Update User Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"put":{"operationId":"createConfigUser","tags":["config"],"summary":"Create User Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Resource created."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteConfigUser","tags":["config"],"summary":"Delete User Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}}},"components":{"securitySchemes":{"AuthCookie":{"type":"apiKey","in":"cookie","name":"auth_token"},"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"ownerParam":{"name":"owner","in":"path","description":"Repository owner.","required":true,"schema":{"type":"string"}},"repoParam":{"name":"repo","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},"snIdParam":{"name":"snapshotId","in":"path","description":"Id of the snapshot","required":true,"schema":{"type":"string"}},"pathParam":{"name":"path","in":"path","description":"Relative path of the resource","required":true,"schema":{"type":"string"}},"snFilterParam":{"name":"filter","in":"query","description":"Filters the resources that are selected for snapshot. If set to `modified` only the resources that have a preview date newer than the live date are selected.\n","schema":{"enum":["all","modified"],"default":"all"}},"snPublishParam":{"name":"publish","in":"query","description":"Indicates that the snapshot should be published.\n","schema":{"enum":["true"]}},"orgParam":{"name":"org","in":"path","description":"organisation name.","required":true,"schema":{"type":"string"}},"siteParam":{"name":"site","in":"path","description":"site id.","required":true,"schema":{"type":"string"}},"profileParam":{"name":"profile","in":"path","description":"profile name.","required":true,"schema":{"type":"string"}},"secretParam":{"name":"secret","in":"path","description":"secret name.","required":true,"schema":{"type":"string"}}},"schemas":{"snapshotResource":{"description":"snapshot resource","type":"object","required":["path"],"properties":{"path":{"description":"path of the resource","type":"string"},"status":{"description":"status code for the resource","type":"number"},"lastModified":{"description":"last modified date of the resource","type":"string","format":"date-time"}}},"snapshotManifest":{"required":["manifest"],"properties":{"manifest":{"required":["id","created","lastModified","resources"],"properties":{"id":{"description":"The snapshot ID","type":"string"},"title":{"description":"The snapshot title","type":"string"},"description":{"description":"The snapshot description","type":"string"},"created":{"description":"Creation time","type":"string","format":"date-time"},"lastModified":{"description":"Last manifest modification time","type":"string","format":"date-time"},"lastUpdated":{"description":"Last time a resource was added or removed from this snapshot","type":"string","format":"date-time"},"locked":{"description":"Time when this snapshot was locked.","type":"string","format":"date-time"},"resources":{"description":"list of resources in the snapshot","type":"array","items":{"$ref":"#/components/schemas/snapshotResource"}}}}}},"snapshotLinksInfo":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"snapshot":{"description":"link of the status api","example":"https://admin.hlx.page/snaphost/owner/repo/ref/1234","type":"string","format":"url"}}}}},"resourceInfo":{"required":["webPath","resourcePath"],"properties":{"webPath":{"description":"Relative path used on the websites.","type":"string"},"resourcePath":{"description":"Relative path of the content resource","type":"string"}}},"permissions":{"description":"Access permissions","required":["permissions"],"properties":{"permissions":{"type":"array","items":{"type":"string","enum":["read","write","delete"]}}}},"contentBusResource":{"required":["contentBusId"],"properties":{"contentBusId":{"description":"Full content-bus id.","type":"string"},"lastModified":{"description":"Last modification date. undefined when resource is missing.","type":"string","format":"date-time"},"contentType":{"description":"The resource content type. undefined when resource is missing.","type":"string"},"contentLength":{"description":"Size of the content in bytes. undefined when resource is missing.","type":"integer"},"redirectLocation":{"description":"Location for redirects as defined on the resource","type":"string","format":"url"},"configRedirectLocation":{"description":"Location for redirects as defined in the config (redirects.json)","type":"string","format":"url"},"sourceLocation":{"description":"Content provider specific id of the source.","type":"string","format":"url"},"sourceLastModified":{"description":"Last modification date of the source document.","type":"string","format":"date-time"}}},"previewInfo":{"required":["preview"],"properties":{"preview":{"description":"Information about the preview resource.","allOf":[{"required":["url","status"]},{"properties":{"status":{"description":"HTTP status of response when fetching the information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"},"url":{"description":"Preview URL of the resource.","type":"string","format":"url"}}},{"$ref":"#/components/schemas/permissions"},{"$ref":"#/components/schemas/contentBusResource"}]}}},"snapshotInfo":{"required":["snapshot"],"properties":{"snapshot":{"required":["id"],"properties":{"id":{"description":"The snapshot ID","type":"string"},"locked":{"description":"Time when this snapshot was locked.","type":"string","format":"date-time"}}}}},"resourceLinksInfo":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"status":{"description":"link of the status api","example":"https://admin.hlx.page/status/owner/repo/ref","type":"string","format":"url"},"live":{"description":"link of the live api","example":"https://admin.hlx.page/live/owner/repo/ref","type":"string","format":"url"},"preview":{"description":"link of the preview api","example":"https://admin.hlx.page/preview/owner/repo/ref","type":"string","format":"url"},"code":{"description":"link of the code api","example":"https://admin.hlx.page/code/owner/repo/ref","type":"string","format":"url"}}}}},"liveInfo":{"required":["live"],"properties":{"live":{"description":"Information about the published resource.","allOf":[{"required":["url","status"]},{"properties":{"status":{"description":"HTTP status of response when fetching thre information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"},"url":{"description":"Live URL of the resource.","type":"string","format":"url"}}},{"$ref":"#/components/schemas/permissions"},{"$ref":"#/components/schemas/contentBusResource"}]}}},"jobState":{"description":"Job state","type":"string","enum":["created","running","stopped"]},"snapshotJob":{"required":["job"],"properties":{"job":{"required":["topic","name","state","createTime","data","startTime","stopTime","invocationId","progress"],"properties":{"topic":{"description":"Job Topic","type":"string"},"name":{"description":"Job Name","type":"string"},"state":{"description":"Job State","$ref":"#/components/schemas/jobState"},"createTime":{"description":"Job creation time","type":"string","format":"date-time"},"stopTime":{"description":"Job end time","type":"string","format":"date-time"},"startTime":{"description":"Job start time","type":"string","format":"date-time"},"invocationId":{"description":"Job end time","type":"string"},"progress":{"type":"object","properties":{"total":{"description":"total number of resources","type":"number"},"processed":{"description":"number of resources processed","type":"number"},"failed":{"description":"number of resources failed","type":"number"}}},"data":{"description":"Snapshot job data","type":"object","properties":{"paths":{"description":"paths being published from snapshot","type":"array","items":{"type":"string"}},"forceUpdate":{"description":"force update of resources","type":"boolean"},"snapshotId":{"description":"snapshot id","type":"string"},"phase":{"description":"current phase of the job","type":"string"},"resources":{"description":"list of resources in the snapshot","type":"array","items":{"$ref":"#/components/schemas/snapshotResource"}}}}}}}},"snapshotLinksPublishJob":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"list":{"description":"link of the job list api","example":"https://admin.hlx.page/job/owner/repo/main/publish","type":"string","format":"url"},"self":{"description":"link of the get job api","example":"https://admin.hlx.page/job/owner/repo/main/publish/job-name","type":"string","format":"url"}}}}}},"headers":{"xError":{"description":"A short descriptive error message","schema":{"format":"none","type":"string"}}},"responses":{"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}}},"searchIndex":{"store":["tag/snapshot","tag/snapshot/operation/getSnapshotManifest","tag/snapshot/operation/updateSnapshotManifest","tag/snapshot/operation/getSnapshot","tag/snapshot/operation/createSnapshot","tag/snapshot/operation/deleteSnapshot","tag/snapshot/operation/publishSnapshotResource","tag/snapshot/operation/publishSnapshot","tag/config","tag/config/operation/getConfigOrg","tag/config/operation/updateConfigOrg","tag/config/operation/createConfigOrg","tag/config/operation/deleteConfigOrg","tag/config/operation/getConfigSite","tag/config/operation/updateConfigSite","tag/config/operation/createSiteSite","tag/config/operation/deleteConfigSite","tag/config/operation/getConfigProfile","tag/config/operation/updateConfigProfile","tag/config/operation/createConfigProfile","tag/config/operation/deleteConfigProfile","tag/config/operation/getConfigSecret","tag/config/operation/updateConfigSecret","tag/config/operation/createConfigSecret","tag/config/operation/deleteConfigSecret","tag/config/operation/getConfigUser","tag/config/operation/updateConfigUser","tag/config/operation/createConfigUser","tag/config/operation/deleteConfigUser"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.805]],["description/0",[0,0.813,1,4.073]],["title/1",[0,0.668,2,2.119]],["description/1",[0,0.679,2,2.155,3,1.306,4,2.823]],["title/2",[0,0.571,2,1.812,5,1.324]],["description/2",[0,0.648,2,0.815,4,1.068,5,0.596,6,1.287,7,1.545,8,2.154,9,1.287,10,2.154,11,1.287,12,1.287,13,2.154,14,1.287,15,1.287,16,2.154,17,1.287]],["title/3",[0,0.668,18,2.776]],["description/3",[0,0.583,3,1.122,18,2.424,19,2.923,20,1.492,21,2.096]],["title/4",[0,0.668,22,1.549]],["description/4",[0,0.554,3,0.494,7,0.923,20,0.657,21,0.923,22,0.997,23,1.287,24,1.287,25,1.068,26,0.815,27,1.287,28,1.287,29,1.287,30,0.923,31,0.923,32,0.923,33,0.923,34,0.923,35,0.923,36,1.068,37,1.068]],["title/5",[0,0.668,38,1.549]],["description/5",[0,0.494,3,0.585,7,1.093,20,0.778,21,1.093,25,1.264,26,0.965,30,1.093,31,1.093,32,1.093,33,1.093,34,1.093,35,1.093,36,1.264,37,1.264,38,1.146,39,1.093]],["title/6",[0,0.571,20,1.46,40,1.812]],["description/6",[0,0.389,20,1.301,26,0.725,30,0.821,31,0.821,32,0.821,33,0.821,34,0.821,35,0.821,39,0.821,40,1.236,41,0.95,42,1.145,43,0.95,44,0.95,45,0.95,46,0.95,47,0.95,48,1.618,49,0.95,50,0.53,51,1.145,52,1.145]],["title/7",[0,0.668,40,2.119]],["description/7",[0,0.526,20,0.84,26,1.042,39,1.18,40,1.042,41,1.365,43,1.365,44,1.365,45,1.365,46,1.365,47,1.365,48,2.184,49,1.365,50,0.761,53,1.645]],["title/8",[54,0.448]],["description/8",[]],["title/9",[54,0.318,55,1.62,56,1.62]],["description/9",[3,1.207,50,1.455,56,1.781,57,1.781,58,1.992]],["title/10",[5,1.324,54,0.318,56,1.62]],["description/10",[58,2.86]],["title/11",[22,1.324,54,0.318,56,1.62]],["description/11",[58,2.86]],["title/12",[38,1.324,54,0.318,56,1.62]],["description/12",[58,2.86]],["title/13",[54,0.318,55,1.62,59,1.62]],["description/13",[3,1.207,50,1.455,57,1.781,59,1.781,60,1.992]],["title/14",[5,1.324,54,0.318,59,1.62]],["description/14",[60,2.86]],["title/15",[22,1.324,54,0.318,59,1.62]],["description/15",[60,2.86]],["title/16",[38,1.324,54,0.318,59,1.62]],["description/16",[60,2.86]],["title/17",[54,0.318,55,1.62,61,1.62]],["description/17",[3,1.207,50,1.455,57,1.781,61,1.781,62,1.992]],["title/18",[5,1.324,54,0.318,61,1.62]],["description/18",[62,2.86]],["title/19",[22,1.324,54,0.318,61,1.62]],["description/19",[62,2.86]],["title/20",[38,1.324,54,0.318,61,1.62]],["description/20",[62,2.86]],["title/21",[54,0.318,55,1.62,63,1.62]],["description/21",[3,1.207,50,1.455,57,1.781,63,1.781,64,1.992]],["title/22",[5,1.324,54,0.318,63,1.62]],["description/22",[64,2.86]],["title/23",[22,1.324,54,0.318,63,1.62]],["description/23",[64,2.86]],["title/24",[38,1.324,54,0.318,63,1.62]],["description/24",[64,2.86]],["title/25",[54,0.318,55,1.62,65,1.62]],["description/25",[3,1.207,50,1.455,57,1.781,65,1.781,66,1.992]],["title/26",[5,1.324,54,0.318,65,1.62]],["description/26",[66,2.86]],["title/27",[22,1.324,54,0.318,65,1.62]],["description/27",[66,2.86]],["title/28",[38,1.324,54,0.318,65,1.62]],["description/28",[66,2.86]]],"invertedIndex":[["",{"_index":33,"title":{},"description":{"4":{},"5":{},"6":{}}}],["409",{"_index":36,"title":{},"description":{"4":{},"5":{}}}],["_byo_",{"_index":49,"title":{},"description":{"6":{},"7":{}}}],["_live_",{"_index":47,"title":{},"description":{"6":{},"7":{}}}],["addition",{"_index":45,"title":{},"description":{"6":{},"7":{}}}],["allow",{"_index":6,"title":{},"description":{"2":{}}}],["below",{"_index":27,"title":{},"description":{"4":{}}}],["cdn",{"_index":48,"title":{},"description":{"6":{},"7":{}}}],["config",{"_index":54,"title":{"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{}},"description":{}}],["config/{org}.json",{"_index":58,"title":{},"description":{"9":{},"10":{},"11":{},"12":{}}}],["config/{org}/profiles/{profile}.json",{"_index":62,"title":{},"description":{"17":{},"18":{},"19":{},"20":{}}}],["config/{org}/secrets/{secret}.json",{"_index":64,"title":{},"description":{"21":{},"22":{},"23":{},"24":{}}}],["config/{org}/sites/{site}.json",{"_index":60,"title":{},"description":{"13":{},"14":{},"15":{},"16":{}}}],["config/{org}/users.json",{"_index":66,"title":{},"description":{"25":{},"26":{},"27":{},"28":{}}}],["configur",{"_index":50,"title":{},"description":{"6":{},"7":{},"9":{},"13":{},"17":{},"21":{},"25":{}}}],["content",{"_index":42,"title":{},"description":{"6":{}}}],["content-bu",{"_index":39,"title":{},"description":{"5":{},"6":{},"7":{}}}],["copi",{"_index":41,"title":{},"description":{"6":{},"7":{}}}],["creat",{"_index":22,"title":{"4":{},"11":{},"15":{},"19":{},"23":{},"27":{}},"description":{"4":{}}}],["delet",{"_index":38,"title":{"5":{},"12":{},"16":{},"20":{},"24":{},"28":{}},"description":{"5":{}}}],["end",{"_index":32,"title":{},"description":{"4":{},"5":{},"6":{}}}],["entir",{"_index":34,"title":{},"description":{"4":{},"5":{},"6":{}}}],["folder",{"_index":29,"title":{},"description":{"4":{}}}],["includ",{"_index":14,"title":{},"description":{"2":{}}}],["level",{"_index":57,"title":{},"description":{"9":{},"13":{},"17":{},"21":{},"25":{}}}],["live",{"_index":44,"title":{},"description":{"6":{},"7":{}}}],["live:writ",{"_index":17,"title":{},"description":{"2":{}}}],["locat",{"_index":43,"title":{},"description":{"6":{},"7":{}}}],["lock",{"_index":7,"title":{},"description":{"2":{},"4":{},"5":{}}}],["manifest",{"_index":2,"title":{"1":{},"2":{}},"description":{"1":{},"2":{}}}],["need",{"_index":13,"title":{},"description":{"2":{}}}],["note",{"_index":9,"title":{},"description":{"2":{}}}],["oper",{"_index":1,"title":{},"description":{"0":{}}}],["order",{"_index":10,"title":{},"description":{"2":{}}}],["organis",{"_index":56,"title":{"9":{},"10":{},"11":{},"12":{}},"description":{"9":{}}}],["param",{"_index":31,"title":{},"description":{"4":{},"5":{},"6":{}}}],["partit",{"_index":26,"title":{},"description":{"4":{},"5":{},"6":{},"7":{}}}],["path",{"_index":30,"title":{},"description":{"4":{},"5":{},"6":{}}}],["path'",{"_index":51,"title":{},"description":{"6":{}}}],["permiss",{"_index":16,"title":{},"description":{"2":{}}}],["preview",{"_index":25,"title":{},"description":{"4":{},"5":{}}}],["preview:writ",{"_index":15,"title":{},"description":{"2":{}}}],["profil",{"_index":61,"title":{"17":{},"18":{},"19":{},"20":{}},"description":{"17":{}}}],["publish",{"_index":40,"title":{"6":{},"7":{}},"description":{"6":{},"7":{}}}],["purg",{"_index":46,"title":{},"description":{"6":{},"7":{}}}],["read",{"_index":55,"title":{"9":{},"13":{},"17":{},"21":{},"25":{}},"description":{}}],["request",{"_index":11,"title":{},"description":{"2":{}}}],["resourc",{"_index":20,"title":{"6":{}},"description":{"3":{},"4":{},"5":{},"6":{},"7":{}}}],["respect",{"_index":19,"title":{},"description":{"3":{}}}],["respons",{"_index":37,"title":{},"description":{"4":{},"5":{}}}],["return",{"_index":3,"title":{},"description":{"1":{},"3":{},"4":{},"5":{},"9":{},"13":{},"17":{},"21":{},"25":{}}}],["role",{"_index":12,"title":{},"description":{"2":{}}}],["secret",{"_index":63,"title":{"21":{},"22":{},"23":{},"24":{}},"description":{"21":{}}}],["site",{"_index":59,"title":{"13":{},"14":{},"15":{},"16":{}},"description":{"13":{}}}],["snapshot",{"_index":0,"title":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{}},"description":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{}}}],["snapshot/snapshotid",{"_index":28,"title":{},"description":{"4":{}}}],["snapshot/{owner}/{repo}/main/{snapshotid",{"_index":4,"title":{},"description":{"1":{},"2":{}}}],["snapshot/{owner}/{repo}/main/{snapshotid}/{path",{"_index":21,"title":{},"description":{"3":{},"4":{},"5":{}}}],["snapshot/{owner}/{repo}/main/{snapshotid}/{path}?publish=tru",{"_index":52,"title":{},"description":{"6":{}}}],["snapshot/{owner}/{repo}/main/{snapshotid}?publish=tru",{"_index":53,"title":{},"description":{"7":{}}}],["specifi",{"_index":23,"title":{},"description":{"4":{}}}],["statu",{"_index":18,"title":{"3":{}},"description":{"3":{}}}],["store",{"_index":24,"title":{},"description":{"4":{}}}],["subtre",{"_index":35,"title":{},"description":{"4":{},"5":{},"6":{}}}],["unlock",{"_index":8,"title":{},"description":{"2":{}}}],["updat",{"_index":5,"title":{"2":{},"10":{},"14":{},"18":{},"22":{},"26":{}},"description":{"2":{}}}],["user",{"_index":65,"title":{"25":{},"26":{},"27":{},"28":{}},"description":{"25":{}}}]],"pipeline":[]}},"options":{}};
+      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"version":"11.31.3","title":"AEM Admin API (Feature Preview)","description":"AEM Admin API is used to manage the lifecycle of content and code.","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://admin.hlx.page"}],"tags":[{"name":"snapshot","description":"Snapshot operations"}],"paths":{"/snapshot/{owner}/{repo}/main/{snapshotId}":{"get":{"operationId":"getSnapshotManifest","tags":["snapshot"],"summary":"Snapshot Manifest","description":"Returns the snapshot manifest","security":[{"AuthCookie":["snapshot:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"}],"responses":{"200":{"description":"The snapshot manifest","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snapshotManifest"},{"$ref":"#/components/schemas/snapshotLinksInfo"}]},"examples":{"success":{"description":"Success response of a snapshot manifest.","value":{"manifest":{"id":"12345","title":"Test Review","description":"ignore this review","created":"2021-04-31T23:00:00Z","lastModified":"2021-05-31T23:00:00Z","lastUpdated":"2021-05-31T23:00:00Z","resources":[{"path":"/foo"},{"path":"/bar"}]},"links":{"snapshot":"https://admin.hlx.page/snapshot/adobe/blog/main/12345"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}},"post":{"operationId":"updateSnapshotManifest","tags":["snapshot"],"summary":"Update snapshot Manifest","description":"Updates the Snapshot manifest and allows to lock or unlock the snapshot. Note that in order to lock the snapshot, the request role also needs to include the `preview:write` permission, and in order to unlock the snapshot, the `live:write` permission is needed.\n","security":[{"AuthCookie":["snapshot:write","preview:write","live:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"locked":{"type":"boolean"},"title":{"type":"string"},"description":{"type":"string"}}}}}},"responses":{"200":{"description":"The snapshot manifest","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snapshotManifest"},{"$ref":"#/components/schemas/snapshotLinksInfo"}]},"examples":{"success":{"description":"Success response of a snapshot manifest.","value":{"manifest":{"title":"December release","id":"12345","created":"2021-04-31T23:00:00Z","lastModified":"2021-05-31T23:00:00Z","lastUpdated":"2021-05-31T23:00:00Z","resources":[{"path":"/foo"},{"path":"/bar"}]},"links":{"snapshot":"https://admin.hlx.page/snapshot/adobe/blog/main/12345"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/snapshot/{owner}/{repo}/main/{snapshotId}/{path}":{"get":{"operationId":"getSnapshot","tags":["snapshot"],"summary":"Snapshot status","description":"Returns the snapshot status of the respective resource.","security":[{"AuthCookie":["snapshot:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"The snapshot status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/previewInfo"},{"$ref":"#/components/schemas/snapshotInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of a snapshot document.","value":{"webPath":"/.snapshot/12345/en/2021/blog","resourcePath":"/.snapshot/12345/en/2021/blog.md","preview":{"status":200,"url":"https://main--repo--owner.hlx.page/.snapshot/12345/en/2021/blog","lastModified":"2021-05-31T23:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/.snapshot/12345/preview/en/2021/blog.md","permissions":["read","write"]},"snapshot":{"id":"12345","locked":"2021-05-31T23:00:00Z"},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}},"post":{"operationId":"createSnapshot","tags":["snapshot"],"summary":"Create snapshot","description":"Creates a snapshot of the specified resource and stores it in the preview partition below the `.snapshot/snapshotId` folder. If the path param ends with a `*`, a snapshot of the entire subtree is created. If the snapshot is locked, a `409` response is returned.\n","security":[{"AuthCookie":["snapshot:read","snapshot:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/snFilterParam"}],"responses":{"200":{"description":"Successful snapshot response"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteSnapshot","tags":["snapshot"],"summary":"Delete snapshot","description":"Deletes a snapshot resource from the `preview` partition in the content-bus.  If the path param ends with a `*`, the entire subtree is deleted. If the snapshot is locked, a `409` response is returned.\n","security":[{"AuthCookie":["snapshot:read","snapshot:delete"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}},"/snapshot/{owner}/{repo}/main/{snapshotId}/{path}?publish=true":{"post":{"operationId":"publishSnapshotResource","tags":["snapshot"],"summary":"Publish snapshot resource","description":"Publish snapshot resources by copying the resource content from the snapshot location to the `live` content-bus partition. It additionally purges the _live_ cdn and the _byo_ cdn, if configured. If the path param ends with a `*` the resources of the path's entire subtree is published.\n","security":[{"AuthCookie":["snapshot:read","live:read","live:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/snPublishParam"}],"responses":{"200":{"description":"Resources published.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of the published document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read","write"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"202":{"description":"Snapshot publish job started","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snapshotJob"},{"$ref":"#/components/schemas/snapshotLinksPublishJob"}]},"examples":{"success":{"description":"Response of the created publish job.","value":{"job":{"topic":"publish","name":"job-2024-01-16t22-39-20-813z","state":"stopped","createTime":"2024-01-16T22:39:20.813Z","startTime":"2024-01-16T22:39:21.971Z","stopTime":"2024-01-16T22:39:24.693Z","invocationId":"96669ae6-cf90-530a-ac36-c4c7c85d27c8","data":{"paths":["/foo"],"snapshotId":"name","phase":"completed","resources":[{"path":"/foo","lastModified":"2024-01-16T22:39:24.693Z","status":200}]},"progress":{"total":1,"processed":1,"failed":0}},"links":{"list":"https://admin.hlx.page/job/owner/repo/main/publish","self":"https://admin.hlx.page/job/owner/repo/main/publish/job-2024-01-16t22-39-20-813z"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/snapshot/{owner}/{repo}/main/{snapshotId}?publish=true":{"post":{"operationId":"publishSnapshot","tags":["snapshot"],"summary":"Publish snapshot","description":"Publish a snapshot by copying all resources from the snapshot location to the `live` content-bus partition. It additionally purges the _live_ cdn and the _byo_ cdn, if configured.\n","security":[{"AuthCookie":["snapshot:read","live:read","live:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/snPublishParam"}],"responses":{"200":{"description":"Snapshot published.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of the published document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read","write"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"202":{"description":"Snapshot publish job started","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snapshotJob"},{"$ref":"#/components/schemas/snapshotLinksPublishJob"}]},"examples":{"success":{"description":"Response of the created publish job.","value":{"job":{"topic":"publish","name":"job-2024-01-16t22-39-20-813z","state":"stopped","createTime":"2024-01-16T22:39:20.813Z","startTime":"2024-01-16T22:39:21.971Z","stopTime":"2024-01-16T22:39:24.693Z","invocationId":"96669ae6-cf90-530a-ac36-c4c7c85d27c8","data":{"paths":["/foo"],"snapshotId":"name","phase":"completed","resources":[{"path":"/foo","lastModified":"2024-01-16T22:39:24.693Z","status":200}]},"progress":{"total":1,"processed":1,"failed":0}},"links":{"list":"https://admin.hlx.page/job/owner/repo/main/publish","self":"https://admin.hlx.page/job/owner/repo/main/publish/job-2024-01-16t22-39-20-813z"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}.json":{"get":{"operationId":"getConfigOrg","tags":["config"],"summary":"Read Organisation Config","description":"Returns the organisation level configuration.","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigOrg","tags":["config"],"summary":"Update Organisation Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"put":{"operationId":"createConfigOrg","tags":["config"],"summary":"Create Organisation Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Resource created."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteConfigOrg","tags":["config"],"summary":"Delete Organisation Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/sites/{site}.json":{"get":{"operationId":"getConfigSite","tags":["config"],"summary":"Read Site Config","description":"Returns the site level configuration.","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigSite","tags":["config"],"summary":"Update Site Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"put":{"operationId":"createSiteSite","tags":["config"],"summary":"Create Site Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Resource created."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteConfigSite","tags":["config"],"summary":"Delete Site Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/profiles/{profile}.json":{"get":{"operationId":"getConfigProfile","tags":["config"],"summary":"Read Profile Config","description":"Returns the Profile level configuration.","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigProfile","tags":["config"],"summary":"Update Profile Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"put":{"operationId":"createConfigProfile","tags":["config"],"summary":"Create Profile Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Resource created."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteConfigProfile","tags":["config"],"summary":"Delete Profile Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/secrets/{secret}.json":{"get":{"operationId":"getConfigSecret","tags":["config"],"summary":"Read Secret Config","description":"Returns the Secret level configuration.","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/secretParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigSecret","tags":["config"],"summary":"Update Secret Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/secretParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"put":{"operationId":"createConfigSecret","tags":["config"],"summary":"Create Secret Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/secretParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Resource created."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteConfigSecret","tags":["config"],"summary":"Delete Secret Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/secretParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/users.json":{"get":{"operationId":"getConfigUser","tags":["config"],"summary":"Read User Config","description":"Returns the user level configuration.","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigUser","tags":["config"],"summary":"Update User Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"put":{"operationId":"createConfigUser","tags":["config"],"summary":"Create User Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Resource created."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteConfigUser","tags":["config"],"summary":"Delete User Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}}},"components":{"securitySchemes":{"AuthCookie":{"type":"apiKey","in":"cookie","name":"auth_token"},"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"ownerParam":{"name":"owner","in":"path","description":"Repository owner.","required":true,"schema":{"type":"string"}},"repoParam":{"name":"repo","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},"snIdParam":{"name":"snapshotId","in":"path","description":"Id of the snapshot","required":true,"schema":{"type":"string"}},"pathParam":{"name":"path","in":"path","description":"Relative path of the resource","required":true,"schema":{"type":"string"}},"snFilterParam":{"name":"filter","in":"query","description":"Filters the resources that are selected for snapshot. If set to `modified` only the resources that have a preview date newer than the live date are selected.\n","schema":{"enum":["all","modified"],"default":"all"}},"snPublishParam":{"name":"publish","in":"query","description":"Indicates that the snapshot should be published.\n","schema":{"enum":["true"]}},"orgParam":{"name":"org","in":"path","description":"organisation name.","required":true,"schema":{"type":"string"}},"siteParam":{"name":"site","in":"path","description":"site id.","required":true,"schema":{"type":"string"}},"profileParam":{"name":"profile","in":"path","description":"profile name.","required":true,"schema":{"type":"string"}},"secretParam":{"name":"secret","in":"path","description":"secret name.","required":true,"schema":{"type":"string"}}},"schemas":{"snapshotResource":{"description":"snapshot resource","type":"object","required":["path"],"properties":{"path":{"description":"path of the resource","type":"string"},"status":{"description":"status code for the resource","type":"number"},"lastModified":{"description":"last modified date of the resource","type":"string","format":"date-time"}}},"snapshotManifest":{"required":["manifest"],"properties":{"manifest":{"required":["id","created","lastModified","resources"],"properties":{"id":{"description":"The snapshot ID","type":"string"},"title":{"description":"The snapshot title","type":"string"},"description":{"description":"The snapshot description","type":"string"},"created":{"description":"Creation time","type":"string","format":"date-time"},"lastModified":{"description":"Last manifest modification time","type":"string","format":"date-time"},"lastUpdated":{"description":"Last time a resource was added or removed from this snapshot","type":"string","format":"date-time"},"locked":{"description":"Time when this snapshot was locked.","type":"string","format":"date-time"},"resources":{"description":"list of resources in the snapshot","type":"array","items":{"$ref":"#/components/schemas/snapshotResource"}}}}}},"snapshotLinksInfo":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"snapshot":{"description":"link of the status api","example":"https://admin.hlx.page/snaphost/owner/repo/ref/1234","type":"string","format":"url"}}}}},"resourceInfo":{"required":["webPath","resourcePath"],"properties":{"webPath":{"description":"Relative path used on the websites.","type":"string"},"resourcePath":{"description":"Relative path of the content resource","type":"string"}}},"permissions":{"description":"Access permissions","required":["permissions"],"properties":{"permissions":{"type":"array","items":{"type":"string","enum":["read","write","delete"]}}}},"contentBusResource":{"required":["contentBusId"],"properties":{"contentBusId":{"description":"Full content-bus id.","type":"string"},"lastModified":{"description":"Last modification date. undefined when resource is missing.","type":"string","format":"date-time"},"contentType":{"description":"The resource content type. undefined when resource is missing.","type":"string"},"contentLength":{"description":"Size of the content in bytes. undefined when resource is missing.","type":"integer"},"redirectLocation":{"description":"Location for redirects as defined on the resource","type":"string","format":"url"},"configRedirectLocation":{"description":"Location for redirects as defined in the config (redirects.json)","type":"string","format":"url"},"sourceLocation":{"description":"Content provider specific id of the source.","type":"string","format":"url"},"sourceLastModified":{"description":"Last modification date of the source document.","type":"string","format":"date-time"}}},"previewInfo":{"required":["preview"],"properties":{"preview":{"description":"Information about the preview resource.","allOf":[{"required":["url","status"]},{"properties":{"status":{"description":"HTTP status of response when fetching the information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"},"url":{"description":"Preview URL of the resource.","type":"string","format":"url"}}},{"$ref":"#/components/schemas/permissions"},{"$ref":"#/components/schemas/contentBusResource"}]}}},"snapshotInfo":{"required":["snapshot"],"properties":{"snapshot":{"required":["id"],"properties":{"id":{"description":"The snapshot ID","type":"string"},"locked":{"description":"Time when this snapshot was locked.","type":"string","format":"date-time"}}}}},"resourceLinksInfo":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"status":{"description":"link of the status api","example":"https://admin.hlx.page/status/owner/repo/ref","type":"string","format":"url"},"live":{"description":"link of the live api","example":"https://admin.hlx.page/live/owner/repo/ref","type":"string","format":"url"},"preview":{"description":"link of the preview api","example":"https://admin.hlx.page/preview/owner/repo/ref","type":"string","format":"url"},"code":{"description":"link of the code api","example":"https://admin.hlx.page/code/owner/repo/ref","type":"string","format":"url"}}}}},"liveInfo":{"required":["live"],"properties":{"live":{"description":"Information about the published resource.","allOf":[{"required":["url","status"]},{"properties":{"status":{"description":"HTTP status of response when fetching thre information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"},"url":{"description":"Live URL of the resource.","type":"string","format":"url"}}},{"$ref":"#/components/schemas/permissions"},{"$ref":"#/components/schemas/contentBusResource"}]}}},"jobState":{"description":"Job state","type":"string","enum":["created","running","stopped"]},"snapshotJob":{"required":["job"],"properties":{"job":{"required":["topic","name","state","createTime","data","startTime","stopTime","invocationId","progress"],"properties":{"topic":{"description":"Job Topic","type":"string"},"name":{"description":"Job Name","type":"string"},"state":{"description":"Job State","$ref":"#/components/schemas/jobState"},"createTime":{"description":"Job creation time","type":"string","format":"date-time"},"stopTime":{"description":"Job end time","type":"string","format":"date-time"},"startTime":{"description":"Job start time","type":"string","format":"date-time"},"invocationId":{"description":"Job end time","type":"string"},"progress":{"type":"object","properties":{"total":{"description":"total number of resources","type":"number"},"processed":{"description":"number of resources processed","type":"number"},"failed":{"description":"number of resources failed","type":"number"}}},"data":{"description":"Snapshot job data","type":"object","properties":{"paths":{"description":"paths being published from snapshot","type":"array","items":{"type":"string"}},"forceUpdate":{"description":"force update of resources","type":"boolean"},"snapshotId":{"description":"snapshot id","type":"string"},"phase":{"description":"current phase of the job","type":"string"},"resources":{"description":"list of resources in the snapshot","type":"array","items":{"$ref":"#/components/schemas/snapshotResource"}}}}}}}},"snapshotLinksPublishJob":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"list":{"description":"link of the job list api","example":"https://admin.hlx.page/job/owner/repo/main/publish","type":"string","format":"url"},"self":{"description":"link of the get job api","example":"https://admin.hlx.page/job/owner/repo/main/publish/job-name","type":"string","format":"url"}}}}}},"headers":{"xError":{"description":"A short descriptive error message","schema":{"format":"none","type":"string"}}},"responses":{"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}}},"searchIndex":{"store":["tag/snapshot","tag/snapshot/operation/getSnapshotManifest","tag/snapshot/operation/updateSnapshotManifest","tag/snapshot/operation/getSnapshot","tag/snapshot/operation/createSnapshot","tag/snapshot/operation/deleteSnapshot","tag/snapshot/operation/publishSnapshotResource","tag/snapshot/operation/publishSnapshot","tag/config","tag/config/operation/getConfigOrg","tag/config/operation/updateConfigOrg","tag/config/operation/createConfigOrg","tag/config/operation/deleteConfigOrg","tag/config/operation/getConfigSite","tag/config/operation/updateConfigSite","tag/config/operation/createSiteSite","tag/config/operation/deleteConfigSite","tag/config/operation/getConfigProfile","tag/config/operation/updateConfigProfile","tag/config/operation/createConfigProfile","tag/config/operation/deleteConfigProfile","tag/config/operation/getConfigSecret","tag/config/operation/updateConfigSecret","tag/config/operation/createConfigSecret","tag/config/operation/deleteConfigSecret","tag/config/operation/getConfigUser","tag/config/operation/updateConfigUser","tag/config/operation/createConfigUser","tag/config/operation/deleteConfigUser"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.805]],["description/0",[0,0.813,1,4.073]],["title/1",[0,0.668,2,2.119]],["description/1",[0,0.679,2,2.155,3,1.306,4,2.823]],["title/2",[0,0.571,2,1.812,5,1.324]],["description/2",[0,0.648,2,0.815,4,1.068,5,0.596,6,1.287,7,1.545,8,2.154,9,1.287,10,2.154,11,1.287,12,1.287,13,2.154,14,1.287,15,1.287,16,2.154,17,1.287]],["title/3",[0,0.668,18,2.776]],["description/3",[0,0.583,3,1.122,18,2.424,19,2.923,20,1.492,21,2.096]],["title/4",[0,0.668,22,1.549]],["description/4",[0,0.554,3,0.494,7,0.923,20,0.657,21,0.923,22,0.997,23,1.287,24,1.287,25,1.068,26,0.815,27,1.287,28,1.287,29,1.287,30,0.923,31,0.923,32,0.923,33,0.923,34,0.923,35,0.923,36,1.068,37,1.068]],["title/5",[0,0.668,38,1.549]],["description/5",[0,0.494,3,0.585,7,1.093,20,0.778,21,1.093,25,1.264,26,0.965,30,1.093,31,1.093,32,1.093,33,1.093,34,1.093,35,1.093,36,1.264,37,1.264,38,1.146,39,1.093]],["title/6",[0,0.571,20,1.46,40,1.812]],["description/6",[0,0.389,20,1.301,26,0.725,30,0.821,31,0.821,32,0.821,33,0.821,34,0.821,35,0.821,39,0.821,40,1.236,41,0.95,42,1.145,43,0.95,44,0.95,45,0.95,46,0.95,47,0.95,48,1.618,49,0.95,50,0.53,51,1.145,52,1.145]],["title/7",[0,0.668,40,2.119]],["description/7",[0,0.526,20,0.84,26,1.042,39,1.18,40,1.042,41,1.365,43,1.365,44,1.365,45,1.365,46,1.365,47,1.365,48,2.184,49,1.365,50,0.761,53,1.645]],["title/8",[54,0.448]],["description/8",[]],["title/9",[54,0.318,55,1.62,56,1.62]],["description/9",[3,1.207,50,1.455,56,1.781,57,1.781,58,1.992]],["title/10",[5,1.324,54,0.318,56,1.62]],["description/10",[58,2.86]],["title/11",[22,1.324,54,0.318,56,1.62]],["description/11",[58,2.86]],["title/12",[38,1.324,54,0.318,56,1.62]],["description/12",[58,2.86]],["title/13",[54,0.318,55,1.62,59,1.62]],["description/13",[3,1.207,50,1.455,57,1.781,59,1.781,60,1.992]],["title/14",[5,1.324,54,0.318,59,1.62]],["description/14",[60,2.86]],["title/15",[22,1.324,54,0.318,59,1.62]],["description/15",[60,2.86]],["title/16",[38,1.324,54,0.318,59,1.62]],["description/16",[60,2.86]],["title/17",[54,0.318,55,1.62,61,1.62]],["description/17",[3,1.207,50,1.455,57,1.781,61,1.781,62,1.992]],["title/18",[5,1.324,54,0.318,61,1.62]],["description/18",[62,2.86]],["title/19",[22,1.324,54,0.318,61,1.62]],["description/19",[62,2.86]],["title/20",[38,1.324,54,0.318,61,1.62]],["description/20",[62,2.86]],["title/21",[54,0.318,55,1.62,63,1.62]],["description/21",[3,1.207,50,1.455,57,1.781,63,1.781,64,1.992]],["title/22",[5,1.324,54,0.318,63,1.62]],["description/22",[64,2.86]],["title/23",[22,1.324,54,0.318,63,1.62]],["description/23",[64,2.86]],["title/24",[38,1.324,54,0.318,63,1.62]],["description/24",[64,2.86]],["title/25",[54,0.318,55,1.62,65,1.62]],["description/25",[3,1.207,50,1.455,57,1.781,65,1.781,66,1.992]],["title/26",[5,1.324,54,0.318,65,1.62]],["description/26",[66,2.86]],["title/27",[22,1.324,54,0.318,65,1.62]],["description/27",[66,2.86]],["title/28",[38,1.324,54,0.318,65,1.62]],["description/28",[66,2.86]]],"invertedIndex":[["",{"_index":33,"title":{},"description":{"4":{},"5":{},"6":{}}}],["409",{"_index":36,"title":{},"description":{"4":{},"5":{}}}],["_byo_",{"_index":49,"title":{},"description":{"6":{},"7":{}}}],["_live_",{"_index":47,"title":{},"description":{"6":{},"7":{}}}],["addition",{"_index":45,"title":{},"description":{"6":{},"7":{}}}],["allow",{"_index":6,"title":{},"description":{"2":{}}}],["below",{"_index":27,"title":{},"description":{"4":{}}}],["cdn",{"_index":48,"title":{},"description":{"6":{},"7":{}}}],["config",{"_index":54,"title":{"8":{},"9":{},"10":{},"11":{},"12":{},"13":{},"14":{},"15":{},"16":{},"17":{},"18":{},"19":{},"20":{},"21":{},"22":{},"23":{},"24":{},"25":{},"26":{},"27":{},"28":{}},"description":{}}],["config/{org}.json",{"_index":58,"title":{},"description":{"9":{},"10":{},"11":{},"12":{}}}],["config/{org}/profiles/{profile}.json",{"_index":62,"title":{},"description":{"17":{},"18":{},"19":{},"20":{}}}],["config/{org}/secrets/{secret}.json",{"_index":64,"title":{},"description":{"21":{},"22":{},"23":{},"24":{}}}],["config/{org}/sites/{site}.json",{"_index":60,"title":{},"description":{"13":{},"14":{},"15":{},"16":{}}}],["config/{org}/users.json",{"_index":66,"title":{},"description":{"25":{},"26":{},"27":{},"28":{}}}],["configur",{"_index":50,"title":{},"description":{"6":{},"7":{},"9":{},"13":{},"17":{},"21":{},"25":{}}}],["content",{"_index":42,"title":{},"description":{"6":{}}}],["content-bu",{"_index":39,"title":{},"description":{"5":{},"6":{},"7":{}}}],["copi",{"_index":41,"title":{},"description":{"6":{},"7":{}}}],["creat",{"_index":22,"title":{"4":{},"11":{},"15":{},"19":{},"23":{},"27":{}},"description":{"4":{}}}],["delet",{"_index":38,"title":{"5":{},"12":{},"16":{},"20":{},"24":{},"28":{}},"description":{"5":{}}}],["end",{"_index":32,"title":{},"description":{"4":{},"5":{},"6":{}}}],["entir",{"_index":34,"title":{},"description":{"4":{},"5":{},"6":{}}}],["folder",{"_index":29,"title":{},"description":{"4":{}}}],["includ",{"_index":14,"title":{},"description":{"2":{}}}],["level",{"_index":57,"title":{},"description":{"9":{},"13":{},"17":{},"21":{},"25":{}}}],["live",{"_index":44,"title":{},"description":{"6":{},"7":{}}}],["live:writ",{"_index":17,"title":{},"description":{"2":{}}}],["locat",{"_index":43,"title":{},"description":{"6":{},"7":{}}}],["lock",{"_index":7,"title":{},"description":{"2":{},"4":{},"5":{}}}],["manifest",{"_index":2,"title":{"1":{},"2":{}},"description":{"1":{},"2":{}}}],["need",{"_index":13,"title":{},"description":{"2":{}}}],["note",{"_index":9,"title":{},"description":{"2":{}}}],["oper",{"_index":1,"title":{},"description":{"0":{}}}],["order",{"_index":10,"title":{},"description":{"2":{}}}],["organis",{"_index":56,"title":{"9":{},"10":{},"11":{},"12":{}},"description":{"9":{}}}],["param",{"_index":31,"title":{},"description":{"4":{},"5":{},"6":{}}}],["partit",{"_index":26,"title":{},"description":{"4":{},"5":{},"6":{},"7":{}}}],["path",{"_index":30,"title":{},"description":{"4":{},"5":{},"6":{}}}],["path'",{"_index":51,"title":{},"description":{"6":{}}}],["permiss",{"_index":16,"title":{},"description":{"2":{}}}],["preview",{"_index":25,"title":{},"description":{"4":{},"5":{}}}],["preview:writ",{"_index":15,"title":{},"description":{"2":{}}}],["profil",{"_index":61,"title":{"17":{},"18":{},"19":{},"20":{}},"description":{"17":{}}}],["publish",{"_index":40,"title":{"6":{},"7":{}},"description":{"6":{},"7":{}}}],["purg",{"_index":46,"title":{},"description":{"6":{},"7":{}}}],["read",{"_index":55,"title":{"9":{},"13":{},"17":{},"21":{},"25":{}},"description":{}}],["request",{"_index":11,"title":{},"description":{"2":{}}}],["resourc",{"_index":20,"title":{"6":{}},"description":{"3":{},"4":{},"5":{},"6":{},"7":{}}}],["respect",{"_index":19,"title":{},"description":{"3":{}}}],["respons",{"_index":37,"title":{},"description":{"4":{},"5":{}}}],["return",{"_index":3,"title":{},"description":{"1":{},"3":{},"4":{},"5":{},"9":{},"13":{},"17":{},"21":{},"25":{}}}],["role",{"_index":12,"title":{},"description":{"2":{}}}],["secret",{"_index":63,"title":{"21":{},"22":{},"23":{},"24":{}},"description":{"21":{}}}],["site",{"_index":59,"title":{"13":{},"14":{},"15":{},"16":{}},"description":{"13":{}}}],["snapshot",{"_index":0,"title":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{}},"description":{"0":{},"1":{},"2":{},"3":{},"4":{},"5":{},"6":{},"7":{}}}],["snapshot/snapshotid",{"_index":28,"title":{},"description":{"4":{}}}],["snapshot/{owner}/{repo}/main/{snapshotid",{"_index":4,"title":{},"description":{"1":{},"2":{}}}],["snapshot/{owner}/{repo}/main/{snapshotid}/{path",{"_index":21,"title":{},"description":{"3":{},"4":{},"5":{}}}],["snapshot/{owner}/{repo}/main/{snapshotid}/{path}?publish=tru",{"_index":52,"title":{},"description":{"6":{}}}],["snapshot/{owner}/{repo}/main/{snapshotid}?publish=tru",{"_index":53,"title":{},"description":{"7":{}}}],["specifi",{"_index":23,"title":{},"description":{"4":{}}}],["statu",{"_index":18,"title":{"3":{}},"description":{"3":{}}}],["store",{"_index":24,"title":{},"description":{"4":{}}}],["subtre",{"_index":35,"title":{},"description":{"4":{},"5":{},"6":{}}}],["unlock",{"_index":8,"title":{},"description":{"2":{}}}],["updat",{"_index":5,"title":{"2":{},"10":{},"14":{},"18":{},"22":{},"26":{}},"description":{"2":{}}}],["user",{"_index":65,"title":{"25":{},"26":{},"27":{},"28":{}},"description":{"25":{}}}]],"pipeline":[]}},"options":{}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);
diff --git a/docs/admin.html b/docs/admin.html
index 7315ba09..8a3cd541 100644
--- a/docs/admin.html
+++ b/docs/admin.html
@@ -420,7 +420,7 @@
           55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
           -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
           -104.0616 -231.873,-231.248 z
-        " fill="currentColor"></path></g></svg></div></div><div class="sc-dwcvcB dPIjnf api-content"><div class="sc-eCstZk kxmVZO"><div class="sc-iBPTVF keMybc"><div class="sc-hKgKIp gvoNGN api-info"><h1 class="sc-fubDmA sc-eGCbyA djltfY hWeMwQ">AEM Admin API<!-- --> <span>(<!-- -->11.31.2<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-ctaXUJ gUXnfH">Download</a></p><div class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG"><div class="sc-bsioJn jddSMs"><div class="sc-gIntVs cWZmJq"> <!-- --> <span class="sc-dFJsne hlKxkW">License:<!-- --> <a href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache 2.0</a></span> </div></div></div><div data-role="redoc-summary" html="" class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG"></div><div data-role="redoc-description" html="&lt;p&gt;AEM Admin API is used to manage the lifecycle of content and code.&lt;/p&gt;
+        " fill="currentColor"></path></g></svg></div></div><div class="sc-dwcvcB dPIjnf api-content"><div class="sc-eCstZk kxmVZO"><div class="sc-iBPTVF keMybc"><div class="sc-hKgKIp gvoNGN api-info"><h1 class="sc-fubDmA sc-eGCbyA djltfY hWeMwQ">AEM Admin API<!-- --> <span>(<!-- -->11.31.3<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-ctaXUJ gUXnfH">Download</a></p><div class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG"><div class="sc-bsioJn jddSMs"><div class="sc-gIntVs cWZmJq"> <!-- --> <span class="sc-dFJsne hlKxkW">License:<!-- --> <a href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache 2.0</a></span> </div></div></div><div data-role="redoc-summary" html="" class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG"></div><div data-role="redoc-description" html="&lt;p&gt;AEM Admin API is used to manage the lifecycle of content and code.&lt;/p&gt;
 " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG"><p>AEM Admin API is used to manage the lifecycle of content and code.</p>
 </div></div></div></div><div id="tag/status" data-section-id="tag/status" class="sc-eCstZk kxmVZO"><div class="sc-iBPTVF keMybc"><div class="sc-hKgKIp gvoNGN"><h1 class="sc-fubDmA djltfY"><a class="sc-crrtmM jGBpue" href="#tag/status" aria-label="tag/status"></a>status</h1></div></div><div class="sc-hKgKIp jIkZBx"><div class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG redoc-markdown " html="&lt;p&gt;Status operations&lt;/p&gt;
 "><p>Status operations</p>
@@ -1186,7 +1186,7 @@
 " class="sc-iJuWdM sc-cBNeRQ gpkGbA casAkG"><p>This posts one entry to the audit log. To see what the added entry would look like, see the second entry in the <a href="#tag/log/operation/getLogs">getLog</a> example.</p>
 </div><div class="sc-cTkyaV gLzJQv"><div class="sc-giInvV bIDavi"><button><div class="sc-jcVcfa iVrxDL">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iJuWdM gpkGbA sc-jNMdxs jXmkAn"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"entries"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">[</span><span class="ellipsis"></span><ul class="array collapsible"><li><div class="hoverable collapsed"><button class="collapser" aria-label="expand"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"event"</span>: <span class="token string">&quot;dinner is ready&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">]</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div></div></div></div></div></div></div><div class="sc-jtHLPo gfiMgB"></div></div></div>
       <script>
-      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"version":"11.31.2","title":"AEM Admin API","description":"AEM Admin API is used to manage the lifecycle of content and code.","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://admin.hlx.page"}],"tags":[{"name":"status","description":"Status operations"},{"name":"publish","description":"Publish operations"},{"name":"preview","description":"Preview operations"},{"name":"code","description":"Code bus operations"},{"name":"cache","description":"Cache operations"},{"name":"index","description":"Index operations"},{"name":"authentication","description":"Authentication operations"},{"name":"form","description":"Form operations"},{"name":"sitemap","description":"Sitemap operations"},{"name":"convert","description":"Convert operations"},{"name":"job","description":"Job operations"},{"name":"log","description":"Log operations"}],"paths":{"/status/{owner}/{repo}/{ref}/{path}":{"get":{"operationId":"status","tags":["status"],"summary":"General status","description":"Returns the overall status of the respective resource.","security":[{},{"AuthCookie":["preview:read","live:read","code:read","edit:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/statusEditUrlParam"}],"responses":{"200":{"description":"The overall status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/previewInfo"},{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/editInfo"},{"$ref":"#/components/schemas/codeInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"},{"$ref":"#/components/schemas/profileInfo"}]},"examples":{"success":{"description":"Success response of a preview document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","contentBusId":"helix-content-bu/h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md","permissions":["read"]},"preview":{"status":200,"url":"https://main--repo--owner.hlx.page/en/2021/blog","lastModified":"2021-05-31T23:00:00Z","contentBusId":"helix-content-bu/h3-theblog-123ab123ab12ab123a12b3a/preview/en/2021/blog.md","permissions":["read","write"]},"edit":{"status":200,"url":"https://adobe.sharepoint.com/","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","lastModified":"2021-05-29T21:00:00Z"},"code":{"status":404,"codeBusId":"helix-code-bus/adobe/blog/main/blog.md","permissions":["read"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/status/{owner}/{repo}/{ref}/*":{"post":{"operationId":"bulkStatus","tags":["status"],"summary":"Start a bulk status job","description":"Fetches the status of all resources specified in the `paths` property in the payload. If a path ends with `/*`, it is assumed to be a folder and is recursively processed.<br><br> The response will contain the folliowing information about a resource: `path`, `sourceLastModified`, `previewLastModified` and `publishLastModified`. It is possible to filter the information returned, by passing a combination of `edit`, `preview` and `live` in the `select` property in the payload.<br><br> Note that the bulk status is performed asynchronously and the response will contain information about the created [job](#tag/job).\n","security":[{},{"AuthCookie":["edit:list","preview:list","live:list"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkStatusBody"},"examples":{"multiple-paths":{"$ref":"#/components/examples/example"}}}}},"responses":{"202":{"description":"Bulk status scheduled.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobCreated"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"status":202,"messageId":"37e92eec-020c-4eae-8f80-3db444c25056","job":{"topic":"status","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","data":{"paths":[{"prefix":"/en/"},{"path":"/en"},{"path":"/blog/"}]}},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/status/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/status"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/live/{owner}/{repo}/{ref}/{path}":{"get":{"operationId":"getPublishStatus","tags":["publish"],"summary":"Publish Status","description":"Returns the publish status of the respective resource.","security":[{"AuthCookie":["live:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"The publish status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of a published document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}},"post":{"operationId":"publishResource","tags":["publish"],"summary":"Publish a resource","description":"Publish a resource by copying the resource content from the `preview` content-bus partition to the `live` content-bus partition. It additionally purges the _live_ cdn and the _byo_ cdn, if configured.\n","security":[{"AuthCookie":["preview:read","live:read","live:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/forceUpdateRedirectsParam"},{"$ref":"#/components/parameters/disableNotificationsParam"}],"responses":{"200":{"description":"Resource published.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of the published document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read","write"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"unpublishResource","tags":["publish"],"summary":"Un-publish a resource","description":"Un-publish a resource by deleting the content from from the `live` content-bus partition. It additionally purges the _live_ cdn and the _byo_ cdn, if configured.\n","security":[{"AuthCookie":["live:read","live:delete"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/disableNotificationsParam"}],"responses":{"204":{"description":"Resource unpublished"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/live/{owner}/{repo}/{ref}/*":{"post":{"operationId":"bulkPublish","tags":["publish"],"summary":"Start a bulk publish job","description":"Updates live resources specified in the `paths` property in the payload.<br> By default, only new and modified resources are updated, unless the `forceUpdate` property is set to `true`.<br> Note that configuration files, like `/.helix/config` or `redirects.json`, are always ignored during bulk publish.<br> Note that the bulk publish is performed asynchronously and this request will return information to the created job.\n","security":[{"AuthCookie":["preview:list","preview:read","preview:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkPublishBody"},"examples":{"multiple-paths":{"$ref":"#/components/examples/bulk-publish-payload_example"}}}}},"responses":{"202":{"description":"Bulk publish scheduled.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobCreated"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"status":202,"messageId":"37e92eec-020c-4eae-8f80-3db444c25056","job":{"topic":"publish","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","data":{"paths":[{"path":"/en"},{"path":"/blog/"},{"path":"/metadata.json"}]}},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/publish/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/publish"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/preview/{owner}/{repo}/{ref}/{path}":{"get":{"operationId":"previewStatus","tags":["preview"],"summary":"Preview status","description":"Returns the preview status of the respective resource.","security":[{"AuthCookie":["preview:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"The preview status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/previewInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of a preview document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","preview":{"status":200,"url":"https://main--repo--owner.hlx.page/en/2021/blog","lastModified":"2021-05-31T23:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/preview/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}},"post":{"operationId":"updatePreview","tags":["preview"],"summary":"Update preview","description":"Updates the preview resource by fetching the latest content from the content providers (e.g. content-proxy) and storing it in the `preview` content-bus partition.\n","security":[{"AuthCookie":["edit:read","preview:read","preview:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/forceUpdateRedirectsParam"},{"$ref":"#/components/parameters/word2mdVersionParam"},{"$ref":"#/components/parameters/gdocs2mdVersionParam"},{"$ref":"#/components/parameters/html2mdVersionParam"}],"responses":{"200":{"description":"Preview resource updated.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/previewInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","preview":{"status":200,"url":"https://main--repo--owner.hlx.page/en/2021/blog","lastModified":"2021-05-31T23:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/preview/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read","write"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deletePreview","tags":["preview"],"summary":"Delete preview","description":"Deletes a preview resource from the `preview` partition in the content-bus..\n","security":[{"AuthCookie":["preview:read","preview:delete"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/preview/{owner}/{repo}/{ref}/*":{"post":{"operationId":"bulkPreview","tags":["preview"],"summary":"Start a bulk preview job","description":"Updates preview resources specified in the `paths` property in the payload. If a path ends with `/*`, it is assume to be folder and is recursively previewed.<br> By default, only new and modified resources are updated, unless the `forceUpdate` property is set to `true`.<br> Note that configuration files, like `/.helix/config` or `redirects.json`, are always ignored during bulk preview.<br> Note that the bulk preview is performed asynchronously and this request will return information to the created job.\n","security":[{"AuthCookie":["edit:read","edit:list","preview:read","preview:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/word2mdVersionParam"},{"$ref":"#/components/parameters/gdocs2mdVersionParam"},{"$ref":"#/components/parameters/html2mdVersionParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkPreviewBody"},"examples":{"multiple-paths":{"$ref":"#/components/examples/bulk-preview-payload_example"}}}}},"responses":{"202":{"description":"Bulk preview scheduled.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobCreated"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"status":202,"messageId":"37e92eec-020c-4eae-8f80-3db444c25056","job":{"topic":"preview","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","data":{"paths":["/documents"]}},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/preview"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/code/{owner}/{repo}/{ref}/{path}":{"get":{"operationId":"codeStatus","tags":["code"],"summary":"Code bus status","description":"Returns the code bus status of the respective resource.","security":[{},{"AuthCookie":["code:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/branchParam"}],"responses":{"200":{"description":"The code-bus status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/codeInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of a code document.","value":{"webPath":"/scripts.js","resourcePath":"/scripts.js","live":{"url":"https://main--repo--owner.hlx.live/scripts.js"},"preview":{"url":"https://main--repo--owner.hlx.page/scripts.js"},"edit":{"url":"https://github.com/owner/repo/tree/main/scripts.js"},"code":{"status":200,"lastModified":"2021-05-31T23:00:00Z","sourceLastModified":"2021-05-29T21:00:00Z","codeBusId":"helix-code-bus/owner/repo/main/scripts.js","permissions":["read"]},"links":{"status":"https://admin.hlx.page/status/owner/repo/main/scripts.js","preview":"https://admin.hlx.page/preview/owner/repo/main/scripts.js","live":"https://admin.hlx.page/live/owner/repo/main/scripts.js","code":"https://admin.hlx.page/code/owner/repo/main/scripts.js"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}},"post":{"operationId":"updateCode","tags":["code"],"summary":"Update code","description":"Updates the code-bus resource by fetching the latest content from github and storing it in the code-bus. If the last path segment is a `*`, it will recursively update the code-bus with the respective github tree (directory). It additionally purges the _live_ cdn and the _byo_ cdn, if configured.\n","security":[{},{"AuthCookie":["code:read","code:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/branchParam"}],"responses":{"200":{"description":"Code resource updated.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/codeInfo"}]}},"examples":{"success":{"description":"Success response.","value":[{"live":{"url":"https://main--repo--owner.hlx.live/scripts.js"},"code":{"status":200,"lastModified":"2021-05-31T23:00:00Z","codeBusId":"helix-code-bus/owner/repo/main/scripts.js","permissions":["read","write"]}}]}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteCode","tags":["code"],"summary":"Delete code","description":"Deletes a code resource from the code-bus It additionally purges the _live_ cdn and the _byo_ cdn, if configured.\n","security":[{"AuthCookie":["code:read","delete:code"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/branchParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/code/{owner}/{repo}/{ref}":{"post":{"operationId":"batchCode","tags":["code"],"summary":"Batch update code","description":"Processes a change event and updates the code-bus accordingly. It additionally purges the _live_ cdn and the _byo_ cdn, if configured.\n","security":[{},{"AuthCookie":["code:read","code:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/changeEventBody"},"examples":{"multiple-files":{"$ref":"#/components/examples/change-event-payload_example"}}}}},"responses":{"200":{"description":"Code resource updated.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/codeInfo"}]}},"examples":{"success":{"description":"Success response.","value":[{"live":{"url":"https://main--repo--owner.hlx.live/scripts.js"},"code":{"status":200,"lastModified":"2021-05-31T23:00:00Z","codeBusId":"helix-code-bus/owner/repo/main/scripts.js","permissions":["read","write"]}}]}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/cache/{owner}/{repo}/{ref}/{path}":{"post":{"operationId":"purgeCache","tags":["cache"],"summary":"Purge live cache","description":"Purges the resource from the respective _live_ cdn. It optionally invokes the _byo_ cdn purging hook, if configured (todo).\n","security":[{},{"AuthCookie":["cache:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"Successful purge response"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/index/{owner}/{repo}/{ref}/{path}":{"get":{"operationId":"getIndexStatus","tags":["index"],"summary":"Index Status","description":"Returns the index status of the respective resource.","security":[{},{"AuthCookie":["index:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"The index status of a resource","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/indexInfo"}]},"examples":{"success":{"description":"Success response of an index document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","index":{"name":"blog","githubLink":"https://github.com/owner/repo/blob/main/helix-index.yaml#L4","indexedUrl":"https://main--owner--repo.hlx.live/en/2021/blog","lastModified":"Tue, 01 Mar 2022 08:32:01 GMT"}}}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"description":"Resource not found or not in index definition.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"$ref":"#/components/responses/500"}}},"post":{"operationId":"indexResource","tags":["index"],"summary":"Re-index a resource.","description":"Index a resource. If the last path segment is a `*`, it will recursively reindex all published resources below that sub tree.\n","security":[{},{"AuthCookie":["index:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"Re-index of resource triggered.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/indexInfo"}]},"examples":{"success":{"description":"Success response of indexing a resource.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","index":{"name":"blog","githubLink":"https://github.com/owner/repo/blob/main/helix-index.yaml#L4","indexedUrl":"https://main--owner--repo.hlx.live/en/2021/blog","lastModified":"Tue, 01 Mar 2022 08:32:01 GMT"}}}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"description":"Resource not found or not in index definition.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"indexRemovePage","tags":["index"],"summary":"Remove a resource from the index.","description":"Removes a resource from the index.\n","security":[{},{"AuthCookie":["index:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"Removal of resource in the index triggered.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/indexInfo"}]},"examples":{"success":{"description":"Success response of removing a resource from the index.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","index":{"name":"blog","status":202}}}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"description":"Resource not found or not in index definition.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"$ref":"#/components/responses/500"}}}},"/login":{"get":{"operationId":"login","tags":["authentication"],"summary":"Login Selection","description":"Provides a selection of available IDP logins","security":[{}],"responses":{"200":{"description":"Display links to IDP specific logins","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/loginLinks"}]},"examples":{"success":{"description":"Success response.","value":{"links":{"login_microsoft":"https://admin.hlx.page/auth/adobe","login_google":"https://admin.hlx.page/auth/google"}}},"loggedin":{"description":"Success response when logged in","value":{"links":{"logout":"https://admin.hlx.page/logout"}}}}}}}}}},"/login/{owner}/{repo}/{ref}":{"get":{"operationId":"login-repo","tags":["authentication"],"summary":"Auto login","description":"Redirects to IDP corresponding the project setup","security":[{}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"}],"responses":{"302":{"description":"Redirects to the IDP authorization endpoint","headers":{"location":{"$ref":"#/components/headers/location"}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}},"/logout":{"get":{"operationId":"logout","tags":["authentication"],"summary":"Logout","description":"Logs out the current session and redirects to the login screen","security":[{}],"responses":{"302":{"description":"Redirects to /login","headers":{"location":{"$ref":"#/components/headers/location"}}}}}},"/profile":{"get":{"operationId":"profile","tags":["authentication"],"summary":"Profile information","description":"Display profile information","security":[{},{"AuthCookie":["profile:read"]}],"responses":{"200":{"description":"Show profile information of logged in user","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/profileInfo"},{"$ref":"#/components/schemas/logoutLink"}]},"examples":{"success":{"description":"Success response.","value":{"profile":{"iss":"urn:example:issuer","email":"test@example.com","name":"Test User","ttl":7200},"links":{"logout":"https://admin.hlx.page/logout"}}}}}}}}}},"/form/{owner}/{repo}/{ref}/{path}":{"post":{"operationId":"formCreation","tags":["form"],"summary":"Create form","description":"Prepares a sheet for data ingestion. Creates the necessary tables/headers to ingest the form data contained in the post body. A sheet named 'incoming' must be manually created (and previewed) in the target workbook before calling this API, doing so signals to the forms service that you approve this sheet to be used to intake data. If the workbook does not contain a shared-default or a slack sheet then they are also created.\nThe path to the sheet must contain the .json extension.\n","security":[{"AuthCookie":["forms:read","forms:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/formPostJSONBody"},"examples":{"kvObject":{"description":"Key/value object request body","value":{"data":{"firstName":"Bruce","lastName":"Banner"}}},"nvArray":{"description":"Name/value array request body","value":{"data":[{"name":"firstName","value":"Bruce"},{"name":"lastName","value":"Banner"}]}}}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/formPostURLEncodedBody"},"examples":{"success":{"description":"Request body","value":"Rating=3&Comment=little%20free&Locale=en-us"}}}}},"responses":{"200":{"description":"The sheet has been prepared for data ingestion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/formPostResponse"},"examples":{"success":{"description":"Success response.","value":{"rowCount":1,"columns":["header1","header2"]}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"405":{"$ref":"#/components/responses/405"},"503":{"description":"A 503 likely means that the forms service took too long to prepare the sheet and the gateway timed out after 30 seconds. Note that even though a 503 is returned the forms service should still successfully prepare the sheet for data intake.\n"}}}},"/sitemap/{owner}/{repo}/{ref}/{path}":{"post":{"operationId":"generateSitemap","tags":["sitemap"],"summary":"Generates a sitemap","description":"Generates a sitemap. The path specified should be the destination path of a sitemap.\n","security":[{}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"Sitemap generated.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/sitemapInfo"}]},"examples":{"success":{"description":"Success response of generating a sitemap","value":{"paths":["/sitemap.xml"]}}}}}},"204":{"description":"Path specified is no destination for any sitemap configured"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"description":"No sitemap configuration found","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"$ref":"#/components/responses/500"}}}},"/convert/{owner}/{repo}/{ref}":{"post":{"operationId":"convertStart","tags":["convert"],"summary":"Start convert","description":"Start a video conversion job.\n","security":[{"AuthCookie":["convert:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/convertUrlParam"}],"responses":{"200":{"description":"Convert job started.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobStarted"}]},"examples":{"success":{"description":"Success response.","value":{"id":"69985ac8-fc98-4f69-8972-0168cfe7bbe6"}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/convert/{owner}/{repo}/{ref}/${id}":{"get":{"operationId":"convertStatus","tags":["convert"],"summary":"Convert status","description":"Returns the current status of a convert job\n","security":[{"AuthCookie":["convert:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/convertIdParam"}],"responses":{"200":{"description":"The convert job status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobInfo"}]},"examples":{"success":{"description":"Success response of a job status.","value":{"next":"s3Upload","state":"STARTED"}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/job/{owner}/{repo}/{ref}/{topic}":{"get":{"operationId":"getJobList","tags":["job"],"summary":"Job List","description":"Returns the job list of jobs","security":[{"AuthCookie":["job:list"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/topicParam"}],"responses":{"200":{"description":"The Job List","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobList"},{"$ref":"#/components/schemas/jobListLink"}]},"examples":{"success":{"description":"Success response of a job list.","value":{"topic":"preview","jobs":[{"name":"job-123","state":"created","time":"2021-05-31T23:00:00Z","href":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123"},{"name":"job-124","state":"running","time":"2021-04-31T23:00:00Z","href":"https://admin.hlx.page/job/adobe/blog/main/preview/job-124"}],"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/job/{owner}/{repo}/{ref}/{topic}/{jobName}":{"get":{"operationId":"getJob","tags":["job"],"summary":"Job Status","description":"Returns the job status","security":[{"AuthCookie":["job:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/topicParam"},{"$ref":"#/components/parameters/jobNameParam"}],"responses":{"202":{"description":"The Job Status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobStatus"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"topic":"preview","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","progress":{"total":10,"processed":0,"failed":0},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123","details":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123/details","list":"https://admin.hlx.page/job/adobe/blog/main/preview"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}},"delete":{"operationId":"stopJob","tags":["job"],"summary":"Stop job","description":"Stops a job.","security":[{"AuthCookie":["job:read","job:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/topicParam"},{"$ref":"#/components/parameters/jobNameParam"}],"responses":{"204":{"description":"Job stopped."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}},"/job/{owner}/{repo}/{ref}/{topic}/{jobName}/details":{"get":{"operationId":"getJobDetails","tags":["job"],"summary":"Job Status Details","description":"Returns the job status","security":[{"AuthCookie":["job:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/topicParam"},{"$ref":"#/components/parameters/jobNameParam"}],"responses":{"202":{"description":"The Job Status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobStatusDetails"},{"$ref":"#/components/schemas/jobLinksInfoDetails"}]},"examples":{"success":{"description":"Success response.","value":{"topic":"preview","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","progress":{"total":10,"processed":6,"failed":4},"data":{"paths":["/documents"]},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123/details","job":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/preview"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/log/{owner}/{repo}/{ref}":{"get":{"operationId":"getLogs","tags":["log"],"summary":"Returns logs","description":"Returns logs for a project","security":[{"AuthCookie":["log:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/fromParam"},{"$ref":"#/components/parameters/toParam"},{"$ref":"#/components/parameters/nextTokenParam"}],"responses":{"200":{"description":"Log statements","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logResult"},"examples":{"success":{"description":"Success response of a log request.","value":{"from":"2023-11-07T14:00:00.000Z","to":"2023-11-07T16:15:12.454Z","entries":[{"timestamp":1699368094644,"duration":467,"status":201,"method":"POST,","route":"preview","path":"/my-page","contentBusId":"xyz","owner":"owner","repo":"repo","ref":"ref"},{"timestamp":1699372505155,"event":"dinner is ready","contentBusId":"xyz","owner":"owner","repo":"repo","ref":"ref"}],"nextToken":"ABAB=="}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}},"post":{"operationId":"addLogs","tags":["log"],"summary":"Add logs","description":"Add logs to a project. The body should be in JSON format and contain an array called `entries`.\n","security":[{"AuthCookie":["log:read","log:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logEntriesBody"},"examples":{"multiple-entries":{"description":"This posts one entry to the audit log. To see what the added entry would look like, see the second entry in the [getLog](#tag/log/operation/getLogs) example.\n","value":{"entries":[{"event":"dinner is ready"}]}}}}}},"responses":{"201":{"description":"Logs added."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}}},"components":{"securitySchemes":{"AuthCookie":{"type":"apiKey","in":"cookie","name":"auth_token"},"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"ownerParam":{"name":"owner","in":"path","description":"Repository owner.","required":true,"schema":{"type":"string"}},"repoParam":{"name":"repo","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},"refParam":{"name":"ref","in":"path","description":"Ref (branch) of repository.","required":true,"schema":{"type":"string"}},"pathParam":{"name":"path","in":"path","description":"Relative path of the resource","required":true,"schema":{"type":"string"}},"statusEditUrlParam":{"name":"editUrl","in":"query","description":"Optional URL of the edit (authoring) document","required":false,"schema":{"oneOf":[{"type":"string","format":"url"},{"type":"string","enum":["auto"]}]}},"forceUpdateRedirectsParam":{"name":"forceUpdateRedirects","in":"query","description":"forces an update of the redirects (only applies when updating/publishing redirects.json)","required":false,"schema":{"type":"boolean"}},"disableNotificationsParam":{"name":"disableNotifications","in":"query","description":"disables notifications for affected resources","schema":{"type":"boolean"}},"word2mdVersionParam":{"name":"hlx-word2md-version","in":"query","description":"selects the version to use when invoking the word2md service.","required":false,"schema":{"type":"string"}},"gdocs2mdVersionParam":{"name":"hlx-gdocs2md-version","in":"query","description":"selects the version to use when invoking the gdocs2md service.","required":false,"schema":{"type":"string"}},"html2mdVersionParam":{"name":"hlx-html2md-version","in":"query","description":"selects the version to use when invoking the html2md service.","required":false,"schema":{"type":"string"}},"branchParam":{"name":"branch","in":"query","description":"Optional branch specifier in case the branch name contains slashes or uppercase characters.","required":false,"schema":{"oneOf":[{"type":"string","format":"url"},{"type":"string","enum":["auto"]}]}},"convertUrlParam":{"name":"url","in":"query","description":"URL of video to convert","required":true,"schema":{"type":"string"}},"convertIdParam":{"name":"id","in":"path","description":"conversion job Id","required":true,"schema":{"type":"string"}},"topicParam":{"name":"topic","in":"path","description":"Topic of a job","required":true,"schema":{"type":"string"}},"jobNameParam":{"name":"jobName","in":"path","description":"Name of a job","required":true,"schema":{"type":"string"}},"fromParam":{"name":"from","in":"query","description":"Indicates the starting date to get logs from. If not specified, uses the current date minus 15 minutes.\n","required":false,"schema":{"type":"string"}},"toParam":{"name":"to","in":"query","description":"Indicates the ending date to get logs from. If not specified, uses the current date.\n","required":false,"schema":{"type":"string"}},"nextTokenParam":{"name":"nextToken","in":"query","description":"Token returned from a previous call to continue\n","required":false,"schema":{"type":"string"}}},"schemas":{"resourceInfo":{"required":["webPath","resourcePath"],"properties":{"webPath":{"description":"Relative path used on the websites.","type":"string"},"resourcePath":{"description":"Relative path of the content resource","type":"string"}}},"permissions":{"description":"Access permissions","required":["permissions"],"properties":{"permissions":{"type":"array","items":{"type":"string","enum":["read","write","delete"]}}}},"contentBusResource":{"required":["contentBusId"],"properties":{"contentBusId":{"description":"Full content-bus id.","type":"string"},"lastModified":{"description":"Last modification date. undefined when resource is missing.","type":"string","format":"date-time"},"contentType":{"description":"The resource content type. undefined when resource is missing.","type":"string"},"contentLength":{"description":"Size of the content in bytes. undefined when resource is missing.","type":"integer"},"redirectLocation":{"description":"Location for redirects as defined on the resource","type":"string","format":"url"},"configRedirectLocation":{"description":"Location for redirects as defined in the config (redirects.json)","type":"string","format":"url"},"sourceLocation":{"description":"Content provider specific id of the source.","type":"string","format":"url"},"sourceLastModified":{"description":"Last modification date of the source document.","type":"string","format":"date-time"}}},"liveInfo":{"required":["live"],"properties":{"live":{"description":"Information about the published resource.","allOf":[{"required":["url","status"]},{"properties":{"status":{"description":"HTTP status of response when fetching thre information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"},"url":{"description":"Live URL of the resource.","type":"string","format":"url"}}},{"$ref":"#/components/schemas/permissions"},{"$ref":"#/components/schemas/contentBusResource"}]}}},"previewInfo":{"required":["preview"],"properties":{"preview":{"description":"Information about the preview resource.","allOf":[{"required":["url","status"]},{"properties":{"status":{"description":"HTTP status of response when fetching the information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"},"url":{"description":"Preview URL of the resource.","type":"string","format":"url"}}},{"$ref":"#/components/schemas/permissions"},{"$ref":"#/components/schemas/contentBusResource"}]}}},"folderInfo":{"required":["name","path","url"],"properties":{"name":{"description":"Name of folder","type":"string"},"path":{"description":"Path of folder, relative to the mount root","type":"string"},"url":{"description":"URL of folder","type":"string","format":"url"}}},"editResource":{"description":"Edit information for a resource","properties":{"url":{"description":"URL of edit document.","type":"string","format":"url"},"sourceLocation":{"description":"Content provider specific id of the source","type":"string","format":"url"},"lastModified":{"description":"Last modification date of the source document.","type":"string","format":"date-time"},"name":{"description":"Name of the edit document","type":"string"},"contentType":{"description":"Content type of the edit document","type":"string"},"folders":{"description":"Information of parent folders of the edit document.","type":"array","items":{"$ref":"#/components/schemas/folderInfo"}}}},"editInfo":{"required":["edit"],"properties":{"edit":{"description":"Edit information for a resource","type":"object","allOf":[{"required":["url","status"]},{"properties":{"status":{"description":"HTTP status of response when fetching thre information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"}}},{"$ref":"#/components/schemas/editResource"}]}}},"codeBusResource":{"required":["codeBusId"],"properties":{"codeBusId":{"description":"Full code-bus id.","type":"string"},"lastModified":{"description":"Last modification date. undefined when resource is missing.","type":"string","format":"date-time"},"contentType":{"description":"The resource content type. undefined when resource is missing.","type":"string"},"contentLength":{"description":"Size of the content in bytes. undefined when resource is missing.","type":"integer"},"sourceLocation":{"description":"Content provider specific id of the source","type":"string","format":"url"},"sourceLastModified":{"description":"Last modification date of the source document.","type":"string","format":"date-time"}}},"codeInfo":{"required":["code"],"properties":{"code":{"description":"Information about a code bus resource","type":"object","allOf":[{"required":["status"]},{"properties":{"status":{"description":"HTTP status of response when fetching thre information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"}}},{"$ref":"#/components/schemas/codeBusResource"},{"$ref":"#/components/schemas/permissions"}]}}},"resourceLinksInfo":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"status":{"description":"link of the status api","example":"https://admin.hlx.page/status/owner/repo/ref","type":"string","format":"url"},"live":{"description":"link of the live api","example":"https://admin.hlx.page/live/owner/repo/ref","type":"string","format":"url"},"preview":{"description":"link of the preview api","example":"https://admin.hlx.page/preview/owner/repo/ref","type":"string","format":"url"},"code":{"description":"link of the code api","example":"https://admin.hlx.page/code/owner/repo/ref","type":"string","format":"url"}}}}},"profileInfo":{"properties":{"profile":{"description":"Profile data","additionalProperties":true,"properties":{"iss":{"description":"id token issuer","type":"string"},"email":{"description":"email of logged in user","type":"string"},"name":{"description":"name of logged in user","type":"string"},"ttl":{"description":"time to live of current id token","type":"number"}}}}},"bulkStatusBody":{"description":"bulk status body","required":["paths"],"properties":{"paths":{"description":"paths to filter the bulk status","type":"array","items":{"type":"string"}},"select":{"description":"a combination of `edit`, `preview` and `live`. The default is `['preview','live']`.","type":"array","items":{"type":"string"}}}},"jobStatus":{"required":["topic","name","state","startTime"],"properties":{"topic":{"description":"Job Topic","type":"string"},"name":{"description":"Job Name","type":"string"},"state":{"description":"Job State","type":"string"},"startTime":{"description":"Job start time","type":"string","format":"date-time"},"endTime":{"description":"Job end time","type":"string","format":"date-time"},"cancelled":{"description":"Flag indicating if job was cancelled","type":"boolean"},"data":{"description":"Custom job data","type":"object"},"progress":{"description":"job progress","type":"object"}}},"jobCreated":{"required":["messageId","job"],"properties":{"messageId":{"description":"Internal message id","type":"string"},"job":{"description":"Job state","type":"object","$ref":"#/components/schemas/jobStatus"}}},"jobLinksInfo":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"self":{"description":"link of the job api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13","type":"string","format":"url"},"details":{"description":"link of the job details api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13/details","type":"string","format":"url"},"list":{"description":"link of the job list","example":"https://admin.hlx.page/job/owner/repo/ref/preview","type":"string","format":"url"}}}}},"bulkPublishBody":{"description":"bulk publish body","required":["paths"],"properties":{"forceUpdate":{"description":"forces an update of the resources during bulk-publish","type":"boolean"},"paths":{"description":"paths to filter the bulk publish","type":"array","items":{"type":"string"}},"delete":{"description":"delete the resources from publish","type":"boolean","default":false}}},"bulkPreviewBody":{"description":"bulk preview body","required":["paths"],"properties":{"forceUpdate":{"description":"forces an update of the resources during bulk-preview","type":"boolean"},"paths":{"description":"paths to filter the bulk preview","type":"array","items":{"type":"string"}},"delete":{"description":"delete the resources from preview","type":"boolean","default":false}}},"changeEntry":{"description":"Describes the changes made to one resource.","required":["type","path"],"properties":{"type":{"description":"change type","type":"string","enum":["added","deleted","modified"]},"path":{"description":"Relative path of changed resource or `*` if this as a branch event.","type":"string"},"time":{"description":"timestamp of change","type":"string","format":"date-time"},"commit":{"description":"commit sha of change","type":"string"},"contentType":{"description":"the content type of the changed resource","type":"string"}}},"changeEventBody":{"description":"Change event payload","required":["changes"],"additionalProperties":true,"properties":{"source":{"description":"event source, eg: 'github'\n","type":"string"},"baseRef":{"description":"base ref for branch operations","type":"string"},"changes":{"description":"array of changes","type":"array","items":{"$ref":"#/components/schemas/changeEntry"}}}},"indexResource":{"description":"Information of the index","required":["name"],"properties":{"name":{"description":"Index name in helix-index.yaml","type":"string"},"githubLink":{"description":"Github url of the helix-index.yaml","example":"https://github.com/owner/repo/blob/main/helix-index.yaml#L4","type":"string","format":"url"},"indexedUrl":{"description":"URL of document that was indexed. Deprecation Note: The indexed html is always fetched from the preview/live url at the time of publishing and hence not required in helix-index.yaml anymore.\n","deprecated":true,"example":"https://main--owner--repo.hlx.page/en/2021/blog","type":"string","format":"url"},"lastModified":{"type":"string","format":"date-time"},"status":{"description":"status of index operation on resource","type":"number"}}},"indexInfo":{"required":["index"],"properties":{"index":{"description":"Information of the index","type":"object","$ref":"#/components/schemas/indexResource"}}},"loginLinks":{"required":["links"],"properties":{"links":{"description":"API navigation links","additionalProperties":{"type":"string","format":"url"}}}},"logoutLink":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"logout":{"description":"link of logout","example":"https://admin.hlx.page/logout","type":"string","format":"url"}}}}},"formPostJSONBody":{"description":"Form POST body","properties":{"data":{"description":"A data structure representing the form fields. Can be in the form of a key/value object, an array of name/value pair objects.\n","oneOf":[{"type":"object"},{"type":"array"}]}}},"formPostURLEncodedBody":{"description":"Form POST body as form-urlencoded string. Be sure to set the 'Content-Type' header of the request to `application/x-www-form-urlencoded`","type":"string"},"formPostResponse":{"type":"object","description":"Form POST response","properties":{"rowCount":{"description":"The number of rows contained in the sheet after the POST operation","type":"number"},"columns":{"description":"The column headings in the incoming sheet","type":"array","items":{"type":"string"}}}},"sitemapInfo":{"description":"Information for the sitemap that was generated","properties":{"paths":{"description":"Paths that were updated","type":"array","items":{"type":"string"}}}},"jobStarted":{"required":["id"],"properties":{"id":{"description":"Convert job id","type":"string"}}},"jobInfo":{"required":["state"],"properties":{"state":{"description":"Convert job state","type":"string"},"url":{"description":"Input URL","type":"string"},"outputs":{"description":"Transcoded videos","type":"array","items":{"type":"string"}},"mediaUrls":{"description":"URLs in the media bus","type":"array","items":{"type":"string"}}}},"jobList":{"required":["topic","jobs"],"properties":{"topic":{"description":"Job Topic","type":"string"},"jobs":{"description":"Jobs","type":"array","items":{"required":["name","state","time","href"],"description":"Job info","type":"object","properties":{"name":{"description":"Job name","type":"string"},"state":{"description":"Job State","type":"string"},"time":{"description":"Job creation time","type":"string","format":"date-time"},"href":{"description":"link of the job api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13","type":"string","format":"url"}}}}}},"jobListLink":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"self":{"description":"link of the job list","example":"https://admin.hlx.page/job/owner/repo/ref/preview","type":"string","format":"url"}}}}},"jobStatusDetails":{"required":["topic","name","state","startTime","data"],"properties":{"topic":{"description":"Job Topic","type":"string"},"name":{"description":"Job Name","type":"string"},"state":{"description":"Job State","type":"string"},"startTime":{"description":"Job start time","type":"string","format":"date-time"},"endTime":{"description":"Job end time","type":"string","format":"date-time"},"cancelled":{"description":"Flag indicating if job was cancelled","type":"boolean"},"data":{"description":"Custom job data","type":"object"},"progress":{"description":"job progress","type":"object"}}},"jobLinksInfoDetails":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"self":{"description":"link of the job details api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13/details","type":"string","format":"url"},"job":{"description":"link of the job api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13","type":"string","format":"url"},"list":{"description":"link of the job list","example":"https://admin.hlx.page/job/owner/repo/ref/preview","type":"string","format":"url"}}}}},"logResult":{"description":"Log result","required":["entries"],"properties":{"entries":{"description":"entries in that page","type":"array","items":{"type":"object"}},"nextToken":{"description":"token to pass in next call to continue paging","type":"string"},"from":{"description":"log start time","type":"string"},"to":{"description":"log end time","type":"string"}}},"logEntriesBody":{"description":"Add logs body","required":["entries"],"properties":{"entries":{"description":"entries to add to the logs","type":"array","items":{"type":"object"}}}}},"headers":{"xError":{"description":"A short descriptive error message","schema":{"format":"none","type":"string"}},"location":{"description":"The redirect location","schema":{"type":"string"}}},"responses":{"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}},"examples":{"example":{"summary":"fetch status of multiple files","value":{"select":["edit","preview","live"],"paths":["/en","/en/*","/blog/"]}},"bulk-publish-payload_example":{"summary":"publish multiple files","value":{"forceUpdate":true,"paths":["/en","/metadata.json","/blog/"],"delete":false}},"bulk-preview-payload_example":{"summary":"preview multiple files","value":{"forceUpdate":true,"paths":["/en","/en/*","/metadata.json","/blog/"],"delete":false}},"change-event-payload_example":{"summary":"Multiple files event example","value":{"type":"github","baseRef":"","installationId":995843,"changes":[{"path":"new-file.txt","time":"2021-05-04T13:40:15+09:00","type":"added","contentType":"text/plain; charset=utf-8","commit":"5edf98811d50b5b948f6f890f0c4367095490dbd"},{"path":"src/html.htl","time":"2021-05-04T13:40:15+09:00","type":"deleted","contentType":"application/octet-stream","commit":"5edf98811d50b5b948f6f890f0c4367095490dbd"},{"path":"README.md","time":"2021-05-04T13:40:15+09:00","type":"modified","contentType":"text/markdown; charset=utf-8","commit":"5edf98811d50b5b948f6f890f0c4367095490dbd"},{"path":"fail.md","time":"2021-05-04T13:40:15+09:00","type":"modified","contentType":"text/markdown; charset=utf-8","commit":"5edf98811d50b5b948f6f890f0c4367095490dbd"}]}}}}}},"searchIndex":{"store":["tag/status","tag/status/operation/status","tag/status/operation/bulkStatus","tag/publish","tag/publish/operation/getPublishStatus","tag/publish/operation/publishResource","tag/publish/operation/unpublishResource","tag/publish/operation/bulkPublish","tag/preview","tag/preview/operation/previewStatus","tag/preview/operation/updatePreview","tag/preview/operation/deletePreview","tag/preview/operation/bulkPreview","tag/code","tag/code/operation/codeStatus","tag/code/operation/updateCode","tag/code/operation/deleteCode","tag/code/operation/batchCode","tag/cache","tag/cache/operation/purgeCache","tag/index","tag/index/operation/getIndexStatus","tag/index/operation/indexResource","tag/index/operation/indexRemovePage","tag/authentication","tag/authentication/operation/login","tag/authentication/operation/login-repo","tag/authentication/operation/logout","tag/authentication/operation/profile","tag/form","tag/form/operation/formCreation","tag/sitemap","tag/sitemap/operation/generateSitemap","tag/convert","tag/convert/operation/convertStart","tag/convert/operation/convertStatus","tag/job","tag/job/operation/getJobList","tag/job/operation/getJob","tag/job/operation/stopJob","tag/job/operation/getJobDetails","tag/log","tag/log/operation/getLogs","tag/log/operation/addLogs"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.983]],["description/0",[0,1.171,1,1.907]],["title/1",[0,0.779,2,2.53]],["description/1",[0,0.944,3,1.359,4,4.083,5,2.151,6,0.887,7,4.083]],["title/2",[0,0.551,8,1.472,9,1.355,10,0.661]],["description/2",[0,0.542,3,0.463,6,0.509,9,0.791,11,1.044,12,0.941,13,1.601,14,1.76,15,1.181,16,1.181,17,0.941,18,1.181,19,1.181,20,0.941,21,1.39,22,2.344,23,1.76,24,1.39,25,1.879,26,1.39,27,1.39,28,1.39,29,1.39,30,1.39,31,1.39,32,1.39,33,1.39,34,0.492,35,0.859,36,1.044,37,1.39,38,1.044,39,1.044,40,1.044,41,0.859,42,1.39,43,1.39]],["title/3",[44,1.944]],["description/3",[1,1.907,44,2.316]],["title/4",[0,0.779,44,1.541]],["description/4",[0,0.944,3,1.359,5,2.151,6,0.887,44,1.867,45,3.066]],["title/5",[6,0.732,44,1.541]],["description/5",[6,0.815,34,0.887,35,1.548,44,1.146,45,1.881,46,2.505,47,1.696,48,2.541,49,2.541,50,1.548,51,1.32,52,1.425,53,2.135,54,1.425,55,1.227]],["title/6",[6,0.732,56,2.863]],["description/6",[6,0.617,35,1.757,45,2.135,47,1.925,48,1.925,49,1.925,50,1.757,51,1.498,52,1.617,53,2.344,54,1.617,55,1.393,56,2.416,57,1.757]],["title/7",[8,1.472,9,1.355,10,0.661,44,1.089]],["description/7",[3,0.533,6,0.573,9,1.5,10,0.445,12,1.084,13,0.843,14,1.98,25,0.989,35,0.989,38,1.98,39,1.202,40,1.202,41,0.989,44,0.732,55,0.784,58,1.292,59,1.601,60,1.36,61,1.36,62,1.36,63,1.36,64,1.36,65,1.36,66,1.36,67,1.36,68,1.36,69,1.36,70,1.36,71,1.36,72,1.36,73,1.601,74,1.36,75,1.601]],["title/8",[34,1.505]],["description/8",[1,1.907,34,1.793]],["title/9",[0,0.779,34,1.193]],["description/9",[0,0.944,3,1.359,5,2.151,6,0.887,34,1.445,76,3.066]],["title/10",[34,1.193,58,1.651]],["description/10",[6,0.617,11,2.135,34,1.459,47,2.79,48,1.925,49,1.925,58,1.393,76,2.135,77,2.416,78,2.416,79,2.843,80,2.843,81,2.416]],["title/11",[34,1.193,57,2.082]],["description/11",[6,0.846,34,1.813,48,2.636,49,2.636,57,2.407,76,2.924]],["title/12",[8,1.472,9,1.355,10,0.661,34,0.843]],["description/12",[3,0.47,6,0.516,9,1.352,10,0.392,12,0.957,13,1.252,14,1.785,15,1.201,16,1.201,17,0.957,18,1.201,19,1.201,20,0.957,25,0.873,34,0.841,38,1.785,39,1.061,40,1.061,41,0.873,55,0.692,58,1.165,60,1.201,61,1.201,62,1.201,63,1.201,64,1.201,65,1.201,66,1.201,67,1.201,68,1.201,69,1.201,70,1.201,71,1.201,72,1.201,74,1.201,82,1.413,83,1.413,84,1.413]],["title/13",[85,2.083]],["description/13",[1,1.799,85,2.341,86,3.587]],["title/14",[0,0.645,85,1.367,86,2.095]],["description/14",[0,0.9,3,1.297,5,2.051,6,0.846,85,1.908,86,2.924,87,2.924]],["title/15",[58,1.651,85,1.651]],["description/15",[5,1.041,6,0.429,11,1.484,13,1.041,17,1.338,20,1.338,47,1.338,50,1.221,51,1.041,52,1.124,53,1.779,54,1.124,55,0.968,58,1.532,77,1.68,81,1.68,87,1.484,88,2.913,89,3.127,90,1.68,91,1.68,92,1.68,93,1.976]],["title/16",[57,2.082,85,1.651]],["description/16",[6,0.687,50,1.955,51,1.666,52,1.8,53,2.53,54,1.8,55,1.55,57,1.955,85,1.55,87,2.375,88,2.375]],["title/17",[58,1.367,85,1.367,94,2.791]],["description/17",[50,1.818,51,1.55,52,1.674,53,2.403,54,1.674,55,1.442,58,1.442,88,2.209,95,2.942,96,2.942,97,2.942,98,2.942,99,2.942]],["title/18",[100,3.192]],["description/18",[1,1.907,100,3.803]],["title/19",[35,1.725,51,1.47,100,2.095]],["description/19",[5,1.55,6,0.639,51,2.225,52,1.674,53,2.403,54,1.674,55,1.442,101,2.942,102,2.942,103,2.942,104,2.942,105,2.942]],["title/20",[106,2.239]],["description/20",[1,1.907,106,2.668]],["title/21",[0,0.779,106,1.775]],["description/21",[0,0.944,3,1.359,5,2.151,6,0.887,106,2.151,107,3.066]],["title/22",[6,0.732,108,3.369]],["description/22",[6,0.917,13,1.55,17,1.992,20,1.992,44,1.346,90,2.5,91,2.5,92,2.5,106,1.55,107,2.209,109,2.942,110,2.942,111,2.942]],["title/23",[6,0.606,106,1.47,112,2.371]],["description/23",[6,0.982,106,2.382,107,3.395,112,3.842]],["title/24",[113,3.612]],["description/24",[1,1.907,113,4.304]],["title/25",[36,2.53,114,2.281]],["description/25",[36,3.066,78,3.47,114,3.577,115,4.083,116,3.47]],["title/26",[114,2.281,117,3.369]],["description/26",[116,3.47,118,3.47,119,4.083,120,3.066,121,4.083,122,4.083]],["title/27",[123,3.612]],["description/27",[114,2.52,118,3.163,123,3.163,124,1.961,125,3.722,126,3.163,127,3.722,128,3.722]],["title/28",[25,2.082,129,2.863]],["description/28",[25,2.794,129,4.79,130,4.521]],["title/29",[131,2.877]],["description/29",[1,1.907,131,3.428]],["title/30",[41,2.082,131,2.281]],["description/30",[13,0.744,23,2.31,34,0.5,41,1.902,131,1.609,132,1.413,133,4.025,134,3.077,135,2.377,136,1.413,137,1.413,138,1.413,139,1.201,140,1.413,141,1.413,142,1.413,143,1.413,144,2.377,145,1.413,146,1.201,147,1.413,148,1.413,149,1.413,150,1.413,151,1.413,152,1.413,153,1.413,154,1.413,155,1.413,156,1.201,157,1.413,158,1.413]],["title/31",[159,2.877]],["description/31",[1,1.907,159,3.428]],["title/32",[2,2.53,159,2.281]],["description/32",[2,2.795,12,2.52,13,2.619,159,3.366,160,3.722,161,3.722]],["title/33",[162,2.627]],["description/33",[1,1.907,162,3.13]],["title/34",[8,2.082,162,2.082]],["description/34",[8,2.652,10,1.191,163,4.291,164,4.291,165,4.291]],["title/35",[0,0.779,162,2.082]],["description/35",[0,0.944,3,1.359,10,1.134,126,3.47,162,2.523,166,4.083]],["title/36",[10,1.18]],["description/36",[1,1.907,10,1.406]],["title/37",[10,0.936,167,2.863]],["description/37",[3,1.429,10,1.514,167,3.646,168,4.291]],["title/38",[0,0.779,10,0.936]],["description/38",[0,1.045,3,1.505,10,1.255,169,3.842]],["title/39",[10,0.936,170,2.863]],["description/39",[10,1.327,169,4.06,170,4.06]],["title/40",[0,0.645,10,0.775,171,2.791]],["description/40",[0,1.045,3,1.505,10,1.255,172,4.521]],["title/41",[124,2.239]],["description/41",[1,1.907,124,2.668]],["title/42",[3,1.122,124,1.775]],["description/42",[3,1.505,120,3.395,124,2.382,173,3.842]],["title/43",[124,1.775,174,2.863]],["description/43",[23,2.468,120,2.468,124,1.731,139,2.793,146,2.793,156,2.793,173,2.793,174,2.793,175,3.287,176,3.287,177,3.287]]],"invertedIndex":[["",{"_index":17,"title":{},"description":{"2":{},"12":{},"15":{},"22":{}}}],["_byo_",{"_index":54,"title":{},"description":{"5":{},"6":{},"15":{},"16":{},"17":{},"19":{}}}],["_live_",{"_index":52,"title":{},"description":{"5":{},"6":{},"15":{},"16":{},"17":{},"19":{}}}],["accordingli",{"_index":98,"title":{},"description":{"17":{}}}],["add",{"_index":174,"title":{"43":{}},"description":{"43":{}}}],["addition",{"_index":50,"title":{},"description":{"5":{},"6":{},"15":{},"16":{},"17":{}}}],["alway",{"_index":70,"title":{},"description":{"7":{},"12":{}}}],["api",{"_index":147,"title":{},"description":{"30":{}}}],["approv",{"_index":151,"title":{},"description":{"30":{}}}],["array",{"_index":176,"title":{},"description":{"43":{}}}],["assum",{"_index":18,"title":{},"description":{"2":{},"12":{}}}],["asynchron",{"_index":40,"title":{},"description":{"2":{},"7":{},"12":{}}}],["authent",{"_index":113,"title":{"24":{}},"description":{"24":{}}}],["auto",{"_index":117,"title":{"26":{}},"description":{}}],["avail",{"_index":115,"title":{},"description":{"25":{}}}],["batch",{"_index":94,"title":{"17":{}},"description":{}}],["befor",{"_index":145,"title":{},"description":{"30":{}}}],["below",{"_index":110,"title":{},"description":{"22":{}}}],["bodi",{"_index":139,"title":{},"description":{"30":{},"43":{}}}],["bu",{"_index":86,"title":{"14":{}},"description":{"13":{},"14":{}}}],["bulk",{"_index":9,"title":{"2":{},"7":{},"12":{}},"description":{"2":{},"7":{},"12":{}}}],["cach",{"_index":100,"title":{"18":{},"19":{}},"description":{"18":{}}}],["cache/{owner}/{repo}/{ref}/{path",{"_index":105,"title":{},"description":{"19":{}}}],["call",{"_index":146,"title":{},"description":{"30":{},"43":{}}}],["cdn",{"_index":53,"title":{},"description":{"5":{},"6":{},"15":{},"16":{},"17":{},"19":{}}}],["chang",{"_index":96,"title":{},"description":{"17":{}}}],["code",{"_index":85,"title":{"13":{},"14":{},"15":{},"16":{},"17":{}},"description":{"13":{},"14":{},"16":{}}}],["code-bu",{"_index":88,"title":{},"description":{"15":{},"16":{},"17":{}}}],["code/{owner}/{repo}/{ref",{"_index":99,"title":{},"description":{"17":{}}}],["code/{owner}/{repo}/{ref}/{path",{"_index":87,"title":{},"description":{"14":{},"15":{},"16":{}}}],["combin",{"_index":32,"title":{},"description":{"2":{}}}],["configur",{"_index":55,"title":{},"description":{"5":{},"6":{},"7":{},"12":{},"15":{},"16":{},"17":{},"19":{}}}],["contain",{"_index":23,"title":{},"description":{"2":{},"30":{},"43":{}}}],["content",{"_index":47,"title":{},"description":{"5":{},"6":{},"10":{},"15":{}}}],["content-bu",{"_index":48,"title":{},"description":{"5":{},"6":{},"10":{},"11":{}}}],["content-proxi",{"_index":80,"title":{},"description":{"10":{}}}],["convers",{"_index":164,"title":{},"description":{"34":{}}}],["convert",{"_index":162,"title":{"33":{},"34":{},"35":{}},"description":{"33":{},"35":{}}}],["convert/{owner}/{repo}/{ref",{"_index":165,"title":{},"description":{"34":{}}}],["convert/{owner}/{repo}/{ref}/${id",{"_index":166,"title":{},"description":{"35":{}}}],["copi",{"_index":46,"title":{},"description":{"5":{}}}],["correspond",{"_index":119,"title":{},"description":{"26":{}}}],["creat",{"_index":41,"title":{"30":{}},"description":{"2":{},"7":{},"12":{},"30":{}}}],["current",{"_index":126,"title":{},"description":{"27":{},"35":{}}}],["data",{"_index":134,"title":{},"description":{"30":{}}}],["default",{"_index":60,"title":{},"description":{"7":{},"12":{}}}],["delet",{"_index":57,"title":{"11":{},"16":{}},"description":{"6":{},"11":{},"16":{}}}],["destin",{"_index":160,"title":{},"description":{"32":{}}}],["detail",{"_index":171,"title":{"40":{}},"description":{}}],["directori",{"_index":93,"title":{},"description":{"15":{}}}],["display",{"_index":130,"title":{},"description":{"28":{}}}],["do",{"_index":148,"title":{},"description":{"30":{}}}],["dure",{"_index":72,"title":{},"description":{"7":{},"12":{}}}],["e.g",{"_index":79,"title":{},"description":{"10":{}}}],["edit",{"_index":33,"title":{},"description":{"2":{}}}],["end",{"_index":16,"title":{},"description":{"2":{},"12":{}}}],["entri",{"_index":177,"title":{},"description":{"43":{}}}],["event",{"_index":97,"title":{},"description":{"17":{}}}],["extens",{"_index":157,"title":{},"description":{"30":{}}}],["fetch",{"_index":11,"title":{},"description":{"2":{},"10":{},"15":{}}}],["file",{"_index":67,"title":{},"description":{"7":{},"12":{}}}],["filter",{"_index":30,"title":{},"description":{"2":{}}}],["folder",{"_index":19,"title":{},"description":{"2":{},"12":{}}}],["folliow",{"_index":24,"title":{},"description":{"2":{}}}],["forceupd",{"_index":64,"title":{},"description":{"7":{},"12":{}}}],["form",{"_index":131,"title":{"29":{},"30":{}},"description":{"29":{},"30":{}}}],["form/{owner}/{repo}/{ref}/{path",{"_index":158,"title":{},"description":{"30":{}}}],["format",{"_index":175,"title":{},"description":{"43":{}}}],["gener",{"_index":2,"title":{"1":{},"32":{}},"description":{"32":{}}}],["github",{"_index":89,"title":{},"description":{"15":{}}}],["helix/config",{"_index":68,"title":{},"description":{"7":{},"12":{}}}],["hook",{"_index":103,"title":{},"description":{"19":{}}}],["idp",{"_index":116,"title":{},"description":{"25":{},"26":{}}}],["ignor",{"_index":71,"title":{},"description":{"7":{},"12":{}}}],["incom",{"_index":141,"title":{},"description":{"30":{}}}],["index",{"_index":106,"title":{"20":{},"21":{},"23":{}},"description":{"20":{},"21":{},"22":{},"23":{}}}],["index/{owner}/{repo}/{ref}/{path",{"_index":107,"title":{},"description":{"21":{},"22":{},"23":{}}}],["inform",{"_index":25,"title":{"28":{}},"description":{"2":{},"7":{},"12":{},"28":{}}}],["ingest",{"_index":135,"title":{},"description":{"30":{}}}],["intak",{"_index":153,"title":{},"description":{"30":{}}}],["invok",{"_index":102,"title":{},"description":{"19":{}}}],["job",{"_index":10,"title":{"2":{},"7":{},"12":{},"36":{},"37":{},"38":{},"39":{},"40":{}},"description":{"7":{},"12":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{}}}],["job/{owner}/{repo}/{ref}/{top",{"_index":168,"title":{},"description":{"37":{}}}],["job/{owner}/{repo}/{ref}/{topic}/{jobnam",{"_index":169,"title":{},"description":{"38":{},"39":{}}}],["job/{owner}/{repo}/{ref}/{topic}/{jobname}/detail",{"_index":172,"title":{},"description":{"40":{}}}],["job](#tag/job",{"_index":42,"title":{},"description":{"2":{}}}],["json",{"_index":156,"title":{},"description":{"30":{},"43":{}}}],["last",{"_index":90,"title":{},"description":{"15":{},"22":{}}}],["latest",{"_index":77,"title":{},"description":{"10":{},"15":{}}}],["list",{"_index":167,"title":{"37":{}},"description":{"37":{}}}],["live",{"_index":35,"title":{"19":{}},"description":{"2":{},"5":{},"6":{},"7":{}}}],["live/{owner}/{repo}/{ref",{"_index":75,"title":{},"description":{"7":{}}}],["live/{owner}/{repo}/{ref}/{path",{"_index":45,"title":{},"description":{"4":{},"5":{},"6":{}}}],["log",{"_index":124,"title":{"41":{},"42":{},"43":{}},"description":{"27":{},"41":{},"42":{},"43":{}}}],["log/{owner}/{repo}/{ref",{"_index":173,"title":{},"description":{"42":{},"43":{}}}],["login",{"_index":114,"title":{"25":{},"26":{}},"description":{"25":{},"27":{}}}],["login/{owner}/{repo}/{ref",{"_index":122,"title":{},"description":{"26":{}}}],["logout",{"_index":123,"title":{"27":{}},"description":{"27":{}}}],["manual",{"_index":142,"title":{},"description":{"30":{}}}],["modifi",{"_index":62,"title":{},"description":{"7":{},"12":{}}}],["name",{"_index":140,"title":{},"description":{"30":{}}}],["necessari",{"_index":136,"title":{},"description":{"30":{}}}],["new",{"_index":61,"title":{},"description":{"7":{},"12":{}}}],["note",{"_index":38,"title":{},"description":{"2":{},"7":{},"12":{}}}],["oper",{"_index":1,"title":{},"description":{"0":{},"3":{},"8":{},"13":{},"18":{},"20":{},"24":{},"29":{},"31":{},"33":{},"36":{},"41":{}}}],["option",{"_index":101,"title":{},"description":{"19":{}}}],["out",{"_index":125,"title":{},"description":{"27":{}}}],["overal",{"_index":4,"title":{},"description":{"1":{}}}],["partit",{"_index":49,"title":{},"description":{"5":{},"6":{},"10":{},"11":{}}}],["pass",{"_index":31,"title":{},"description":{"2":{}}}],["path",{"_index":13,"title":{},"description":{"2":{},"7":{},"12":{},"15":{},"22":{},"30":{},"32":{}}}],["payload",{"_index":15,"title":{},"description":{"2":{},"12":{}}}],["payload.<br",{"_index":59,"title":{},"description":{"7":{}}}],["payload.<br><br",{"_index":37,"title":{},"description":{"2":{}}}],["perform",{"_index":39,"title":{},"description":{"2":{},"7":{},"12":{}}}],["possibl",{"_index":29,"title":{},"description":{"2":{}}}],["post",{"_index":138,"title":{},"description":{"30":{}}}],["prepar",{"_index":132,"title":{},"description":{"30":{}}}],["preview",{"_index":34,"title":{"8":{},"9":{},"10":{},"11":{},"12":{}},"description":{"2":{},"5":{},"8":{},"9":{},"10":{},"11":{},"12":{},"30":{}}}],["preview.<br",{"_index":83,"title":{},"description":{"12":{}}}],["preview/{owner}/{repo}/{ref",{"_index":84,"title":{},"description":{"12":{}}}],["preview/{owner}/{repo}/{ref}/{path",{"_index":76,"title":{},"description":{"9":{},"10":{},"11":{}}}],["previewed.<br",{"_index":82,"title":{},"description":{"12":{}}}],["previewlastmodifi",{"_index":27,"title":{},"description":{"2":{}}}],["process",{"_index":95,"title":{},"description":{"17":{}}}],["processed.<br><br",{"_index":21,"title":{},"description":{"2":{}}}],["profil",{"_index":129,"title":{"28":{}},"description":{"28":{}}}],["project",{"_index":120,"title":{},"description":{"26":{},"42":{},"43":{}}}],["properti",{"_index":14,"title":{},"description":{"2":{},"7":{},"12":{}}}],["provid",{"_index":78,"title":{},"description":{"10":{},"25":{}}}],["publish",{"_index":44,"title":{"3":{},"4":{},"5":{},"7":{}},"description":{"3":{},"4":{},"5":{},"7":{},"22":{}}}],["publish.<br",{"_index":73,"title":{},"description":{"7":{}}}],["publishlastmodifi",{"_index":28,"title":{},"description":{"2":{}}}],["purg",{"_index":51,"title":{"19":{}},"description":{"5":{},"6":{},"15":{},"16":{},"17":{},"19":{}}}],["re-index",{"_index":108,"title":{"22":{}},"description":{}}],["recurs",{"_index":20,"title":{},"description":{"2":{},"12":{},"15":{},"22":{}}}],["redirect",{"_index":118,"title":{},"description":{"26":{},"27":{}}}],["redirects.json",{"_index":69,"title":{},"description":{"7":{},"12":{}}}],["reindex",{"_index":109,"title":{},"description":{"22":{}}}],["remov",{"_index":112,"title":{"23":{}},"description":{"23":{}}}],["request",{"_index":74,"title":{},"description":{"7":{},"12":{}}}],["resourc",{"_index":6,"title":{"5":{},"6":{},"22":{},"23":{}},"description":{"1":{},"2":{},"4":{},"5":{},"6":{},"7":{},"9":{},"10":{},"11":{},"12":{},"14":{},"15":{},"16":{},"19":{},"21":{},"22":{},"23":{}}}],["respect",{"_index":5,"title":{},"description":{"1":{},"4":{},"9":{},"14":{},"15":{},"19":{},"21":{}}}],["respons",{"_index":22,"title":{},"description":{"2":{}}}],["return",{"_index":3,"title":{"42":{}},"description":{"1":{},"2":{},"4":{},"7":{},"9":{},"12":{},"14":{},"21":{},"35":{},"37":{},"38":{},"40":{},"42":{}}}],["screen",{"_index":128,"title":{},"description":{"27":{}}}],["segment",{"_index":91,"title":{},"description":{"15":{},"22":{}}}],["select",{"_index":36,"title":{"25":{}},"description":{"2":{},"25":{}}}],["servic",{"_index":150,"title":{},"description":{"30":{}}}],["session",{"_index":127,"title":{},"description":{"27":{}}}],["set",{"_index":65,"title":{},"description":{"7":{},"12":{}}}],["setup",{"_index":121,"title":{},"description":{"26":{}}}],["shared-default",{"_index":154,"title":{},"description":{"30":{}}}],["sheet",{"_index":133,"title":{},"description":{"30":{}}}],["signal",{"_index":149,"title":{},"description":{"30":{}}}],["sitemap",{"_index":159,"title":{"31":{},"32":{}},"description":{"31":{},"32":{}}}],["sitemap/{owner}/{repo}/{ref}/{path",{"_index":161,"title":{},"description":{"32":{}}}],["slack",{"_index":155,"title":{},"description":{"30":{}}}],["sourcelastmodifi",{"_index":26,"title":{},"description":{"2":{}}}],["specifi",{"_index":12,"title":{},"description":{"2":{},"7":{},"12":{},"32":{}}}],["start",{"_index":8,"title":{"2":{},"7":{},"12":{},"34":{}},"description":{"34":{}}}],["statu",{"_index":0,"title":{"0":{},"1":{},"2":{},"4":{},"9":{},"14":{},"21":{},"35":{},"38":{},"40":{}},"description":{"0":{},"1":{},"2":{},"4":{},"9":{},"14":{},"21":{},"35":{},"38":{},"40":{}}}],["status/{owner}/{repo}/{ref",{"_index":43,"title":{},"description":{"2":{}}}],["status/{owner}/{repo}/{ref}/{path",{"_index":7,"title":{},"description":{"1":{}}}],["stop",{"_index":170,"title":{"39":{}},"description":{"39":{}}}],["store",{"_index":81,"title":{},"description":{"10":{},"15":{}}}],["sub",{"_index":111,"title":{},"description":{"22":{}}}],["tables/head",{"_index":137,"title":{},"description":{"30":{}}}],["target",{"_index":143,"title":{},"description":{"30":{}}}],["todo",{"_index":104,"title":{},"description":{"19":{}}}],["tree",{"_index":92,"title":{},"description":{"15":{},"22":{}}}],["true`.<br",{"_index":66,"title":{},"description":{"7":{},"12":{}}}],["un-publish",{"_index":56,"title":{"6":{}},"description":{"6":{}}}],["unless",{"_index":63,"title":{},"description":{"7":{},"12":{}}}],["updat",{"_index":58,"title":{"10":{},"15":{},"17":{}},"description":{"7":{},"10":{},"12":{},"15":{},"17":{}}}],["us",{"_index":152,"title":{},"description":{"30":{}}}],["video",{"_index":163,"title":{},"description":{"34":{}}}],["workbook",{"_index":144,"title":{},"description":{"30":{}}}]],"pipeline":[]}},"options":{}};
+      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"version":"11.31.3","title":"AEM Admin API","description":"AEM Admin API is used to manage the lifecycle of content and code.","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://admin.hlx.page"}],"tags":[{"name":"status","description":"Status operations"},{"name":"publish","description":"Publish operations"},{"name":"preview","description":"Preview operations"},{"name":"code","description":"Code bus operations"},{"name":"cache","description":"Cache operations"},{"name":"index","description":"Index operations"},{"name":"authentication","description":"Authentication operations"},{"name":"form","description":"Form operations"},{"name":"sitemap","description":"Sitemap operations"},{"name":"convert","description":"Convert operations"},{"name":"job","description":"Job operations"},{"name":"log","description":"Log operations"}],"paths":{"/status/{owner}/{repo}/{ref}/{path}":{"get":{"operationId":"status","tags":["status"],"summary":"General status","description":"Returns the overall status of the respective resource.","security":[{},{"AuthCookie":["preview:read","live:read","code:read","edit:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/statusEditUrlParam"}],"responses":{"200":{"description":"The overall status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/previewInfo"},{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/editInfo"},{"$ref":"#/components/schemas/codeInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"},{"$ref":"#/components/schemas/profileInfo"}]},"examples":{"success":{"description":"Success response of a preview document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","contentBusId":"helix-content-bu/h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md","permissions":["read"]},"preview":{"status":200,"url":"https://main--repo--owner.hlx.page/en/2021/blog","lastModified":"2021-05-31T23:00:00Z","contentBusId":"helix-content-bu/h3-theblog-123ab123ab12ab123a12b3a/preview/en/2021/blog.md","permissions":["read","write"]},"edit":{"status":200,"url":"https://adobe.sharepoint.com/","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","lastModified":"2021-05-29T21:00:00Z"},"code":{"status":404,"codeBusId":"helix-code-bus/adobe/blog/main/blog.md","permissions":["read"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/status/{owner}/{repo}/{ref}/*":{"post":{"operationId":"bulkStatus","tags":["status"],"summary":"Start a bulk status job","description":"Fetches the status of all resources specified in the `paths` property in the payload. If a path ends with `/*`, it is assumed to be a folder and is recursively processed.<br><br> The response will contain the folliowing information about a resource: `path`, `sourceLastModified`, `previewLastModified` and `publishLastModified`. It is possible to filter the information returned, by passing a combination of `edit`, `preview` and `live` in the `select` property in the payload.<br><br> Note that the bulk status is performed asynchronously and the response will contain information about the created [job](#tag/job).\n","security":[{},{"AuthCookie":["edit:list","preview:list","live:list"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkStatusBody"},"examples":{"multiple-paths":{"$ref":"#/components/examples/example"}}}}},"responses":{"202":{"description":"Bulk status scheduled.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobCreated"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"status":202,"messageId":"37e92eec-020c-4eae-8f80-3db444c25056","job":{"topic":"status","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","data":{"paths":[{"prefix":"/en/"},{"path":"/en"},{"path":"/blog/"}]}},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/status/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/status"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/live/{owner}/{repo}/{ref}/{path}":{"get":{"operationId":"getPublishStatus","tags":["publish"],"summary":"Publish Status","description":"Returns the publish status of the respective resource.","security":[{"AuthCookie":["live:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"The publish status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of a published document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}},"post":{"operationId":"publishResource","tags":["publish"],"summary":"Publish a resource","description":"Publish a resource by copying the resource content from the `preview` content-bus partition to the `live` content-bus partition. It additionally purges the _live_ cdn and the _byo_ cdn, if configured.\n","security":[{"AuthCookie":["preview:read","live:read","live:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/forceUpdateRedirectsParam"},{"$ref":"#/components/parameters/disableNotificationsParam"}],"responses":{"200":{"description":"Resource published.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of the published document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read","write"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"unpublishResource","tags":["publish"],"summary":"Un-publish a resource","description":"Un-publish a resource by deleting the content from from the `live` content-bus partition. It additionally purges the _live_ cdn and the _byo_ cdn, if configured.\n","security":[{"AuthCookie":["live:read","live:delete"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/disableNotificationsParam"}],"responses":{"204":{"description":"Resource unpublished"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/live/{owner}/{repo}/{ref}/*":{"post":{"operationId":"bulkPublish","tags":["publish"],"summary":"Start a bulk publish job","description":"Updates live resources specified in the `paths` property in the payload.<br> By default, only new and modified resources are updated, unless the `forceUpdate` property is set to `true`.<br> Note that configuration files, like `/.helix/config` or `redirects.json`, are always ignored during bulk publish.<br> Note that the bulk publish is performed asynchronously and this request will return information to the created job.\n","security":[{"AuthCookie":["preview:list","preview:read","preview:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkPublishBody"},"examples":{"multiple-paths":{"$ref":"#/components/examples/bulk-publish-payload_example"}}}}},"responses":{"202":{"description":"Bulk publish scheduled.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobCreated"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"status":202,"messageId":"37e92eec-020c-4eae-8f80-3db444c25056","job":{"topic":"publish","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","data":{"paths":[{"path":"/en"},{"path":"/blog/"},{"path":"/metadata.json"}]}},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/publish/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/publish"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/preview/{owner}/{repo}/{ref}/{path}":{"get":{"operationId":"previewStatus","tags":["preview"],"summary":"Preview status","description":"Returns the preview status of the respective resource.","security":[{"AuthCookie":["preview:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"The preview status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/previewInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of a preview document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","preview":{"status":200,"url":"https://main--repo--owner.hlx.page/en/2021/blog","lastModified":"2021-05-31T23:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/preview/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}},"post":{"operationId":"updatePreview","tags":["preview"],"summary":"Update preview","description":"Updates the preview resource by fetching the latest content from the content providers (e.g. content-proxy) and storing it in the `preview` content-bus partition.\n","security":[{"AuthCookie":["edit:read","preview:read","preview:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/forceUpdateRedirectsParam"},{"$ref":"#/components/parameters/word2mdVersionParam"},{"$ref":"#/components/parameters/gdocs2mdVersionParam"},{"$ref":"#/components/parameters/html2mdVersionParam"}],"responses":{"200":{"description":"Preview resource updated.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/previewInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","preview":{"status":200,"url":"https://main--repo--owner.hlx.page/en/2021/blog","lastModified":"2021-05-31T23:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/preview/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read","write"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deletePreview","tags":["preview"],"summary":"Delete preview","description":"Deletes a preview resource from the `preview` partition in the content-bus..\n","security":[{"AuthCookie":["preview:read","preview:delete"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/preview/{owner}/{repo}/{ref}/*":{"post":{"operationId":"bulkPreview","tags":["preview"],"summary":"Start a bulk preview job","description":"Updates preview resources specified in the `paths` property in the payload. If a path ends with `/*`, it is assume to be folder and is recursively previewed.<br> By default, only new and modified resources are updated, unless the `forceUpdate` property is set to `true`.<br> Note that configuration files, like `/.helix/config` or `redirects.json`, are always ignored during bulk preview.<br> Note that the bulk preview is performed asynchronously and this request will return information to the created job.\n","security":[{"AuthCookie":["edit:read","edit:list","preview:read","preview:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/word2mdVersionParam"},{"$ref":"#/components/parameters/gdocs2mdVersionParam"},{"$ref":"#/components/parameters/html2mdVersionParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkPreviewBody"},"examples":{"multiple-paths":{"$ref":"#/components/examples/bulk-preview-payload_example"}}}}},"responses":{"202":{"description":"Bulk preview scheduled.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobCreated"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"status":202,"messageId":"37e92eec-020c-4eae-8f80-3db444c25056","job":{"topic":"preview","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","data":{"paths":["/documents"]}},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/preview"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/code/{owner}/{repo}/{ref}/{path}":{"get":{"operationId":"codeStatus","tags":["code"],"summary":"Code bus status","description":"Returns the code bus status of the respective resource.","security":[{},{"AuthCookie":["code:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/branchParam"}],"responses":{"200":{"description":"The code-bus status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/codeInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of a code document.","value":{"webPath":"/scripts.js","resourcePath":"/scripts.js","live":{"url":"https://main--repo--owner.hlx.live/scripts.js"},"preview":{"url":"https://main--repo--owner.hlx.page/scripts.js"},"edit":{"url":"https://github.com/owner/repo/tree/main/scripts.js"},"code":{"status":200,"lastModified":"2021-05-31T23:00:00Z","sourceLastModified":"2021-05-29T21:00:00Z","codeBusId":"helix-code-bus/owner/repo/main/scripts.js","permissions":["read"]},"links":{"status":"https://admin.hlx.page/status/owner/repo/main/scripts.js","preview":"https://admin.hlx.page/preview/owner/repo/main/scripts.js","live":"https://admin.hlx.page/live/owner/repo/main/scripts.js","code":"https://admin.hlx.page/code/owner/repo/main/scripts.js"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}},"post":{"operationId":"updateCode","tags":["code"],"summary":"Update code","description":"Updates the code-bus resource by fetching the latest content from github and storing it in the code-bus. If the last path segment is a `*`, it will recursively update the code-bus with the respective github tree (directory). It additionally purges the _live_ cdn and the _byo_ cdn, if configured.\n","security":[{},{"AuthCookie":["code:read","code:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/branchParam"}],"responses":{"200":{"description":"Code resource updated.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/codeInfo"}]}},"examples":{"success":{"description":"Success response.","value":[{"live":{"url":"https://main--repo--owner.hlx.live/scripts.js"},"code":{"status":200,"lastModified":"2021-05-31T23:00:00Z","codeBusId":"helix-code-bus/owner/repo/main/scripts.js","permissions":["read","write"]}}]}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteCode","tags":["code"],"summary":"Delete code","description":"Deletes a code resource from the code-bus It additionally purges the _live_ cdn and the _byo_ cdn, if configured.\n","security":[{"AuthCookie":["code:read","delete:code"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/branchParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/code/{owner}/{repo}/{ref}":{"post":{"operationId":"batchCode","tags":["code"],"summary":"Batch update code","description":"Processes a change event and updates the code-bus accordingly. It additionally purges the _live_ cdn and the _byo_ cdn, if configured.\n","security":[{},{"AuthCookie":["code:read","code:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/changeEventBody"},"examples":{"multiple-files":{"$ref":"#/components/examples/change-event-payload_example"}}}}},"responses":{"200":{"description":"Code resource updated.","content":{"application/json":{"schema":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/codeInfo"}]}},"examples":{"success":{"description":"Success response.","value":[{"live":{"url":"https://main--repo--owner.hlx.live/scripts.js"},"code":{"status":200,"lastModified":"2021-05-31T23:00:00Z","codeBusId":"helix-code-bus/owner/repo/main/scripts.js","permissions":["read","write"]}}]}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/cache/{owner}/{repo}/{ref}/{path}":{"post":{"operationId":"purgeCache","tags":["cache"],"summary":"Purge live cache","description":"Purges the resource from the respective _live_ cdn. It optionally invokes the _byo_ cdn purging hook, if configured (todo).\n","security":[{},{"AuthCookie":["cache:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"Successful purge response"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/index/{owner}/{repo}/{ref}/{path}":{"get":{"operationId":"getIndexStatus","tags":["index"],"summary":"Index Status","description":"Returns the index status of the respective resource.","security":[{},{"AuthCookie":["index:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"The index status of a resource","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/indexInfo"}]},"examples":{"success":{"description":"Success response of an index document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","index":{"name":"blog","githubLink":"https://github.com/owner/repo/blob/main/helix-index.yaml#L4","indexedUrl":"https://main--owner--repo.hlx.live/en/2021/blog","lastModified":"Tue, 01 Mar 2022 08:32:01 GMT"}}}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"description":"Resource not found or not in index definition.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"$ref":"#/components/responses/500"}}},"post":{"operationId":"indexResource","tags":["index"],"summary":"Re-index a resource.","description":"Index a resource. If the last path segment is a `*`, it will recursively reindex all published resources below that sub tree.\n","security":[{},{"AuthCookie":["index:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"Re-index of resource triggered.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/indexInfo"}]},"examples":{"success":{"description":"Success response of indexing a resource.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","index":{"name":"blog","githubLink":"https://github.com/owner/repo/blob/main/helix-index.yaml#L4","indexedUrl":"https://main--owner--repo.hlx.live/en/2021/blog","lastModified":"Tue, 01 Mar 2022 08:32:01 GMT"}}}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"description":"Resource not found or not in index definition.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"indexRemovePage","tags":["index"],"summary":"Remove a resource from the index.","description":"Removes a resource from the index.\n","security":[{},{"AuthCookie":["index:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"Removal of resource in the index triggered.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/indexInfo"}]},"examples":{"success":{"description":"Success response of removing a resource from the index.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","index":{"name":"blog","status":202}}}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"description":"Resource not found or not in index definition.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"$ref":"#/components/responses/500"}}}},"/login":{"get":{"operationId":"login","tags":["authentication"],"summary":"Login Selection","description":"Provides a selection of available IDP logins","security":[{}],"responses":{"200":{"description":"Display links to IDP specific logins","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/loginLinks"}]},"examples":{"success":{"description":"Success response.","value":{"links":{"login_microsoft":"https://admin.hlx.page/auth/adobe","login_google":"https://admin.hlx.page/auth/google"}}},"loggedin":{"description":"Success response when logged in","value":{"links":{"logout":"https://admin.hlx.page/logout"}}}}}}}}}},"/login/{owner}/{repo}/{ref}":{"get":{"operationId":"login-repo","tags":["authentication"],"summary":"Auto login","description":"Redirects to IDP corresponding the project setup","security":[{}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"}],"responses":{"302":{"description":"Redirects to the IDP authorization endpoint","headers":{"location":{"$ref":"#/components/headers/location"}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}},"/logout":{"get":{"operationId":"logout","tags":["authentication"],"summary":"Logout","description":"Logs out the current session and redirects to the login screen","security":[{}],"responses":{"302":{"description":"Redirects to /login","headers":{"location":{"$ref":"#/components/headers/location"}}}}}},"/profile":{"get":{"operationId":"profile","tags":["authentication"],"summary":"Profile information","description":"Display profile information","security":[{},{"AuthCookie":["profile:read"]}],"responses":{"200":{"description":"Show profile information of logged in user","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/profileInfo"},{"$ref":"#/components/schemas/logoutLink"}]},"examples":{"success":{"description":"Success response.","value":{"profile":{"iss":"urn:example:issuer","email":"test@example.com","name":"Test User","ttl":7200},"links":{"logout":"https://admin.hlx.page/logout"}}}}}}}}}},"/form/{owner}/{repo}/{ref}/{path}":{"post":{"operationId":"formCreation","tags":["form"],"summary":"Create form","description":"Prepares a sheet for data ingestion. Creates the necessary tables/headers to ingest the form data contained in the post body. A sheet named 'incoming' must be manually created (and previewed) in the target workbook before calling this API, doing so signals to the forms service that you approve this sheet to be used to intake data. If the workbook does not contain a shared-default or a slack sheet then they are also created.\nThe path to the sheet must contain the .json extension.\n","security":[{"AuthCookie":["forms:read","forms:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/formPostJSONBody"},"examples":{"kvObject":{"description":"Key/value object request body","value":{"data":{"firstName":"Bruce","lastName":"Banner"}}},"nvArray":{"description":"Name/value array request body","value":{"data":[{"name":"firstName","value":"Bruce"},{"name":"lastName","value":"Banner"}]}}}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/formPostURLEncodedBody"},"examples":{"success":{"description":"Request body","value":"Rating=3&Comment=little%20free&Locale=en-us"}}}}},"responses":{"200":{"description":"The sheet has been prepared for data ingestion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/formPostResponse"},"examples":{"success":{"description":"Success response.","value":{"rowCount":1,"columns":["header1","header2"]}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"405":{"$ref":"#/components/responses/405"},"503":{"description":"A 503 likely means that the forms service took too long to prepare the sheet and the gateway timed out after 30 seconds. Note that even though a 503 is returned the forms service should still successfully prepare the sheet for data intake.\n"}}}},"/sitemap/{owner}/{repo}/{ref}/{path}":{"post":{"operationId":"generateSitemap","tags":["sitemap"],"summary":"Generates a sitemap","description":"Generates a sitemap. The path specified should be the destination path of a sitemap.\n","security":[{}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"Sitemap generated.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/sitemapInfo"}]},"examples":{"success":{"description":"Success response of generating a sitemap","value":{"paths":["/sitemap.xml"]}}}}}},"204":{"description":"Path specified is no destination for any sitemap configured"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"description":"No sitemap configuration found","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"$ref":"#/components/responses/500"}}}},"/convert/{owner}/{repo}/{ref}":{"post":{"operationId":"convertStart","tags":["convert"],"summary":"Start convert","description":"Start a video conversion job.\n","security":[{"AuthCookie":["convert:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/convertUrlParam"}],"responses":{"200":{"description":"Convert job started.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobStarted"}]},"examples":{"success":{"description":"Success response.","value":{"id":"69985ac8-fc98-4f69-8972-0168cfe7bbe6"}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/convert/{owner}/{repo}/{ref}/${id}":{"get":{"operationId":"convertStatus","tags":["convert"],"summary":"Convert status","description":"Returns the current status of a convert job\n","security":[{"AuthCookie":["convert:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/convertIdParam"}],"responses":{"200":{"description":"The convert job status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobInfo"}]},"examples":{"success":{"description":"Success response of a job status.","value":{"next":"s3Upload","state":"STARTED"}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/job/{owner}/{repo}/{ref}/{topic}":{"get":{"operationId":"getJobList","tags":["job"],"summary":"Job List","description":"Returns the job list of jobs","security":[{"AuthCookie":["job:list"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/topicParam"}],"responses":{"200":{"description":"The Job List","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobList"},{"$ref":"#/components/schemas/jobListLink"}]},"examples":{"success":{"description":"Success response of a job list.","value":{"topic":"preview","jobs":[{"name":"job-123","state":"created","time":"2021-05-31T23:00:00Z","href":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123"},{"name":"job-124","state":"running","time":"2021-04-31T23:00:00Z","href":"https://admin.hlx.page/job/adobe/blog/main/preview/job-124"}],"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/job/{owner}/{repo}/{ref}/{topic}/{jobName}":{"get":{"operationId":"getJob","tags":["job"],"summary":"Job Status","description":"Returns the job status","security":[{"AuthCookie":["job:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/topicParam"},{"$ref":"#/components/parameters/jobNameParam"}],"responses":{"202":{"description":"The Job Status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobStatus"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"topic":"preview","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","progress":{"total":10,"processed":0,"failed":0},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123","details":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123/details","list":"https://admin.hlx.page/job/adobe/blog/main/preview"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}},"delete":{"operationId":"stopJob","tags":["job"],"summary":"Stop job","description":"Stops a job.","security":[{"AuthCookie":["job:read","job:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/topicParam"},{"$ref":"#/components/parameters/jobNameParam"}],"responses":{"204":{"description":"Job stopped."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}},"/job/{owner}/{repo}/{ref}/{topic}/{jobName}/details":{"get":{"operationId":"getJobDetails","tags":["job"],"summary":"Job Status Details","description":"Returns the job status","security":[{"AuthCookie":["job:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/topicParam"},{"$ref":"#/components/parameters/jobNameParam"}],"responses":{"202":{"description":"The Job Status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobStatusDetails"},{"$ref":"#/components/schemas/jobLinksInfoDetails"}]},"examples":{"success":{"description":"Success response.","value":{"topic":"preview","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","progress":{"total":10,"processed":6,"failed":4},"data":{"paths":["/documents"]},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123/details","job":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/preview"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/log/{owner}/{repo}/{ref}":{"get":{"operationId":"getLogs","tags":["log"],"summary":"Returns logs","description":"Returns logs for a project","security":[{"AuthCookie":["log:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/fromParam"},{"$ref":"#/components/parameters/toParam"},{"$ref":"#/components/parameters/nextTokenParam"}],"responses":{"200":{"description":"Log statements","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logResult"},"examples":{"success":{"description":"Success response of a log request.","value":{"from":"2023-11-07T14:00:00.000Z","to":"2023-11-07T16:15:12.454Z","entries":[{"timestamp":1699368094644,"duration":467,"status":201,"method":"POST,","route":"preview","path":"/my-page","contentBusId":"xyz","owner":"owner","repo":"repo","ref":"ref"},{"timestamp":1699372505155,"event":"dinner is ready","contentBusId":"xyz","owner":"owner","repo":"repo","ref":"ref"}],"nextToken":"ABAB=="}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}},"post":{"operationId":"addLogs","tags":["log"],"summary":"Add logs","description":"Add logs to a project. The body should be in JSON format and contain an array called `entries`.\n","security":[{"AuthCookie":["log:read","log:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logEntriesBody"},"examples":{"multiple-entries":{"description":"This posts one entry to the audit log. To see what the added entry would look like, see the second entry in the [getLog](#tag/log/operation/getLogs) example.\n","value":{"entries":[{"event":"dinner is ready"}]}}}}}},"responses":{"201":{"description":"Logs added."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}}},"components":{"securitySchemes":{"AuthCookie":{"type":"apiKey","in":"cookie","name":"auth_token"},"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"parameters":{"ownerParam":{"name":"owner","in":"path","description":"Repository owner.","required":true,"schema":{"type":"string"}},"repoParam":{"name":"repo","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},"refParam":{"name":"ref","in":"path","description":"Ref (branch) of repository.","required":true,"schema":{"type":"string"}},"pathParam":{"name":"path","in":"path","description":"Relative path of the resource","required":true,"schema":{"type":"string"}},"statusEditUrlParam":{"name":"editUrl","in":"query","description":"Optional URL of the edit (authoring) document","required":false,"schema":{"oneOf":[{"type":"string","format":"url"},{"type":"string","enum":["auto"]}]}},"forceUpdateRedirectsParam":{"name":"forceUpdateRedirects","in":"query","description":"forces an update of the redirects (only applies when updating/publishing redirects.json)","required":false,"schema":{"type":"boolean"}},"disableNotificationsParam":{"name":"disableNotifications","in":"query","description":"disables notifications for affected resources","schema":{"type":"boolean"}},"word2mdVersionParam":{"name":"hlx-word2md-version","in":"query","description":"selects the version to use when invoking the word2md service.","required":false,"schema":{"type":"string"}},"gdocs2mdVersionParam":{"name":"hlx-gdocs2md-version","in":"query","description":"selects the version to use when invoking the gdocs2md service.","required":false,"schema":{"type":"string"}},"html2mdVersionParam":{"name":"hlx-html2md-version","in":"query","description":"selects the version to use when invoking the html2md service.","required":false,"schema":{"type":"string"}},"branchParam":{"name":"branch","in":"query","description":"Optional branch specifier in case the branch name contains slashes or uppercase characters.","required":false,"schema":{"oneOf":[{"type":"string","format":"url"},{"type":"string","enum":["auto"]}]}},"convertUrlParam":{"name":"url","in":"query","description":"URL of video to convert","required":true,"schema":{"type":"string"}},"convertIdParam":{"name":"id","in":"path","description":"conversion job Id","required":true,"schema":{"type":"string"}},"topicParam":{"name":"topic","in":"path","description":"Topic of a job","required":true,"schema":{"type":"string"}},"jobNameParam":{"name":"jobName","in":"path","description":"Name of a job","required":true,"schema":{"type":"string"}},"fromParam":{"name":"from","in":"query","description":"Indicates the starting date to get logs from. If not specified, uses the current date minus 15 minutes.\n","required":false,"schema":{"type":"string"}},"toParam":{"name":"to","in":"query","description":"Indicates the ending date to get logs from. If not specified, uses the current date.\n","required":false,"schema":{"type":"string"}},"nextTokenParam":{"name":"nextToken","in":"query","description":"Token returned from a previous call to continue\n","required":false,"schema":{"type":"string"}}},"schemas":{"resourceInfo":{"required":["webPath","resourcePath"],"properties":{"webPath":{"description":"Relative path used on the websites.","type":"string"},"resourcePath":{"description":"Relative path of the content resource","type":"string"}}},"permissions":{"description":"Access permissions","required":["permissions"],"properties":{"permissions":{"type":"array","items":{"type":"string","enum":["read","write","delete"]}}}},"contentBusResource":{"required":["contentBusId"],"properties":{"contentBusId":{"description":"Full content-bus id.","type":"string"},"lastModified":{"description":"Last modification date. undefined when resource is missing.","type":"string","format":"date-time"},"contentType":{"description":"The resource content type. undefined when resource is missing.","type":"string"},"contentLength":{"description":"Size of the content in bytes. undefined when resource is missing.","type":"integer"},"redirectLocation":{"description":"Location for redirects as defined on the resource","type":"string","format":"url"},"configRedirectLocation":{"description":"Location for redirects as defined in the config (redirects.json)","type":"string","format":"url"},"sourceLocation":{"description":"Content provider specific id of the source.","type":"string","format":"url"},"sourceLastModified":{"description":"Last modification date of the source document.","type":"string","format":"date-time"}}},"liveInfo":{"required":["live"],"properties":{"live":{"description":"Information about the published resource.","allOf":[{"required":["url","status"]},{"properties":{"status":{"description":"HTTP status of response when fetching thre information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"},"url":{"description":"Live URL of the resource.","type":"string","format":"url"}}},{"$ref":"#/components/schemas/permissions"},{"$ref":"#/components/schemas/contentBusResource"}]}}},"previewInfo":{"required":["preview"],"properties":{"preview":{"description":"Information about the preview resource.","allOf":[{"required":["url","status"]},{"properties":{"status":{"description":"HTTP status of response when fetching the information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"},"url":{"description":"Preview URL of the resource.","type":"string","format":"url"}}},{"$ref":"#/components/schemas/permissions"},{"$ref":"#/components/schemas/contentBusResource"}]}}},"folderInfo":{"required":["name","path","url"],"properties":{"name":{"description":"Name of folder","type":"string"},"path":{"description":"Path of folder, relative to the mount root","type":"string"},"url":{"description":"URL of folder","type":"string","format":"url"}}},"editResource":{"description":"Edit information for a resource","properties":{"url":{"description":"URL of edit document.","type":"string","format":"url"},"sourceLocation":{"description":"Content provider specific id of the source","type":"string","format":"url"},"lastModified":{"description":"Last modification date of the source document.","type":"string","format":"date-time"},"name":{"description":"Name of the edit document","type":"string"},"contentType":{"description":"Content type of the edit document","type":"string"},"folders":{"description":"Information of parent folders of the edit document.","type":"array","items":{"$ref":"#/components/schemas/folderInfo"}}}},"editInfo":{"required":["edit"],"properties":{"edit":{"description":"Edit information for a resource","type":"object","allOf":[{"required":["url","status"]},{"properties":{"status":{"description":"HTTP status of response when fetching thre information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"}}},{"$ref":"#/components/schemas/editResource"}]}}},"codeBusResource":{"required":["codeBusId"],"properties":{"codeBusId":{"description":"Full code-bus id.","type":"string"},"lastModified":{"description":"Last modification date. undefined when resource is missing.","type":"string","format":"date-time"},"contentType":{"description":"The resource content type. undefined when resource is missing.","type":"string"},"contentLength":{"description":"Size of the content in bytes. undefined when resource is missing.","type":"integer"},"sourceLocation":{"description":"Content provider specific id of the source","type":"string","format":"url"},"sourceLastModified":{"description":"Last modification date of the source document.","type":"string","format":"date-time"}}},"codeInfo":{"required":["code"],"properties":{"code":{"description":"Information about a code bus resource","type":"object","allOf":[{"required":["status"]},{"properties":{"status":{"description":"HTTP status of response when fetching thre information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"}}},{"$ref":"#/components/schemas/codeBusResource"},{"$ref":"#/components/schemas/permissions"}]}}},"resourceLinksInfo":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"status":{"description":"link of the status api","example":"https://admin.hlx.page/status/owner/repo/ref","type":"string","format":"url"},"live":{"description":"link of the live api","example":"https://admin.hlx.page/live/owner/repo/ref","type":"string","format":"url"},"preview":{"description":"link of the preview api","example":"https://admin.hlx.page/preview/owner/repo/ref","type":"string","format":"url"},"code":{"description":"link of the code api","example":"https://admin.hlx.page/code/owner/repo/ref","type":"string","format":"url"}}}}},"profileInfo":{"properties":{"profile":{"description":"Profile data","additionalProperties":true,"properties":{"iss":{"description":"id token issuer","type":"string"},"email":{"description":"email of logged in user","type":"string"},"name":{"description":"name of logged in user","type":"string"},"ttl":{"description":"time to live of current id token","type":"number"}}}}},"bulkStatusBody":{"description":"bulk status body","required":["paths"],"properties":{"paths":{"description":"paths to filter the bulk status","type":"array","items":{"type":"string"}},"select":{"description":"a combination of `edit`, `preview` and `live`. The default is `['preview','live']`.","type":"array","items":{"type":"string"}}}},"jobStatus":{"required":["topic","name","state","startTime"],"properties":{"topic":{"description":"Job Topic","type":"string"},"name":{"description":"Job Name","type":"string"},"state":{"description":"Job State","type":"string"},"startTime":{"description":"Job start time","type":"string","format":"date-time"},"endTime":{"description":"Job end time","type":"string","format":"date-time"},"cancelled":{"description":"Flag indicating if job was cancelled","type":"boolean"},"data":{"description":"Custom job data","type":"object"},"progress":{"description":"job progress","type":"object"}}},"jobCreated":{"required":["messageId","job"],"properties":{"messageId":{"description":"Internal message id","type":"string"},"job":{"description":"Job state","type":"object","$ref":"#/components/schemas/jobStatus"}}},"jobLinksInfo":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"self":{"description":"link of the job api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13","type":"string","format":"url"},"details":{"description":"link of the job details api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13/details","type":"string","format":"url"},"list":{"description":"link of the job list","example":"https://admin.hlx.page/job/owner/repo/ref/preview","type":"string","format":"url"}}}}},"bulkPublishBody":{"description":"bulk publish body","required":["paths"],"properties":{"forceUpdate":{"description":"forces an update of the resources during bulk-publish","type":"boolean"},"paths":{"description":"paths to filter the bulk publish","type":"array","items":{"type":"string"}},"delete":{"description":"delete the resources from publish","type":"boolean","default":false}}},"bulkPreviewBody":{"description":"bulk preview body","required":["paths"],"properties":{"forceUpdate":{"description":"forces an update of the resources during bulk-preview","type":"boolean"},"paths":{"description":"paths to filter the bulk preview","type":"array","items":{"type":"string"}},"delete":{"description":"delete the resources from preview","type":"boolean","default":false}}},"changeEntry":{"description":"Describes the changes made to one resource.","required":["type","path"],"properties":{"type":{"description":"change type","type":"string","enum":["added","deleted","modified"]},"path":{"description":"Relative path of changed resource or `*` if this as a branch event.","type":"string"},"time":{"description":"timestamp of change","type":"string","format":"date-time"},"commit":{"description":"commit sha of change","type":"string"},"contentType":{"description":"the content type of the changed resource","type":"string"}}},"changeEventBody":{"description":"Change event payload","required":["changes"],"additionalProperties":true,"properties":{"source":{"description":"event source, eg: 'github'\n","type":"string"},"baseRef":{"description":"base ref for branch operations","type":"string"},"changes":{"description":"array of changes","type":"array","items":{"$ref":"#/components/schemas/changeEntry"}}}},"indexResource":{"description":"Information of the index","required":["name"],"properties":{"name":{"description":"Index name in helix-index.yaml","type":"string"},"githubLink":{"description":"Github url of the helix-index.yaml","example":"https://github.com/owner/repo/blob/main/helix-index.yaml#L4","type":"string","format":"url"},"indexedUrl":{"description":"URL of document that was indexed. Deprecation Note: The indexed html is always fetched from the preview/live url at the time of publishing and hence not required in helix-index.yaml anymore.\n","deprecated":true,"example":"https://main--owner--repo.hlx.page/en/2021/blog","type":"string","format":"url"},"lastModified":{"type":"string","format":"date-time"},"status":{"description":"status of index operation on resource","type":"number"}}},"indexInfo":{"required":["index"],"properties":{"index":{"description":"Information of the index","type":"object","$ref":"#/components/schemas/indexResource"}}},"loginLinks":{"required":["links"],"properties":{"links":{"description":"API navigation links","additionalProperties":{"type":"string","format":"url"}}}},"logoutLink":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"logout":{"description":"link of logout","example":"https://admin.hlx.page/logout","type":"string","format":"url"}}}}},"formPostJSONBody":{"description":"Form POST body","properties":{"data":{"description":"A data structure representing the form fields. Can be in the form of a key/value object, an array of name/value pair objects.\n","oneOf":[{"type":"object"},{"type":"array"}]}}},"formPostURLEncodedBody":{"description":"Form POST body as form-urlencoded string. Be sure to set the 'Content-Type' header of the request to `application/x-www-form-urlencoded`","type":"string"},"formPostResponse":{"type":"object","description":"Form POST response","properties":{"rowCount":{"description":"The number of rows contained in the sheet after the POST operation","type":"number"},"columns":{"description":"The column headings in the incoming sheet","type":"array","items":{"type":"string"}}}},"sitemapInfo":{"description":"Information for the sitemap that was generated","properties":{"paths":{"description":"Paths that were updated","type":"array","items":{"type":"string"}}}},"jobStarted":{"required":["id"],"properties":{"id":{"description":"Convert job id","type":"string"}}},"jobInfo":{"required":["state"],"properties":{"state":{"description":"Convert job state","type":"string"},"url":{"description":"Input URL","type":"string"},"outputs":{"description":"Transcoded videos","type":"array","items":{"type":"string"}},"mediaUrls":{"description":"URLs in the media bus","type":"array","items":{"type":"string"}}}},"jobList":{"required":["topic","jobs"],"properties":{"topic":{"description":"Job Topic","type":"string"},"jobs":{"description":"Jobs","type":"array","items":{"required":["name","state","time","href"],"description":"Job info","type":"object","properties":{"name":{"description":"Job name","type":"string"},"state":{"description":"Job State","type":"string"},"time":{"description":"Job creation time","type":"string","format":"date-time"},"href":{"description":"link of the job api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13","type":"string","format":"url"}}}}}},"jobListLink":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"self":{"description":"link of the job list","example":"https://admin.hlx.page/job/owner/repo/ref/preview","type":"string","format":"url"}}}}},"jobStatusDetails":{"required":["topic","name","state","startTime","data"],"properties":{"topic":{"description":"Job Topic","type":"string"},"name":{"description":"Job Name","type":"string"},"state":{"description":"Job State","type":"string"},"startTime":{"description":"Job start time","type":"string","format":"date-time"},"endTime":{"description":"Job end time","type":"string","format":"date-time"},"cancelled":{"description":"Flag indicating if job was cancelled","type":"boolean"},"data":{"description":"Custom job data","type":"object"},"progress":{"description":"job progress","type":"object"}}},"jobLinksInfoDetails":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"self":{"description":"link of the job details api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13/details","type":"string","format":"url"},"job":{"description":"link of the job api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13","type":"string","format":"url"},"list":{"description":"link of the job list","example":"https://admin.hlx.page/job/owner/repo/ref/preview","type":"string","format":"url"}}}}},"logResult":{"description":"Log result","required":["entries"],"properties":{"entries":{"description":"entries in that page","type":"array","items":{"type":"object"}},"nextToken":{"description":"token to pass in next call to continue paging","type":"string"},"from":{"description":"log start time","type":"string"},"to":{"description":"log end time","type":"string"}}},"logEntriesBody":{"description":"Add logs body","required":["entries"],"properties":{"entries":{"description":"entries to add to the logs","type":"array","items":{"type":"object"}}}}},"headers":{"xError":{"description":"A short descriptive error message","schema":{"format":"none","type":"string"}},"location":{"description":"The redirect location","schema":{"type":"string"}}},"responses":{"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}},"examples":{"example":{"summary":"fetch status of multiple files","value":{"select":["edit","preview","live"],"paths":["/en","/en/*","/blog/"]}},"bulk-publish-payload_example":{"summary":"publish multiple files","value":{"forceUpdate":true,"paths":["/en","/metadata.json","/blog/"],"delete":false}},"bulk-preview-payload_example":{"summary":"preview multiple files","value":{"forceUpdate":true,"paths":["/en","/en/*","/metadata.json","/blog/"],"delete":false}},"change-event-payload_example":{"summary":"Multiple files event example","value":{"type":"github","baseRef":"","installationId":995843,"changes":[{"path":"new-file.txt","time":"2021-05-04T13:40:15+09:00","type":"added","contentType":"text/plain; charset=utf-8","commit":"5edf98811d50b5b948f6f890f0c4367095490dbd"},{"path":"src/html.htl","time":"2021-05-04T13:40:15+09:00","type":"deleted","contentType":"application/octet-stream","commit":"5edf98811d50b5b948f6f890f0c4367095490dbd"},{"path":"README.md","time":"2021-05-04T13:40:15+09:00","type":"modified","contentType":"text/markdown; charset=utf-8","commit":"5edf98811d50b5b948f6f890f0c4367095490dbd"},{"path":"fail.md","time":"2021-05-04T13:40:15+09:00","type":"modified","contentType":"text/markdown; charset=utf-8","commit":"5edf98811d50b5b948f6f890f0c4367095490dbd"}]}}}}}},"searchIndex":{"store":["tag/status","tag/status/operation/status","tag/status/operation/bulkStatus","tag/publish","tag/publish/operation/getPublishStatus","tag/publish/operation/publishResource","tag/publish/operation/unpublishResource","tag/publish/operation/bulkPublish","tag/preview","tag/preview/operation/previewStatus","tag/preview/operation/updatePreview","tag/preview/operation/deletePreview","tag/preview/operation/bulkPreview","tag/code","tag/code/operation/codeStatus","tag/code/operation/updateCode","tag/code/operation/deleteCode","tag/code/operation/batchCode","tag/cache","tag/cache/operation/purgeCache","tag/index","tag/index/operation/getIndexStatus","tag/index/operation/indexResource","tag/index/operation/indexRemovePage","tag/authentication","tag/authentication/operation/login","tag/authentication/operation/login-repo","tag/authentication/operation/logout","tag/authentication/operation/profile","tag/form","tag/form/operation/formCreation","tag/sitemap","tag/sitemap/operation/generateSitemap","tag/convert","tag/convert/operation/convertStart","tag/convert/operation/convertStatus","tag/job","tag/job/operation/getJobList","tag/job/operation/getJob","tag/job/operation/stopJob","tag/job/operation/getJobDetails","tag/log","tag/log/operation/getLogs","tag/log/operation/addLogs"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.983]],["description/0",[0,1.171,1,1.907]],["title/1",[0,0.779,2,2.53]],["description/1",[0,0.944,3,1.359,4,4.083,5,2.151,6,0.887,7,4.083]],["title/2",[0,0.551,8,1.472,9,1.355,10,0.661]],["description/2",[0,0.542,3,0.463,6,0.509,9,0.791,11,1.044,12,0.941,13,1.601,14,1.76,15,1.181,16,1.181,17,0.941,18,1.181,19,1.181,20,0.941,21,1.39,22,2.344,23,1.76,24,1.39,25,1.879,26,1.39,27,1.39,28,1.39,29,1.39,30,1.39,31,1.39,32,1.39,33,1.39,34,0.492,35,0.859,36,1.044,37,1.39,38,1.044,39,1.044,40,1.044,41,0.859,42,1.39,43,1.39]],["title/3",[44,1.944]],["description/3",[1,1.907,44,2.316]],["title/4",[0,0.779,44,1.541]],["description/4",[0,0.944,3,1.359,5,2.151,6,0.887,44,1.867,45,3.066]],["title/5",[6,0.732,44,1.541]],["description/5",[6,0.815,34,0.887,35,1.548,44,1.146,45,1.881,46,2.505,47,1.696,48,2.541,49,2.541,50,1.548,51,1.32,52,1.425,53,2.135,54,1.425,55,1.227]],["title/6",[6,0.732,56,2.863]],["description/6",[6,0.617,35,1.757,45,2.135,47,1.925,48,1.925,49,1.925,50,1.757,51,1.498,52,1.617,53,2.344,54,1.617,55,1.393,56,2.416,57,1.757]],["title/7",[8,1.472,9,1.355,10,0.661,44,1.089]],["description/7",[3,0.533,6,0.573,9,1.5,10,0.445,12,1.084,13,0.843,14,1.98,25,0.989,35,0.989,38,1.98,39,1.202,40,1.202,41,0.989,44,0.732,55,0.784,58,1.292,59,1.601,60,1.36,61,1.36,62,1.36,63,1.36,64,1.36,65,1.36,66,1.36,67,1.36,68,1.36,69,1.36,70,1.36,71,1.36,72,1.36,73,1.601,74,1.36,75,1.601]],["title/8",[34,1.505]],["description/8",[1,1.907,34,1.793]],["title/9",[0,0.779,34,1.193]],["description/9",[0,0.944,3,1.359,5,2.151,6,0.887,34,1.445,76,3.066]],["title/10",[34,1.193,58,1.651]],["description/10",[6,0.617,11,2.135,34,1.459,47,2.79,48,1.925,49,1.925,58,1.393,76,2.135,77,2.416,78,2.416,79,2.843,80,2.843,81,2.416]],["title/11",[34,1.193,57,2.082]],["description/11",[6,0.846,34,1.813,48,2.636,49,2.636,57,2.407,76,2.924]],["title/12",[8,1.472,9,1.355,10,0.661,34,0.843]],["description/12",[3,0.47,6,0.516,9,1.352,10,0.392,12,0.957,13,1.252,14,1.785,15,1.201,16,1.201,17,0.957,18,1.201,19,1.201,20,0.957,25,0.873,34,0.841,38,1.785,39,1.061,40,1.061,41,0.873,55,0.692,58,1.165,60,1.201,61,1.201,62,1.201,63,1.201,64,1.201,65,1.201,66,1.201,67,1.201,68,1.201,69,1.201,70,1.201,71,1.201,72,1.201,74,1.201,82,1.413,83,1.413,84,1.413]],["title/13",[85,2.083]],["description/13",[1,1.799,85,2.341,86,3.587]],["title/14",[0,0.645,85,1.367,86,2.095]],["description/14",[0,0.9,3,1.297,5,2.051,6,0.846,85,1.908,86,2.924,87,2.924]],["title/15",[58,1.651,85,1.651]],["description/15",[5,1.041,6,0.429,11,1.484,13,1.041,17,1.338,20,1.338,47,1.338,50,1.221,51,1.041,52,1.124,53,1.779,54,1.124,55,0.968,58,1.532,77,1.68,81,1.68,87,1.484,88,2.913,89,3.127,90,1.68,91,1.68,92,1.68,93,1.976]],["title/16",[57,2.082,85,1.651]],["description/16",[6,0.687,50,1.955,51,1.666,52,1.8,53,2.53,54,1.8,55,1.55,57,1.955,85,1.55,87,2.375,88,2.375]],["title/17",[58,1.367,85,1.367,94,2.791]],["description/17",[50,1.818,51,1.55,52,1.674,53,2.403,54,1.674,55,1.442,58,1.442,88,2.209,95,2.942,96,2.942,97,2.942,98,2.942,99,2.942]],["title/18",[100,3.192]],["description/18",[1,1.907,100,3.803]],["title/19",[35,1.725,51,1.47,100,2.095]],["description/19",[5,1.55,6,0.639,51,2.225,52,1.674,53,2.403,54,1.674,55,1.442,101,2.942,102,2.942,103,2.942,104,2.942,105,2.942]],["title/20",[106,2.239]],["description/20",[1,1.907,106,2.668]],["title/21",[0,0.779,106,1.775]],["description/21",[0,0.944,3,1.359,5,2.151,6,0.887,106,2.151,107,3.066]],["title/22",[6,0.732,108,3.369]],["description/22",[6,0.917,13,1.55,17,1.992,20,1.992,44,1.346,90,2.5,91,2.5,92,2.5,106,1.55,107,2.209,109,2.942,110,2.942,111,2.942]],["title/23",[6,0.606,106,1.47,112,2.371]],["description/23",[6,0.982,106,2.382,107,3.395,112,3.842]],["title/24",[113,3.612]],["description/24",[1,1.907,113,4.304]],["title/25",[36,2.53,114,2.281]],["description/25",[36,3.066,78,3.47,114,3.577,115,4.083,116,3.47]],["title/26",[114,2.281,117,3.369]],["description/26",[116,3.47,118,3.47,119,4.083,120,3.066,121,4.083,122,4.083]],["title/27",[123,3.612]],["description/27",[114,2.52,118,3.163,123,3.163,124,1.961,125,3.722,126,3.163,127,3.722,128,3.722]],["title/28",[25,2.082,129,2.863]],["description/28",[25,2.794,129,4.79,130,4.521]],["title/29",[131,2.877]],["description/29",[1,1.907,131,3.428]],["title/30",[41,2.082,131,2.281]],["description/30",[13,0.744,23,2.31,34,0.5,41,1.902,131,1.609,132,1.413,133,4.025,134,3.077,135,2.377,136,1.413,137,1.413,138,1.413,139,1.201,140,1.413,141,1.413,142,1.413,143,1.413,144,2.377,145,1.413,146,1.201,147,1.413,148,1.413,149,1.413,150,1.413,151,1.413,152,1.413,153,1.413,154,1.413,155,1.413,156,1.201,157,1.413,158,1.413]],["title/31",[159,2.877]],["description/31",[1,1.907,159,3.428]],["title/32",[2,2.53,159,2.281]],["description/32",[2,2.795,12,2.52,13,2.619,159,3.366,160,3.722,161,3.722]],["title/33",[162,2.627]],["description/33",[1,1.907,162,3.13]],["title/34",[8,2.082,162,2.082]],["description/34",[8,2.652,10,1.191,163,4.291,164,4.291,165,4.291]],["title/35",[0,0.779,162,2.082]],["description/35",[0,0.944,3,1.359,10,1.134,126,3.47,162,2.523,166,4.083]],["title/36",[10,1.18]],["description/36",[1,1.907,10,1.406]],["title/37",[10,0.936,167,2.863]],["description/37",[3,1.429,10,1.514,167,3.646,168,4.291]],["title/38",[0,0.779,10,0.936]],["description/38",[0,1.045,3,1.505,10,1.255,169,3.842]],["title/39",[10,0.936,170,2.863]],["description/39",[10,1.327,169,4.06,170,4.06]],["title/40",[0,0.645,10,0.775,171,2.791]],["description/40",[0,1.045,3,1.505,10,1.255,172,4.521]],["title/41",[124,2.239]],["description/41",[1,1.907,124,2.668]],["title/42",[3,1.122,124,1.775]],["description/42",[3,1.505,120,3.395,124,2.382,173,3.842]],["title/43",[124,1.775,174,2.863]],["description/43",[23,2.468,120,2.468,124,1.731,139,2.793,146,2.793,156,2.793,173,2.793,174,2.793,175,3.287,176,3.287,177,3.287]]],"invertedIndex":[["",{"_index":17,"title":{},"description":{"2":{},"12":{},"15":{},"22":{}}}],["_byo_",{"_index":54,"title":{},"description":{"5":{},"6":{},"15":{},"16":{},"17":{},"19":{}}}],["_live_",{"_index":52,"title":{},"description":{"5":{},"6":{},"15":{},"16":{},"17":{},"19":{}}}],["accordingli",{"_index":98,"title":{},"description":{"17":{}}}],["add",{"_index":174,"title":{"43":{}},"description":{"43":{}}}],["addition",{"_index":50,"title":{},"description":{"5":{},"6":{},"15":{},"16":{},"17":{}}}],["alway",{"_index":70,"title":{},"description":{"7":{},"12":{}}}],["api",{"_index":147,"title":{},"description":{"30":{}}}],["approv",{"_index":151,"title":{},"description":{"30":{}}}],["array",{"_index":176,"title":{},"description":{"43":{}}}],["assum",{"_index":18,"title":{},"description":{"2":{},"12":{}}}],["asynchron",{"_index":40,"title":{},"description":{"2":{},"7":{},"12":{}}}],["authent",{"_index":113,"title":{"24":{}},"description":{"24":{}}}],["auto",{"_index":117,"title":{"26":{}},"description":{}}],["avail",{"_index":115,"title":{},"description":{"25":{}}}],["batch",{"_index":94,"title":{"17":{}},"description":{}}],["befor",{"_index":145,"title":{},"description":{"30":{}}}],["below",{"_index":110,"title":{},"description":{"22":{}}}],["bodi",{"_index":139,"title":{},"description":{"30":{},"43":{}}}],["bu",{"_index":86,"title":{"14":{}},"description":{"13":{},"14":{}}}],["bulk",{"_index":9,"title":{"2":{},"7":{},"12":{}},"description":{"2":{},"7":{},"12":{}}}],["cach",{"_index":100,"title":{"18":{},"19":{}},"description":{"18":{}}}],["cache/{owner}/{repo}/{ref}/{path",{"_index":105,"title":{},"description":{"19":{}}}],["call",{"_index":146,"title":{},"description":{"30":{},"43":{}}}],["cdn",{"_index":53,"title":{},"description":{"5":{},"6":{},"15":{},"16":{},"17":{},"19":{}}}],["chang",{"_index":96,"title":{},"description":{"17":{}}}],["code",{"_index":85,"title":{"13":{},"14":{},"15":{},"16":{},"17":{}},"description":{"13":{},"14":{},"16":{}}}],["code-bu",{"_index":88,"title":{},"description":{"15":{},"16":{},"17":{}}}],["code/{owner}/{repo}/{ref",{"_index":99,"title":{},"description":{"17":{}}}],["code/{owner}/{repo}/{ref}/{path",{"_index":87,"title":{},"description":{"14":{},"15":{},"16":{}}}],["combin",{"_index":32,"title":{},"description":{"2":{}}}],["configur",{"_index":55,"title":{},"description":{"5":{},"6":{},"7":{},"12":{},"15":{},"16":{},"17":{},"19":{}}}],["contain",{"_index":23,"title":{},"description":{"2":{},"30":{},"43":{}}}],["content",{"_index":47,"title":{},"description":{"5":{},"6":{},"10":{},"15":{}}}],["content-bu",{"_index":48,"title":{},"description":{"5":{},"6":{},"10":{},"11":{}}}],["content-proxi",{"_index":80,"title":{},"description":{"10":{}}}],["convers",{"_index":164,"title":{},"description":{"34":{}}}],["convert",{"_index":162,"title":{"33":{},"34":{},"35":{}},"description":{"33":{},"35":{}}}],["convert/{owner}/{repo}/{ref",{"_index":165,"title":{},"description":{"34":{}}}],["convert/{owner}/{repo}/{ref}/${id",{"_index":166,"title":{},"description":{"35":{}}}],["copi",{"_index":46,"title":{},"description":{"5":{}}}],["correspond",{"_index":119,"title":{},"description":{"26":{}}}],["creat",{"_index":41,"title":{"30":{}},"description":{"2":{},"7":{},"12":{},"30":{}}}],["current",{"_index":126,"title":{},"description":{"27":{},"35":{}}}],["data",{"_index":134,"title":{},"description":{"30":{}}}],["default",{"_index":60,"title":{},"description":{"7":{},"12":{}}}],["delet",{"_index":57,"title":{"11":{},"16":{}},"description":{"6":{},"11":{},"16":{}}}],["destin",{"_index":160,"title":{},"description":{"32":{}}}],["detail",{"_index":171,"title":{"40":{}},"description":{}}],["directori",{"_index":93,"title":{},"description":{"15":{}}}],["display",{"_index":130,"title":{},"description":{"28":{}}}],["do",{"_index":148,"title":{},"description":{"30":{}}}],["dure",{"_index":72,"title":{},"description":{"7":{},"12":{}}}],["e.g",{"_index":79,"title":{},"description":{"10":{}}}],["edit",{"_index":33,"title":{},"description":{"2":{}}}],["end",{"_index":16,"title":{},"description":{"2":{},"12":{}}}],["entri",{"_index":177,"title":{},"description":{"43":{}}}],["event",{"_index":97,"title":{},"description":{"17":{}}}],["extens",{"_index":157,"title":{},"description":{"30":{}}}],["fetch",{"_index":11,"title":{},"description":{"2":{},"10":{},"15":{}}}],["file",{"_index":67,"title":{},"description":{"7":{},"12":{}}}],["filter",{"_index":30,"title":{},"description":{"2":{}}}],["folder",{"_index":19,"title":{},"description":{"2":{},"12":{}}}],["folliow",{"_index":24,"title":{},"description":{"2":{}}}],["forceupd",{"_index":64,"title":{},"description":{"7":{},"12":{}}}],["form",{"_index":131,"title":{"29":{},"30":{}},"description":{"29":{},"30":{}}}],["form/{owner}/{repo}/{ref}/{path",{"_index":158,"title":{},"description":{"30":{}}}],["format",{"_index":175,"title":{},"description":{"43":{}}}],["gener",{"_index":2,"title":{"1":{},"32":{}},"description":{"32":{}}}],["github",{"_index":89,"title":{},"description":{"15":{}}}],["helix/config",{"_index":68,"title":{},"description":{"7":{},"12":{}}}],["hook",{"_index":103,"title":{},"description":{"19":{}}}],["idp",{"_index":116,"title":{},"description":{"25":{},"26":{}}}],["ignor",{"_index":71,"title":{},"description":{"7":{},"12":{}}}],["incom",{"_index":141,"title":{},"description":{"30":{}}}],["index",{"_index":106,"title":{"20":{},"21":{},"23":{}},"description":{"20":{},"21":{},"22":{},"23":{}}}],["index/{owner}/{repo}/{ref}/{path",{"_index":107,"title":{},"description":{"21":{},"22":{},"23":{}}}],["inform",{"_index":25,"title":{"28":{}},"description":{"2":{},"7":{},"12":{},"28":{}}}],["ingest",{"_index":135,"title":{},"description":{"30":{}}}],["intak",{"_index":153,"title":{},"description":{"30":{}}}],["invok",{"_index":102,"title":{},"description":{"19":{}}}],["job",{"_index":10,"title":{"2":{},"7":{},"12":{},"36":{},"37":{},"38":{},"39":{},"40":{}},"description":{"7":{},"12":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{},"40":{}}}],["job/{owner}/{repo}/{ref}/{top",{"_index":168,"title":{},"description":{"37":{}}}],["job/{owner}/{repo}/{ref}/{topic}/{jobnam",{"_index":169,"title":{},"description":{"38":{},"39":{}}}],["job/{owner}/{repo}/{ref}/{topic}/{jobname}/detail",{"_index":172,"title":{},"description":{"40":{}}}],["job](#tag/job",{"_index":42,"title":{},"description":{"2":{}}}],["json",{"_index":156,"title":{},"description":{"30":{},"43":{}}}],["last",{"_index":90,"title":{},"description":{"15":{},"22":{}}}],["latest",{"_index":77,"title":{},"description":{"10":{},"15":{}}}],["list",{"_index":167,"title":{"37":{}},"description":{"37":{}}}],["live",{"_index":35,"title":{"19":{}},"description":{"2":{},"5":{},"6":{},"7":{}}}],["live/{owner}/{repo}/{ref",{"_index":75,"title":{},"description":{"7":{}}}],["live/{owner}/{repo}/{ref}/{path",{"_index":45,"title":{},"description":{"4":{},"5":{},"6":{}}}],["log",{"_index":124,"title":{"41":{},"42":{},"43":{}},"description":{"27":{},"41":{},"42":{},"43":{}}}],["log/{owner}/{repo}/{ref",{"_index":173,"title":{},"description":{"42":{},"43":{}}}],["login",{"_index":114,"title":{"25":{},"26":{}},"description":{"25":{},"27":{}}}],["login/{owner}/{repo}/{ref",{"_index":122,"title":{},"description":{"26":{}}}],["logout",{"_index":123,"title":{"27":{}},"description":{"27":{}}}],["manual",{"_index":142,"title":{},"description":{"30":{}}}],["modifi",{"_index":62,"title":{},"description":{"7":{},"12":{}}}],["name",{"_index":140,"title":{},"description":{"30":{}}}],["necessari",{"_index":136,"title":{},"description":{"30":{}}}],["new",{"_index":61,"title":{},"description":{"7":{},"12":{}}}],["note",{"_index":38,"title":{},"description":{"2":{},"7":{},"12":{}}}],["oper",{"_index":1,"title":{},"description":{"0":{},"3":{},"8":{},"13":{},"18":{},"20":{},"24":{},"29":{},"31":{},"33":{},"36":{},"41":{}}}],["option",{"_index":101,"title":{},"description":{"19":{}}}],["out",{"_index":125,"title":{},"description":{"27":{}}}],["overal",{"_index":4,"title":{},"description":{"1":{}}}],["partit",{"_index":49,"title":{},"description":{"5":{},"6":{},"10":{},"11":{}}}],["pass",{"_index":31,"title":{},"description":{"2":{}}}],["path",{"_index":13,"title":{},"description":{"2":{},"7":{},"12":{},"15":{},"22":{},"30":{},"32":{}}}],["payload",{"_index":15,"title":{},"description":{"2":{},"12":{}}}],["payload.<br",{"_index":59,"title":{},"description":{"7":{}}}],["payload.<br><br",{"_index":37,"title":{},"description":{"2":{}}}],["perform",{"_index":39,"title":{},"description":{"2":{},"7":{},"12":{}}}],["possibl",{"_index":29,"title":{},"description":{"2":{}}}],["post",{"_index":138,"title":{},"description":{"30":{}}}],["prepar",{"_index":132,"title":{},"description":{"30":{}}}],["preview",{"_index":34,"title":{"8":{},"9":{},"10":{},"11":{},"12":{}},"description":{"2":{},"5":{},"8":{},"9":{},"10":{},"11":{},"12":{},"30":{}}}],["preview.<br",{"_index":83,"title":{},"description":{"12":{}}}],["preview/{owner}/{repo}/{ref",{"_index":84,"title":{},"description":{"12":{}}}],["preview/{owner}/{repo}/{ref}/{path",{"_index":76,"title":{},"description":{"9":{},"10":{},"11":{}}}],["previewed.<br",{"_index":82,"title":{},"description":{"12":{}}}],["previewlastmodifi",{"_index":27,"title":{},"description":{"2":{}}}],["process",{"_index":95,"title":{},"description":{"17":{}}}],["processed.<br><br",{"_index":21,"title":{},"description":{"2":{}}}],["profil",{"_index":129,"title":{"28":{}},"description":{"28":{}}}],["project",{"_index":120,"title":{},"description":{"26":{},"42":{},"43":{}}}],["properti",{"_index":14,"title":{},"description":{"2":{},"7":{},"12":{}}}],["provid",{"_index":78,"title":{},"description":{"10":{},"25":{}}}],["publish",{"_index":44,"title":{"3":{},"4":{},"5":{},"7":{}},"description":{"3":{},"4":{},"5":{},"7":{},"22":{}}}],["publish.<br",{"_index":73,"title":{},"description":{"7":{}}}],["publishlastmodifi",{"_index":28,"title":{},"description":{"2":{}}}],["purg",{"_index":51,"title":{"19":{}},"description":{"5":{},"6":{},"15":{},"16":{},"17":{},"19":{}}}],["re-index",{"_index":108,"title":{"22":{}},"description":{}}],["recurs",{"_index":20,"title":{},"description":{"2":{},"12":{},"15":{},"22":{}}}],["redirect",{"_index":118,"title":{},"description":{"26":{},"27":{}}}],["redirects.json",{"_index":69,"title":{},"description":{"7":{},"12":{}}}],["reindex",{"_index":109,"title":{},"description":{"22":{}}}],["remov",{"_index":112,"title":{"23":{}},"description":{"23":{}}}],["request",{"_index":74,"title":{},"description":{"7":{},"12":{}}}],["resourc",{"_index":6,"title":{"5":{},"6":{},"22":{},"23":{}},"description":{"1":{},"2":{},"4":{},"5":{},"6":{},"7":{},"9":{},"10":{},"11":{},"12":{},"14":{},"15":{},"16":{},"19":{},"21":{},"22":{},"23":{}}}],["respect",{"_index":5,"title":{},"description":{"1":{},"4":{},"9":{},"14":{},"15":{},"19":{},"21":{}}}],["respons",{"_index":22,"title":{},"description":{"2":{}}}],["return",{"_index":3,"title":{"42":{}},"description":{"1":{},"2":{},"4":{},"7":{},"9":{},"12":{},"14":{},"21":{},"35":{},"37":{},"38":{},"40":{},"42":{}}}],["screen",{"_index":128,"title":{},"description":{"27":{}}}],["segment",{"_index":91,"title":{},"description":{"15":{},"22":{}}}],["select",{"_index":36,"title":{"25":{}},"description":{"2":{},"25":{}}}],["servic",{"_index":150,"title":{},"description":{"30":{}}}],["session",{"_index":127,"title":{},"description":{"27":{}}}],["set",{"_index":65,"title":{},"description":{"7":{},"12":{}}}],["setup",{"_index":121,"title":{},"description":{"26":{}}}],["shared-default",{"_index":154,"title":{},"description":{"30":{}}}],["sheet",{"_index":133,"title":{},"description":{"30":{}}}],["signal",{"_index":149,"title":{},"description":{"30":{}}}],["sitemap",{"_index":159,"title":{"31":{},"32":{}},"description":{"31":{},"32":{}}}],["sitemap/{owner}/{repo}/{ref}/{path",{"_index":161,"title":{},"description":{"32":{}}}],["slack",{"_index":155,"title":{},"description":{"30":{}}}],["sourcelastmodifi",{"_index":26,"title":{},"description":{"2":{}}}],["specifi",{"_index":12,"title":{},"description":{"2":{},"7":{},"12":{},"32":{}}}],["start",{"_index":8,"title":{"2":{},"7":{},"12":{},"34":{}},"description":{"34":{}}}],["statu",{"_index":0,"title":{"0":{},"1":{},"2":{},"4":{},"9":{},"14":{},"21":{},"35":{},"38":{},"40":{}},"description":{"0":{},"1":{},"2":{},"4":{},"9":{},"14":{},"21":{},"35":{},"38":{},"40":{}}}],["status/{owner}/{repo}/{ref",{"_index":43,"title":{},"description":{"2":{}}}],["status/{owner}/{repo}/{ref}/{path",{"_index":7,"title":{},"description":{"1":{}}}],["stop",{"_index":170,"title":{"39":{}},"description":{"39":{}}}],["store",{"_index":81,"title":{},"description":{"10":{},"15":{}}}],["sub",{"_index":111,"title":{},"description":{"22":{}}}],["tables/head",{"_index":137,"title":{},"description":{"30":{}}}],["target",{"_index":143,"title":{},"description":{"30":{}}}],["todo",{"_index":104,"title":{},"description":{"19":{}}}],["tree",{"_index":92,"title":{},"description":{"15":{},"22":{}}}],["true`.<br",{"_index":66,"title":{},"description":{"7":{},"12":{}}}],["un-publish",{"_index":56,"title":{"6":{}},"description":{"6":{}}}],["unless",{"_index":63,"title":{},"description":{"7":{},"12":{}}}],["updat",{"_index":58,"title":{"10":{},"15":{},"17":{}},"description":{"7":{},"10":{},"12":{},"15":{},"17":{}}}],["us",{"_index":152,"title":{},"description":{"30":{}}}],["video",{"_index":163,"title":{},"description":{"34":{}}}],["workbook",{"_index":144,"title":{},"description":{"30":{}}}]],"pipeline":[]}},"options":{}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);