diff --git a/docs/admin.html b/docs/admin.html
index 41cec094..31616603 100644
--- a/docs/admin.html
+++ b/docs/admin.html
@@ -417,7 +417,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-dxfSRF gKgOpF api-content"><div class="sc-eDLKEg iLDMWi"><div class="sc-iBdoyZ hfKSyc"><div class="sc-hLQTFJ iYTzza api-info"><h1 class="sc-fsYfxw sc-eFyDJw bAxWNM ildTjo">Helix Admin API<!-- --> <span>(<!-- -->10.64.3<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-crHHpN iYiFqZ">Download</a></p><div class="sc-iKOmII sc-cCzKow lktHVY xuweW"><div class="sc-bqOYer nLwPV"><div class="sc-gHjWgo leowuF"> <!-- --> <span class="sc-dEFUya eOWwWA">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-iKOmII sc-cCzKow lktHVY xuweW"></div><div data-role="redoc-description" html="&lt;p&gt;Helix Admin API is used to manage the lifecycle of helix documents.&lt;/p&gt;
+        " fill="currentColor"></path></g></svg></div></div><div class="sc-dxfSRF gKgOpF api-content"><div class="sc-eDLKEg iLDMWi"><div class="sc-iBdoyZ hfKSyc"><div class="sc-hLQTFJ iYTzza api-info"><h1 class="sc-fsYfxw sc-eFyDJw bAxWNM ildTjo">Helix Admin API<!-- --> <span>(<!-- -->10.64.4<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-crHHpN iYiFqZ">Download</a></p><div class="sc-iKOmII sc-cCzKow lktHVY xuweW"><div class="sc-bqOYer nLwPV"><div class="sc-gHjWgo leowuF"> <!-- --> <span class="sc-dEFUya eOWwWA">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-iKOmII sc-cCzKow lktHVY xuweW"></div><div data-role="redoc-description" html="&lt;p&gt;Helix Admin API is used to manage the lifecycle of helix documents.&lt;/p&gt;
 " class="sc-iKOmII sc-cCzKow lktHVY xuweW"><p>Helix Admin API is used to manage the lifecycle of helix documents.</p>
 </div></div></div></div><div id="tag/status" data-section-id="tag/status" class="sc-eDLKEg iLDMWi"><div class="sc-iBdoyZ hfKSyc"><div class="sc-hLQTFJ iYTzza"><h1 class="sc-fsYfxw bAxWNM"><a class="sc-csKJRI cuXxNv" href="#tag/status" aria-label="tag/status"></a>status</h1></div></div><div class="sc-hLQTFJ HzSqq"><div class="sc-iKOmII sc-cCzKow lktHVY xuweW redoc-markdown " html="&lt;p&gt;Status operations&lt;/p&gt;
 "><p>Status operations</p>
@@ -1089,7 +1089,7 @@
 " class="sc-iKOmII sc-cCzKow lktHVY xuweW sc-ckdFFX dyGheG"><p>Operation failed due to an internal error.</p>
 </div></button></div></div></div><div class="sc-jTQDJr sc-gLLuHO fwyuAP ftmCEy"><div class="sc-bPrmLV gsJZlH"><button class="sc-GkKyA giUNjB"><span type="post" class="sc-jYnQeP kWgyor http-verb post">post</span><span class="sc-fYrVDh tYHRE">/log/{owner}/{repo}/{ref}</span><svg class="sc-eTNxZ jaElDA" 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-eGgFai jCvEmu"><div class="sc-fnphUx ivAlis"><div html="" class="sc-iKOmII sc-cCzKow lktHVY eXcYps"></div><div tabindex="0" role="button"><div class="sc-lkDGoM llzBgo"><span>https://admin.hlx.page</span>/log/{owner}/{repo}/{ref}</div></div></div></div></div><div><h3 class="sc-kFCrIq yVWyK"> <!-- -->Request samples<!-- --> </h3><div class="sc-cyZbyy iTBMaq" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="react-tabs__tab react-tabs__tab--selected" role="tab" id="react-tabs-46" aria-selected="true" aria-disabled="false" aria-controls="react-tabs-47" tabindex="0" data-rttab="true">Payload</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="react-tabs-47" aria-labelledby="react-tabs-46"><div><div class="sc-cPtzEK kyLQMH"><span class="sc-bCvmwx kxEnCv">Content type</span><div class="sc-dQmiQg hZLvzz">application/json</div></div><div class="sc-hVcFBF hIWQYe"><div class="sc-cSxSEp eDEhla"><div class="sc-gjLLkZ hFZVbn"><button><div class="sc-jdHHBG efVAqH">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-iKOmII lktHVY sc-jMbUzY hNYODe"><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">"message"</span>: <span class="token string">&quot;first&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><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">"message"</span>: <span class="token string">&quot;second&quot;</span></div></li></ul><span class="token punctuation">}</span>,</div></li><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">"message"</span>: <span class="token string">&quot;third&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-juurlU jMrzyV"></div></div></div>
       <script>
-      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"version":"10.64.3","title":"Helix Admin API","description":"Helix Admin API is used to manage the lifecycle of helix documents.","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"},{"$ref":"#/components/parameters/contentBusIdParam"}],"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"}}}},"/live/{owner}/{repo}/{ref}/{path}":{"get":{"operationId":"getPublishStatus","tags":["publish"],"summary":"Publish Status","description":"Returns the publish 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"},{"$ref":"#/components/parameters/contentBusIdParam"}],"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/contentBusIdParam"},{"$ref":"#/components/parameters/forceUpdateRedirectsParam"}],"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/contentBusIdParam"}],"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"}}}},"/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"},{"$ref":"#/components/parameters/contentBusIdParam"}],"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/contentBusIdParam"},{"$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"},{"$ref":"#/components/parameters/contentBusIdParam"}],"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/example"}}}}},"responses":{"200":{"description":"Bulk preview scheduled.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobCreated"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"status":200,"invocationId":"abcd-1234","job":{"topic":"preview","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","data":{"rootPath":"/documents"}},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123"}}}}}}},"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\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}/{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":{"200":{"description":"The Job Status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobStatus"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response of a job status.","value":{"topic":"preview","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","data":{"rootPath":"/documents"},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123"}}}}}}},"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"}}}},"/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":{"entries":[{"id":1,"route":"preview"},{"id":2,"route":"live"}],"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","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":{"value":{"entries":[{"message":"first"},{"message":"second"},{"message":"third"}]}}}}}},"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"]}]}},"contentBusIdParam":{"name":"x-helix-contentbus-id","in":"header","description":"Helix content-bus id used to access content-bus data.","required":false,"schema":{"type":"string"}},"forceUpdateRedirectsParam":{"name":"forceUpdateRedirects","in":"query","description":"forces an update of the redirects (only applies when updating/publishing redirects.json)","required":false,"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"}}}}},"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"}}}},"jobStatus":{"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"}}},"jobCreated":{"required":["status","invocationId","job"],"properties":{"status":{"description":"Job invocation status","type":"number"},"invocationId":{"description":"Job invocation 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"}}}}},"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"}}}},"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"}}},"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 tte 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":"preview multiple files","value":{"forceUpdate":true,"paths":["/en","/en/*","/metadata.json","/blog/"]}},"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/publish","tag/publish/operation/getPublishStatus","tag/publish/operation/publishResource","tag/publish/operation/unpublishResource","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/getJob","tag/job/operation/stopJob","tag/log","tag/log/operation/getLogs","tag/log/operation/addLogs"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,1.117]],["description/0",[0,1.325,1,1.729]],["title/1",[0,0.876,2,2.368]],["description/1",[0,1.036,3,1.55,4,3.764,5,1.933,6,0.846,7,3.764]],["title/2",[8,2.084]],["description/2",[1,1.729,8,2.473]],["title/3",[0,0.876,8,1.635]],["description/3",[0,1.036,3,1.55,5,1.933,6,0.846,8,1.933,9,2.8]],["title/4",[6,0.715,8,1.635]],["description/4",[6,0.759,8,1.13,9,1.638,10,2.201,11,1.47,12,0.79,13,2.258,14,2.258,15,1.638,16,1.337,17,1.13,18,1.226,19,1.882,20,1.226,21,1.13]],["title/5",[6,0.715,22,2.692]],["description/5",[6,0.567,9,1.877,11,1.686,13,1.686,14,1.686,15,1.877,16,1.533,17,1.296,18,1.405,19,2.087,20,1.405,21,1.296,22,2.134,23,1.533]],["title/6",[12,1.457]],["description/6",[1,1.729,12,1.729]],["title/7",[0,0.876,12,1.143]],["description/7",[0,1.036,3,1.55,5,1.933,6,0.846,12,1.352,24,2.8]],["title/8",[12,1.143,25,1.635]],["description/8",[6,0.567,11,2.503,12,1.346,13,1.686,14,1.686,24,1.877,25,1.296,26,2.134,27,2.134,28,2.134,29,2.524,30,2.524,31,2.134]],["title/9",[12,1.143,23,1.933]],["description/9",[6,0.802,12,1.72,13,2.384,14,2.384,23,2.167,24,2.655]],["title/10",[12,0.799,32,1.654,33,1.88,34,0.916]],["description/10",[3,0.495,6,0.464,12,0.741,21,0.618,25,1.06,33,1.746,34,0.495,35,1.203,36,1.379,37,2.064,38,1.203,39,1.203,40,0.895,41,1.203,42,1.203,43,0.895,44,1.203,45,1.203,46,1.203,47,1.203,48,1.203,49,1.203,50,1.203,51,1.203,52,2.064,53,1.203,54,1.203,55,1.203,56,1.203,57,1.203,58,1.203,59,1.203,60,1.203,61,1.203,62,1.203,63,0.895,64,0.895,65,1.203]],["title/11",[66,1.931]],["description/11",[1,1.616,66,2.141,67,3.349]],["title/12",[0,0.72,66,1.245,67,1.948]],["description/12",[0,0.982,3,1.47,5,1.833,6,0.802,66,1.698,67,2.655,68,2.655]],["title/13",[25,1.635,66,1.514]],["description/13",[5,0.878,6,0.384,11,1.142,16,1.038,17,0.878,18,0.952,19,1.542,20,0.952,21,0.878,25,1.422,26,1.446,27,1.446,31,1.446,36,1.142,40,1.272,43,1.272,68,1.272,69,2.596,70,2.769,71,1.446,72,1.446,73,1.446,74,1.71]],["title/14",[23,1.933,66,1.514]],["description/14",[6,0.637,16,1.722,17,1.456,18,1.579,19,2.272,20,1.579,21,1.456,23,1.722,66,1.349,68,2.109,69,2.109]],["title/15",[25,1.345,66,1.245,75,2.618]],["description/15",[16,1.591,17,1.345,18,1.459,19,2.145,20,1.459,21,1.345,25,1.345,69,1.949,76,2.62,77,2.62,78,2.62,79,2.62,80,2.62]],["title/16",[81,3.019]],["description/16",[1,1.729,81,3.583]],["title/17",[15,1.948,17,1.345,81,1.948]],["description/17",[5,1.345,6,0.589,17,1.978,18,1.459,19,2.145,20,1.459,21,1.345,82,2.62,83,2.62,84,2.62,85,2.62,86,2.62]],["title/18",[87,2.084]],["description/18",[1,1.729,87,2.473]],["title/19",[0,0.876,87,1.635]],["description/19",[0,1.036,3,1.55,5,1.933,6,0.846,87,1.933,88,2.8]],["title/20",[6,0.715,89,3.183]],["description/20",[6,0.866,8,1.345,36,1.75,40,1.949,43,1.949,71,2.215,72,2.215,73,2.215,87,1.345,88,1.949,90,2.62,91,2.62,92,2.62]],["title/21",[6,0.588,87,1.345,93,2.214]],["description/21",[6,0.949,87,2.17,88,3.143,93,3.573]],["title/22",[94,3.432]],["description/22",[1,1.729,94,4.072]],["title/23",[95,2.126,96,2.692]],["description/23",[28,3.183,95,3.314,96,3.183,97,3.764,98,3.183]],["title/24",[95,2.126,99,3.183]],["description/24",[98,3.183,100,3.183,101,3.764,102,2.8,103,3.764,104,3.764]],["title/25",[105,3.432]],["description/25",[95,2.267,100,2.87,105,2.87,106,1.743,107,3.394,108,2.87,109,3.394,110,3.394]],["title/26",[63,2.368,111,2.692]],["description/26",[63,3.143,111,4.521,112,4.226]],["title/27",[113,2.711]],["description/27",[1,1.729,113,3.217]],["title/28",[64,2.368,113,2.126]],["description/28",[12,0.432,36,0.803,64,2.017,113,1.379,114,1.203,115,3.621,116,2.712,117,2.064,118,1.203,119,1.203,120,2.712,121,1.203,122,1.203,123,1.203,124,1.203,125,1.203,126,1.203,127,2.064,128,1.203,129,1.203,130,1.203,131,1.203,132,1.203,133,1.203,134,1.203,135,1.203,136,1.203,137,1.203,138,1.203,139,1.203,140,1.203,141,1.203]],["title/29",[142,2.711]],["description/29",[1,1.729,142,3.217]],["title/30",[2,2.368,142,2.126]],["description/30",[2,3.349,142,3.007,143,4.502]],["title/31",[144,2.465]],["description/31",[1,1.729,144,2.925]],["title/32",[32,2.368,144,1.933]],["description/32",[32,2.962,34,1.64,145,3.982,146,3.982,147,3.982]],["title/33",[0,0.876,144,1.933]],["description/33",[0,1.036,3,1.55,34,1.55,108,3.183,144,2.286,148,3.764]],["title/34",[34,1.671]],["description/34",[1,1.729,34,1.983]],["title/35",[0,0.876,34,1.311]],["description/35",[0,1.163,3,1.74,34,1.74,149,3.573]],["title/36",[34,1.311,150,2.692]],["description/36",[34,1.854,149,3.806,150,3.806]],["title/37",[106,2.084]],["description/37",[1,1.729,106,2.473]],["title/38",[3,1.311,106,1.635]],["description/38",[3,1.74,102,3.143,106,2.17,151,3.573]],["title/39",[106,1.635,152,2.692]],["description/39",[102,3.143,106,2.17,151,3.573,152,3.573]]],"invertedIndex":[["",{"_index":40,"title":{},"description":{"10":{},"13":{},"20":{}}}],["_byo_",{"_index":20,"title":{},"description":{"4":{},"5":{},"13":{},"14":{},"15":{},"17":{}}}],["_live_",{"_index":18,"title":{},"description":{"4":{},"5":{},"13":{},"14":{},"15":{},"17":{}}}],["accordingli",{"_index":79,"title":{},"description":{"15":{}}}],["add",{"_index":152,"title":{"39":{}},"description":{"39":{}}}],["addition",{"_index":16,"title":{},"description":{"4":{},"5":{},"13":{},"14":{},"15":{}}}],["alway",{"_index":56,"title":{},"description":{"10":{}}}],["api",{"_index":130,"title":{},"description":{"28":{}}}],["approv",{"_index":134,"title":{},"description":{"28":{}}}],["assum",{"_index":41,"title":{},"description":{"10":{}}}],["asynchron",{"_index":61,"title":{},"description":{"10":{}}}],["authent",{"_index":94,"title":{"22":{}},"description":{"22":{}}}],["auto",{"_index":99,"title":{"24":{}},"description":{}}],["avail",{"_index":97,"title":{},"description":{"23":{}}}],["batch",{"_index":75,"title":{"15":{}},"description":{}}],["befor",{"_index":128,"title":{},"description":{"28":{}}}],["below",{"_index":91,"title":{},"description":{"20":{}}}],["bodi",{"_index":122,"title":{},"description":{"28":{}}}],["bu",{"_index":67,"title":{"12":{}},"description":{"11":{},"12":{}}}],["bulk",{"_index":33,"title":{"10":{}},"description":{"10":{}}}],["cach",{"_index":81,"title":{"16":{},"17":{}},"description":{"16":{}}}],["cache/{owner}/{repo}/{ref}/{path",{"_index":86,"title":{},"description":{"17":{}}}],["call",{"_index":129,"title":{},"description":{"28":{}}}],["cdn",{"_index":19,"title":{},"description":{"4":{},"5":{},"13":{},"14":{},"15":{},"17":{}}}],["chang",{"_index":77,"title":{},"description":{"15":{}}}],["code",{"_index":66,"title":{"11":{},"12":{},"13":{},"14":{},"15":{}},"description":{"11":{},"12":{},"14":{}}}],["code-bu",{"_index":69,"title":{},"description":{"13":{},"14":{},"15":{}}}],["code/{owner}/{repo}/{ref",{"_index":80,"title":{},"description":{"15":{}}}],["code/{owner}/{repo}/{ref}/{path",{"_index":68,"title":{},"description":{"12":{},"13":{},"14":{}}}],["configur",{"_index":21,"title":{},"description":{"4":{},"5":{},"10":{},"13":{},"14":{},"15":{},"17":{}}}],["contain",{"_index":120,"title":{},"description":{"28":{}}}],["content",{"_index":11,"title":{},"description":{"4":{},"5":{},"8":{},"13":{}}}],["content-bu",{"_index":13,"title":{},"description":{"4":{},"5":{},"8":{},"9":{}}}],["content-proxi",{"_index":30,"title":{},"description":{"8":{}}}],["convers",{"_index":146,"title":{},"description":{"32":{}}}],["convert",{"_index":144,"title":{"31":{},"32":{},"33":{}},"description":{"31":{},"33":{}}}],["convert/{owner}/{repo}/{ref",{"_index":147,"title":{},"description":{"32":{}}}],["convert/{owner}/{repo}/{ref}/${id",{"_index":148,"title":{},"description":{"33":{}}}],["copi",{"_index":10,"title":{},"description":{"4":{}}}],["correspond",{"_index":101,"title":{},"description":{"24":{}}}],["creat",{"_index":64,"title":{"28":{}},"description":{"10":{},"28":{}}}],["current",{"_index":108,"title":{},"description":{"25":{},"33":{}}}],["data",{"_index":116,"title":{},"description":{"28":{}}}],["default",{"_index":45,"title":{},"description":{"10":{}}}],["delet",{"_index":23,"title":{"9":{},"14":{}},"description":{"5":{},"9":{},"14":{}}}],["directori",{"_index":74,"title":{},"description":{"13":{}}}],["display",{"_index":112,"title":{},"description":{"26":{}}}],["do",{"_index":131,"title":{},"description":{"28":{}}}],["dure",{"_index":58,"title":{},"description":{"10":{}}}],["e.g",{"_index":29,"title":{},"description":{"8":{}}}],["end",{"_index":39,"title":{},"description":{"10":{}}}],["event",{"_index":78,"title":{},"description":{"15":{}}}],["extens",{"_index":140,"title":{},"description":{"28":{}}}],["fetch",{"_index":26,"title":{},"description":{"8":{},"13":{}}}],["file",{"_index":53,"title":{},"description":{"10":{}}}],["folder",{"_index":42,"title":{},"description":{"10":{}}}],["forceupd",{"_index":49,"title":{},"description":{"10":{}}}],["form",{"_index":113,"title":{"27":{},"28":{}},"description":{"27":{},"28":{}}}],["form/{owner}/{repo}/{ref}/{path",{"_index":141,"title":{},"description":{"28":{}}}],["gener",{"_index":2,"title":{"1":{},"30":{}},"description":{"30":{}}}],["github",{"_index":70,"title":{},"description":{"13":{}}}],["helix/config",{"_index":54,"title":{},"description":{"10":{}}}],["hook",{"_index":84,"title":{},"description":{"17":{}}}],["idp",{"_index":98,"title":{},"description":{"23":{},"24":{}}}],["ignor",{"_index":57,"title":{},"description":{"10":{}}}],["incom",{"_index":124,"title":{},"description":{"28":{}}}],["index",{"_index":87,"title":{"18":{},"19":{},"21":{}},"description":{"18":{},"19":{},"20":{},"21":{}}}],["index/{owner}/{repo}/{ref}/{path",{"_index":88,"title":{},"description":{"19":{},"20":{},"21":{}}}],["inform",{"_index":63,"title":{"26":{}},"description":{"10":{},"26":{}}}],["ingest",{"_index":117,"title":{},"description":{"28":{}}}],["intak",{"_index":136,"title":{},"description":{"28":{}}}],["invok",{"_index":83,"title":{},"description":{"17":{}}}],["job",{"_index":34,"title":{"10":{},"34":{},"35":{},"36":{}},"description":{"10":{},"32":{},"33":{},"34":{},"35":{},"36":{}}}],["job/{owner}/{repo}/{ref}/{topic}/{jobnam",{"_index":149,"title":{},"description":{"35":{},"36":{}}}],["json",{"_index":139,"title":{},"description":{"28":{}}}],["last",{"_index":71,"title":{},"description":{"13":{},"20":{}}}],["latest",{"_index":27,"title":{},"description":{"8":{},"13":{}}}],["live",{"_index":15,"title":{"17":{}},"description":{"4":{},"5":{}}}],["live/{owner}/{repo}/{ref}/{path",{"_index":9,"title":{},"description":{"3":{},"4":{},"5":{}}}],["log",{"_index":106,"title":{"37":{},"38":{},"39":{}},"description":{"25":{},"37":{},"38":{},"39":{}}}],["log/{owner}/{repo}/{ref",{"_index":151,"title":{},"description":{"38":{},"39":{}}}],["login",{"_index":95,"title":{"23":{},"24":{}},"description":{"23":{},"25":{}}}],["login/{owner}/{repo}/{ref",{"_index":104,"title":{},"description":{"24":{}}}],["logout",{"_index":105,"title":{"25":{}},"description":{"25":{}}}],["manual",{"_index":125,"title":{},"description":{"28":{}}}],["modifi",{"_index":47,"title":{},"description":{"10":{}}}],["name",{"_index":123,"title":{},"description":{"28":{}}}],["necessari",{"_index":118,"title":{},"description":{"28":{}}}],["new",{"_index":46,"title":{},"description":{"10":{}}}],["note",{"_index":52,"title":{},"description":{"10":{}}}],["oper",{"_index":1,"title":{},"description":{"0":{},"2":{},"6":{},"11":{},"16":{},"18":{},"22":{},"27":{},"29":{},"31":{},"34":{},"37":{}}}],["option",{"_index":82,"title":{},"description":{"17":{}}}],["out",{"_index":107,"title":{},"description":{"25":{}}}],["overal",{"_index":4,"title":{},"description":{"1":{}}}],["partit",{"_index":14,"title":{},"description":{"4":{},"5":{},"8":{},"9":{}}}],["path",{"_index":36,"title":{},"description":{"10":{},"13":{},"20":{},"28":{}}}],["payload",{"_index":38,"title":{},"description":{"10":{}}}],["perform",{"_index":60,"title":{},"description":{"10":{}}}],["post",{"_index":121,"title":{},"description":{"28":{}}}],["prepar",{"_index":114,"title":{},"description":{"28":{}}}],["preview",{"_index":12,"title":{"6":{},"7":{},"8":{},"9":{},"10":{}},"description":{"4":{},"6":{},"7":{},"8":{},"9":{},"10":{},"28":{}}}],["preview.<br",{"_index":59,"title":{},"description":{"10":{}}}],["preview/{owner}/{repo}/{ref",{"_index":65,"title":{},"description":{"10":{}}}],["preview/{owner}/{repo}/{ref}/{path",{"_index":24,"title":{},"description":{"7":{},"8":{},"9":{}}}],["previewed.<br",{"_index":44,"title":{},"description":{"10":{}}}],["process",{"_index":76,"title":{},"description":{"15":{}}}],["profil",{"_index":111,"title":{"26":{}},"description":{"26":{}}}],["project",{"_index":102,"title":{},"description":{"24":{},"38":{},"39":{}}}],["properti",{"_index":37,"title":{},"description":{"10":{}}}],["provid",{"_index":28,"title":{},"description":{"8":{},"23":{}}}],["publish",{"_index":8,"title":{"2":{},"3":{},"4":{}},"description":{"2":{},"3":{},"4":{},"20":{}}}],["purg",{"_index":17,"title":{"17":{}},"description":{"4":{},"5":{},"13":{},"14":{},"15":{},"17":{}}}],["re-index",{"_index":89,"title":{"20":{}},"description":{}}],["recurs",{"_index":43,"title":{},"description":{"10":{},"13":{},"20":{}}}],["redirect",{"_index":100,"title":{},"description":{"24":{},"25":{}}}],["redirects.json",{"_index":55,"title":{},"description":{"10":{}}}],["reindex",{"_index":90,"title":{},"description":{"20":{}}}],["remov",{"_index":93,"title":{"21":{}},"description":{"21":{}}}],["request",{"_index":62,"title":{},"description":{"10":{}}}],["resourc",{"_index":6,"title":{"4":{},"5":{},"20":{},"21":{}},"description":{"1":{},"3":{},"4":{},"5":{},"7":{},"8":{},"9":{},"10":{},"12":{},"13":{},"14":{},"17":{},"19":{},"20":{},"21":{}}}],["respect",{"_index":5,"title":{},"description":{"1":{},"3":{},"7":{},"12":{},"13":{},"17":{},"19":{}}}],["return",{"_index":3,"title":{"38":{}},"description":{"1":{},"3":{},"7":{},"10":{},"12":{},"19":{},"33":{},"35":{},"38":{}}}],["screen",{"_index":110,"title":{},"description":{"25":{}}}],["segment",{"_index":72,"title":{},"description":{"13":{},"20":{}}}],["select",{"_index":96,"title":{"23":{}},"description":{"23":{}}}],["servic",{"_index":133,"title":{},"description":{"28":{}}}],["session",{"_index":109,"title":{},"description":{"25":{}}}],["set",{"_index":50,"title":{},"description":{"10":{}}}],["setup",{"_index":103,"title":{},"description":{"24":{}}}],["shared-default",{"_index":137,"title":{},"description":{"28":{}}}],["sheet",{"_index":115,"title":{},"description":{"28":{}}}],["signal",{"_index":132,"title":{},"description":{"28":{}}}],["sitemap",{"_index":142,"title":{"29":{},"30":{}},"description":{"29":{},"30":{}}}],["sitemap/{owner}/{repo}/{ref}/{path",{"_index":143,"title":{},"description":{"30":{}}}],["slack",{"_index":138,"title":{},"description":{"28":{}}}],["specifi",{"_index":35,"title":{},"description":{"10":{}}}],["start",{"_index":32,"title":{"10":{},"32":{}},"description":{"32":{}}}],["statu",{"_index":0,"title":{"0":{},"1":{},"3":{},"7":{},"12":{},"19":{},"33":{},"35":{}},"description":{"0":{},"1":{},"3":{},"7":{},"12":{},"19":{},"33":{},"35":{}}}],["status/{owner}/{repo}/{ref}/{path",{"_index":7,"title":{},"description":{"1":{}}}],["stop",{"_index":150,"title":{"36":{}},"description":{"36":{}}}],["store",{"_index":31,"title":{},"description":{"8":{},"13":{}}}],["sub",{"_index":92,"title":{},"description":{"20":{}}}],["tables/head",{"_index":119,"title":{},"description":{"28":{}}}],["target",{"_index":126,"title":{},"description":{"28":{}}}],["todo",{"_index":85,"title":{},"description":{"17":{}}}],["tree",{"_index":73,"title":{},"description":{"13":{},"20":{}}}],["true`.<br",{"_index":51,"title":{},"description":{"10":{}}}],["un-publish",{"_index":22,"title":{"5":{}},"description":{"5":{}}}],["unless",{"_index":48,"title":{},"description":{"10":{}}}],["updat",{"_index":25,"title":{"8":{},"13":{},"15":{}},"description":{"8":{},"10":{},"13":{},"15":{}}}],["us",{"_index":135,"title":{},"description":{"28":{}}}],["video",{"_index":145,"title":{},"description":{"32":{}}}],["workbook",{"_index":127,"title":{},"description":{"28":{}}}]],"pipeline":[]}},"options":{}};
+      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"version":"10.64.4","title":"Helix Admin API","description":"Helix Admin API is used to manage the lifecycle of helix documents.","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"},{"$ref":"#/components/parameters/contentBusIdParam"}],"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"}}}},"/live/{owner}/{repo}/{ref}/{path}":{"get":{"operationId":"getPublishStatus","tags":["publish"],"summary":"Publish Status","description":"Returns the publish 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"},{"$ref":"#/components/parameters/contentBusIdParam"}],"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/contentBusIdParam"},{"$ref":"#/components/parameters/forceUpdateRedirectsParam"}],"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/contentBusIdParam"}],"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"}}}},"/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"},{"$ref":"#/components/parameters/contentBusIdParam"}],"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/contentBusIdParam"},{"$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"},{"$ref":"#/components/parameters/contentBusIdParam"}],"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/example"}}}}},"responses":{"200":{"description":"Bulk preview scheduled.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobCreated"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"status":200,"invocationId":"abcd-1234","job":{"topic":"preview","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","data":{"rootPath":"/documents"}},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123"}}}}}}},"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\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}/{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":{"200":{"description":"The Job Status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobStatus"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response of a job status.","value":{"topic":"preview","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","data":{"rootPath":"/documents"},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123"}}}}}}},"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"}}}},"/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":{"entries":[{"id":1,"route":"preview"},{"id":2,"route":"live"}],"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","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":{"value":{"entries":[{"message":"first"},{"message":"second"},{"message":"third"}]}}}}}},"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"]}]}},"contentBusIdParam":{"name":"x-helix-contentbus-id","in":"header","description":"Helix content-bus id used to access content-bus data.","required":false,"schema":{"type":"string"}},"forceUpdateRedirectsParam":{"name":"forceUpdateRedirects","in":"query","description":"forces an update of the redirects (only applies when updating/publishing redirects.json)","required":false,"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"}}}}},"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"}}}},"jobStatus":{"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"}}},"jobCreated":{"required":["status","invocationId","job"],"properties":{"status":{"description":"Job invocation status","type":"number"},"invocationId":{"description":"Job invocation 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"}}}}},"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"}}}},"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"}}},"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 tte 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":"preview multiple files","value":{"forceUpdate":true,"paths":["/en","/en/*","/metadata.json","/blog/"]}},"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/publish","tag/publish/operation/getPublishStatus","tag/publish/operation/publishResource","tag/publish/operation/unpublishResource","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/getJob","tag/job/operation/stopJob","tag/log","tag/log/operation/getLogs","tag/log/operation/addLogs"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,1.117]],["description/0",[0,1.325,1,1.729]],["title/1",[0,0.876,2,2.368]],["description/1",[0,1.036,3,1.55,4,3.764,5,1.933,6,0.846,7,3.764]],["title/2",[8,2.084]],["description/2",[1,1.729,8,2.473]],["title/3",[0,0.876,8,1.635]],["description/3",[0,1.036,3,1.55,5,1.933,6,0.846,8,1.933,9,2.8]],["title/4",[6,0.715,8,1.635]],["description/4",[6,0.759,8,1.13,9,1.638,10,2.201,11,1.47,12,0.79,13,2.258,14,2.258,15,1.638,16,1.337,17,1.13,18,1.226,19,1.882,20,1.226,21,1.13]],["title/5",[6,0.715,22,2.692]],["description/5",[6,0.567,9,1.877,11,1.686,13,1.686,14,1.686,15,1.877,16,1.533,17,1.296,18,1.405,19,2.087,20,1.405,21,1.296,22,2.134,23,1.533]],["title/6",[12,1.457]],["description/6",[1,1.729,12,1.729]],["title/7",[0,0.876,12,1.143]],["description/7",[0,1.036,3,1.55,5,1.933,6,0.846,12,1.352,24,2.8]],["title/8",[12,1.143,25,1.635]],["description/8",[6,0.567,11,2.503,12,1.346,13,1.686,14,1.686,24,1.877,25,1.296,26,2.134,27,2.134,28,2.134,29,2.524,30,2.524,31,2.134]],["title/9",[12,1.143,23,1.933]],["description/9",[6,0.802,12,1.72,13,2.384,14,2.384,23,2.167,24,2.655]],["title/10",[12,0.799,32,1.654,33,1.88,34,0.916]],["description/10",[3,0.495,6,0.464,12,0.741,21,0.618,25,1.06,33,1.746,34,0.495,35,1.203,36,1.379,37,2.064,38,1.203,39,1.203,40,0.895,41,1.203,42,1.203,43,0.895,44,1.203,45,1.203,46,1.203,47,1.203,48,1.203,49,1.203,50,1.203,51,1.203,52,2.064,53,1.203,54,1.203,55,1.203,56,1.203,57,1.203,58,1.203,59,1.203,60,1.203,61,1.203,62,1.203,63,0.895,64,0.895,65,1.203]],["title/11",[66,1.931]],["description/11",[1,1.616,66,2.141,67,3.349]],["title/12",[0,0.72,66,1.245,67,1.948]],["description/12",[0,0.982,3,1.47,5,1.833,6,0.802,66,1.698,67,2.655,68,2.655]],["title/13",[25,1.635,66,1.514]],["description/13",[5,0.878,6,0.384,11,1.142,16,1.038,17,0.878,18,0.952,19,1.542,20,0.952,21,0.878,25,1.422,26,1.446,27,1.446,31,1.446,36,1.142,40,1.272,43,1.272,68,1.272,69,2.596,70,2.769,71,1.446,72,1.446,73,1.446,74,1.71]],["title/14",[23,1.933,66,1.514]],["description/14",[6,0.637,16,1.722,17,1.456,18,1.579,19,2.272,20,1.579,21,1.456,23,1.722,66,1.349,68,2.109,69,2.109]],["title/15",[25,1.345,66,1.245,75,2.618]],["description/15",[16,1.591,17,1.345,18,1.459,19,2.145,20,1.459,21,1.345,25,1.345,69,1.949,76,2.62,77,2.62,78,2.62,79,2.62,80,2.62]],["title/16",[81,3.019]],["description/16",[1,1.729,81,3.583]],["title/17",[15,1.948,17,1.345,81,1.948]],["description/17",[5,1.345,6,0.589,17,1.978,18,1.459,19,2.145,20,1.459,21,1.345,82,2.62,83,2.62,84,2.62,85,2.62,86,2.62]],["title/18",[87,2.084]],["description/18",[1,1.729,87,2.473]],["title/19",[0,0.876,87,1.635]],["description/19",[0,1.036,3,1.55,5,1.933,6,0.846,87,1.933,88,2.8]],["title/20",[6,0.715,89,3.183]],["description/20",[6,0.866,8,1.345,36,1.75,40,1.949,43,1.949,71,2.215,72,2.215,73,2.215,87,1.345,88,1.949,90,2.62,91,2.62,92,2.62]],["title/21",[6,0.588,87,1.345,93,2.214]],["description/21",[6,0.949,87,2.17,88,3.143,93,3.573]],["title/22",[94,3.432]],["description/22",[1,1.729,94,4.072]],["title/23",[95,2.126,96,2.692]],["description/23",[28,3.183,95,3.314,96,3.183,97,3.764,98,3.183]],["title/24",[95,2.126,99,3.183]],["description/24",[98,3.183,100,3.183,101,3.764,102,2.8,103,3.764,104,3.764]],["title/25",[105,3.432]],["description/25",[95,2.267,100,2.87,105,2.87,106,1.743,107,3.394,108,2.87,109,3.394,110,3.394]],["title/26",[63,2.368,111,2.692]],["description/26",[63,3.143,111,4.521,112,4.226]],["title/27",[113,2.711]],["description/27",[1,1.729,113,3.217]],["title/28",[64,2.368,113,2.126]],["description/28",[12,0.432,36,0.803,64,2.017,113,1.379,114,1.203,115,3.621,116,2.712,117,2.064,118,1.203,119,1.203,120,2.712,121,1.203,122,1.203,123,1.203,124,1.203,125,1.203,126,1.203,127,2.064,128,1.203,129,1.203,130,1.203,131,1.203,132,1.203,133,1.203,134,1.203,135,1.203,136,1.203,137,1.203,138,1.203,139,1.203,140,1.203,141,1.203]],["title/29",[142,2.711]],["description/29",[1,1.729,142,3.217]],["title/30",[2,2.368,142,2.126]],["description/30",[2,3.349,142,3.007,143,4.502]],["title/31",[144,2.465]],["description/31",[1,1.729,144,2.925]],["title/32",[32,2.368,144,1.933]],["description/32",[32,2.962,34,1.64,145,3.982,146,3.982,147,3.982]],["title/33",[0,0.876,144,1.933]],["description/33",[0,1.036,3,1.55,34,1.55,108,3.183,144,2.286,148,3.764]],["title/34",[34,1.671]],["description/34",[1,1.729,34,1.983]],["title/35",[0,0.876,34,1.311]],["description/35",[0,1.163,3,1.74,34,1.74,149,3.573]],["title/36",[34,1.311,150,2.692]],["description/36",[34,1.854,149,3.806,150,3.806]],["title/37",[106,2.084]],["description/37",[1,1.729,106,2.473]],["title/38",[3,1.311,106,1.635]],["description/38",[3,1.74,102,3.143,106,2.17,151,3.573]],["title/39",[106,1.635,152,2.692]],["description/39",[102,3.143,106,2.17,151,3.573,152,3.573]]],"invertedIndex":[["",{"_index":40,"title":{},"description":{"10":{},"13":{},"20":{}}}],["_byo_",{"_index":20,"title":{},"description":{"4":{},"5":{},"13":{},"14":{},"15":{},"17":{}}}],["_live_",{"_index":18,"title":{},"description":{"4":{},"5":{},"13":{},"14":{},"15":{},"17":{}}}],["accordingli",{"_index":79,"title":{},"description":{"15":{}}}],["add",{"_index":152,"title":{"39":{}},"description":{"39":{}}}],["addition",{"_index":16,"title":{},"description":{"4":{},"5":{},"13":{},"14":{},"15":{}}}],["alway",{"_index":56,"title":{},"description":{"10":{}}}],["api",{"_index":130,"title":{},"description":{"28":{}}}],["approv",{"_index":134,"title":{},"description":{"28":{}}}],["assum",{"_index":41,"title":{},"description":{"10":{}}}],["asynchron",{"_index":61,"title":{},"description":{"10":{}}}],["authent",{"_index":94,"title":{"22":{}},"description":{"22":{}}}],["auto",{"_index":99,"title":{"24":{}},"description":{}}],["avail",{"_index":97,"title":{},"description":{"23":{}}}],["batch",{"_index":75,"title":{"15":{}},"description":{}}],["befor",{"_index":128,"title":{},"description":{"28":{}}}],["below",{"_index":91,"title":{},"description":{"20":{}}}],["bodi",{"_index":122,"title":{},"description":{"28":{}}}],["bu",{"_index":67,"title":{"12":{}},"description":{"11":{},"12":{}}}],["bulk",{"_index":33,"title":{"10":{}},"description":{"10":{}}}],["cach",{"_index":81,"title":{"16":{},"17":{}},"description":{"16":{}}}],["cache/{owner}/{repo}/{ref}/{path",{"_index":86,"title":{},"description":{"17":{}}}],["call",{"_index":129,"title":{},"description":{"28":{}}}],["cdn",{"_index":19,"title":{},"description":{"4":{},"5":{},"13":{},"14":{},"15":{},"17":{}}}],["chang",{"_index":77,"title":{},"description":{"15":{}}}],["code",{"_index":66,"title":{"11":{},"12":{},"13":{},"14":{},"15":{}},"description":{"11":{},"12":{},"14":{}}}],["code-bu",{"_index":69,"title":{},"description":{"13":{},"14":{},"15":{}}}],["code/{owner}/{repo}/{ref",{"_index":80,"title":{},"description":{"15":{}}}],["code/{owner}/{repo}/{ref}/{path",{"_index":68,"title":{},"description":{"12":{},"13":{},"14":{}}}],["configur",{"_index":21,"title":{},"description":{"4":{},"5":{},"10":{},"13":{},"14":{},"15":{},"17":{}}}],["contain",{"_index":120,"title":{},"description":{"28":{}}}],["content",{"_index":11,"title":{},"description":{"4":{},"5":{},"8":{},"13":{}}}],["content-bu",{"_index":13,"title":{},"description":{"4":{},"5":{},"8":{},"9":{}}}],["content-proxi",{"_index":30,"title":{},"description":{"8":{}}}],["convers",{"_index":146,"title":{},"description":{"32":{}}}],["convert",{"_index":144,"title":{"31":{},"32":{},"33":{}},"description":{"31":{},"33":{}}}],["convert/{owner}/{repo}/{ref",{"_index":147,"title":{},"description":{"32":{}}}],["convert/{owner}/{repo}/{ref}/${id",{"_index":148,"title":{},"description":{"33":{}}}],["copi",{"_index":10,"title":{},"description":{"4":{}}}],["correspond",{"_index":101,"title":{},"description":{"24":{}}}],["creat",{"_index":64,"title":{"28":{}},"description":{"10":{},"28":{}}}],["current",{"_index":108,"title":{},"description":{"25":{},"33":{}}}],["data",{"_index":116,"title":{},"description":{"28":{}}}],["default",{"_index":45,"title":{},"description":{"10":{}}}],["delet",{"_index":23,"title":{"9":{},"14":{}},"description":{"5":{},"9":{},"14":{}}}],["directori",{"_index":74,"title":{},"description":{"13":{}}}],["display",{"_index":112,"title":{},"description":{"26":{}}}],["do",{"_index":131,"title":{},"description":{"28":{}}}],["dure",{"_index":58,"title":{},"description":{"10":{}}}],["e.g",{"_index":29,"title":{},"description":{"8":{}}}],["end",{"_index":39,"title":{},"description":{"10":{}}}],["event",{"_index":78,"title":{},"description":{"15":{}}}],["extens",{"_index":140,"title":{},"description":{"28":{}}}],["fetch",{"_index":26,"title":{},"description":{"8":{},"13":{}}}],["file",{"_index":53,"title":{},"description":{"10":{}}}],["folder",{"_index":42,"title":{},"description":{"10":{}}}],["forceupd",{"_index":49,"title":{},"description":{"10":{}}}],["form",{"_index":113,"title":{"27":{},"28":{}},"description":{"27":{},"28":{}}}],["form/{owner}/{repo}/{ref}/{path",{"_index":141,"title":{},"description":{"28":{}}}],["gener",{"_index":2,"title":{"1":{},"30":{}},"description":{"30":{}}}],["github",{"_index":70,"title":{},"description":{"13":{}}}],["helix/config",{"_index":54,"title":{},"description":{"10":{}}}],["hook",{"_index":84,"title":{},"description":{"17":{}}}],["idp",{"_index":98,"title":{},"description":{"23":{},"24":{}}}],["ignor",{"_index":57,"title":{},"description":{"10":{}}}],["incom",{"_index":124,"title":{},"description":{"28":{}}}],["index",{"_index":87,"title":{"18":{},"19":{},"21":{}},"description":{"18":{},"19":{},"20":{},"21":{}}}],["index/{owner}/{repo}/{ref}/{path",{"_index":88,"title":{},"description":{"19":{},"20":{},"21":{}}}],["inform",{"_index":63,"title":{"26":{}},"description":{"10":{},"26":{}}}],["ingest",{"_index":117,"title":{},"description":{"28":{}}}],["intak",{"_index":136,"title":{},"description":{"28":{}}}],["invok",{"_index":83,"title":{},"description":{"17":{}}}],["job",{"_index":34,"title":{"10":{},"34":{},"35":{},"36":{}},"description":{"10":{},"32":{},"33":{},"34":{},"35":{},"36":{}}}],["job/{owner}/{repo}/{ref}/{topic}/{jobnam",{"_index":149,"title":{},"description":{"35":{},"36":{}}}],["json",{"_index":139,"title":{},"description":{"28":{}}}],["last",{"_index":71,"title":{},"description":{"13":{},"20":{}}}],["latest",{"_index":27,"title":{},"description":{"8":{},"13":{}}}],["live",{"_index":15,"title":{"17":{}},"description":{"4":{},"5":{}}}],["live/{owner}/{repo}/{ref}/{path",{"_index":9,"title":{},"description":{"3":{},"4":{},"5":{}}}],["log",{"_index":106,"title":{"37":{},"38":{},"39":{}},"description":{"25":{},"37":{},"38":{},"39":{}}}],["log/{owner}/{repo}/{ref",{"_index":151,"title":{},"description":{"38":{},"39":{}}}],["login",{"_index":95,"title":{"23":{},"24":{}},"description":{"23":{},"25":{}}}],["login/{owner}/{repo}/{ref",{"_index":104,"title":{},"description":{"24":{}}}],["logout",{"_index":105,"title":{"25":{}},"description":{"25":{}}}],["manual",{"_index":125,"title":{},"description":{"28":{}}}],["modifi",{"_index":47,"title":{},"description":{"10":{}}}],["name",{"_index":123,"title":{},"description":{"28":{}}}],["necessari",{"_index":118,"title":{},"description":{"28":{}}}],["new",{"_index":46,"title":{},"description":{"10":{}}}],["note",{"_index":52,"title":{},"description":{"10":{}}}],["oper",{"_index":1,"title":{},"description":{"0":{},"2":{},"6":{},"11":{},"16":{},"18":{},"22":{},"27":{},"29":{},"31":{},"34":{},"37":{}}}],["option",{"_index":82,"title":{},"description":{"17":{}}}],["out",{"_index":107,"title":{},"description":{"25":{}}}],["overal",{"_index":4,"title":{},"description":{"1":{}}}],["partit",{"_index":14,"title":{},"description":{"4":{},"5":{},"8":{},"9":{}}}],["path",{"_index":36,"title":{},"description":{"10":{},"13":{},"20":{},"28":{}}}],["payload",{"_index":38,"title":{},"description":{"10":{}}}],["perform",{"_index":60,"title":{},"description":{"10":{}}}],["post",{"_index":121,"title":{},"description":{"28":{}}}],["prepar",{"_index":114,"title":{},"description":{"28":{}}}],["preview",{"_index":12,"title":{"6":{},"7":{},"8":{},"9":{},"10":{}},"description":{"4":{},"6":{},"7":{},"8":{},"9":{},"10":{},"28":{}}}],["preview.<br",{"_index":59,"title":{},"description":{"10":{}}}],["preview/{owner}/{repo}/{ref",{"_index":65,"title":{},"description":{"10":{}}}],["preview/{owner}/{repo}/{ref}/{path",{"_index":24,"title":{},"description":{"7":{},"8":{},"9":{}}}],["previewed.<br",{"_index":44,"title":{},"description":{"10":{}}}],["process",{"_index":76,"title":{},"description":{"15":{}}}],["profil",{"_index":111,"title":{"26":{}},"description":{"26":{}}}],["project",{"_index":102,"title":{},"description":{"24":{},"38":{},"39":{}}}],["properti",{"_index":37,"title":{},"description":{"10":{}}}],["provid",{"_index":28,"title":{},"description":{"8":{},"23":{}}}],["publish",{"_index":8,"title":{"2":{},"3":{},"4":{}},"description":{"2":{},"3":{},"4":{},"20":{}}}],["purg",{"_index":17,"title":{"17":{}},"description":{"4":{},"5":{},"13":{},"14":{},"15":{},"17":{}}}],["re-index",{"_index":89,"title":{"20":{}},"description":{}}],["recurs",{"_index":43,"title":{},"description":{"10":{},"13":{},"20":{}}}],["redirect",{"_index":100,"title":{},"description":{"24":{},"25":{}}}],["redirects.json",{"_index":55,"title":{},"description":{"10":{}}}],["reindex",{"_index":90,"title":{},"description":{"20":{}}}],["remov",{"_index":93,"title":{"21":{}},"description":{"21":{}}}],["request",{"_index":62,"title":{},"description":{"10":{}}}],["resourc",{"_index":6,"title":{"4":{},"5":{},"20":{},"21":{}},"description":{"1":{},"3":{},"4":{},"5":{},"7":{},"8":{},"9":{},"10":{},"12":{},"13":{},"14":{},"17":{},"19":{},"20":{},"21":{}}}],["respect",{"_index":5,"title":{},"description":{"1":{},"3":{},"7":{},"12":{},"13":{},"17":{},"19":{}}}],["return",{"_index":3,"title":{"38":{}},"description":{"1":{},"3":{},"7":{},"10":{},"12":{},"19":{},"33":{},"35":{},"38":{}}}],["screen",{"_index":110,"title":{},"description":{"25":{}}}],["segment",{"_index":72,"title":{},"description":{"13":{},"20":{}}}],["select",{"_index":96,"title":{"23":{}},"description":{"23":{}}}],["servic",{"_index":133,"title":{},"description":{"28":{}}}],["session",{"_index":109,"title":{},"description":{"25":{}}}],["set",{"_index":50,"title":{},"description":{"10":{}}}],["setup",{"_index":103,"title":{},"description":{"24":{}}}],["shared-default",{"_index":137,"title":{},"description":{"28":{}}}],["sheet",{"_index":115,"title":{},"description":{"28":{}}}],["signal",{"_index":132,"title":{},"description":{"28":{}}}],["sitemap",{"_index":142,"title":{"29":{},"30":{}},"description":{"29":{},"30":{}}}],["sitemap/{owner}/{repo}/{ref}/{path",{"_index":143,"title":{},"description":{"30":{}}}],["slack",{"_index":138,"title":{},"description":{"28":{}}}],["specifi",{"_index":35,"title":{},"description":{"10":{}}}],["start",{"_index":32,"title":{"10":{},"32":{}},"description":{"32":{}}}],["statu",{"_index":0,"title":{"0":{},"1":{},"3":{},"7":{},"12":{},"19":{},"33":{},"35":{}},"description":{"0":{},"1":{},"3":{},"7":{},"12":{},"19":{},"33":{},"35":{}}}],["status/{owner}/{repo}/{ref}/{path",{"_index":7,"title":{},"description":{"1":{}}}],["stop",{"_index":150,"title":{"36":{}},"description":{"36":{}}}],["store",{"_index":31,"title":{},"description":{"8":{},"13":{}}}],["sub",{"_index":92,"title":{},"description":{"20":{}}}],["tables/head",{"_index":119,"title":{},"description":{"28":{}}}],["target",{"_index":126,"title":{},"description":{"28":{}}}],["todo",{"_index":85,"title":{},"description":{"17":{}}}],["tree",{"_index":73,"title":{},"description":{"13":{},"20":{}}}],["true`.<br",{"_index":51,"title":{},"description":{"10":{}}}],["un-publish",{"_index":22,"title":{"5":{}},"description":{"5":{}}}],["unless",{"_index":48,"title":{},"description":{"10":{}}}],["updat",{"_index":25,"title":{"8":{},"13":{},"15":{}},"description":{"8":{},"10":{},"13":{},"15":{}}}],["us",{"_index":135,"title":{},"description":{"28":{}}}],["video",{"_index":145,"title":{},"description":{"32":{}}}],["workbook",{"_index":127,"title":{},"description":{"28":{}}}]],"pipeline":[]}},"options":{}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);