From 2949dcd892264285af899adc56e2eda1425aed73 Mon Sep 17 00:00:00 2001
From: github-actions <github-actions@github.com>
Date: Thu, 10 Oct 2024 08:57:45 +0000
Subject: [PATCH] chore(docs): update admin API docs [skip ci]

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

diff --git a/docs/admin-preview.html b/docs/admin-preview.html
index 70c0bf51..0844f54c 100644
--- a/docs/admin-preview.html
+++ b/docs/admin-preview.html
@@ -141,11 +141,11 @@
           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-dKGrn laenHu api-content"><div class="sc-dsLQwm diwyyM"><div class="sc-la-DxNn dSIRVR"><div class="sc-fQpRED htdgPt api-info"><h1 class="sc-iCZwEW sc-gjHHYa gfRsnu edbYXQ">AEM Admin API (Feature Preview)<!-- --> <span>(<!-- -->12.18.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-kyZTxD cwcfQE">Download</a></p><div class="sc-euGpHm sc-exayXG fwfkcU kqJXdD"><div class="sc-kwhYVV dgGfLY"><div class="sc-fyEUpq kqOgwj"> <!-- --> <span class="sc-ggPNws hrVgqq">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-euGpHm sc-exayXG fwfkcU kqJXdD"></div><div data-role="redoc-description" html="&lt;p&gt;AEM Admin API is used to manage the lifecycle of content and code.&lt;/p&gt;
+        " fill="currentColor"></path></g></svg></div></div><div class="sc-dKGrn laenHu api-content"><div class="sc-dsLQwm diwyyM"><div class="sc-la-DxNn dSIRVR"><div class="sc-fQpRED htdgPt api-info"><h1 class="sc-iCZwEW sc-gjHHYa gfRsnu edbYXQ">AEM Admin API (Feature Preview)<!-- --> <span>(<!-- -->12.18.1<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-kyZTxD cwcfQE">Download</a></p><div class="sc-euGpHm sc-exayXG fwfkcU kqJXdD"><div class="sc-kwhYVV dgGfLY"><div class="sc-fyEUpq kqOgwj"> <!-- --> <span class="sc-ggPNws hrVgqq">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-euGpHm sc-exayXG fwfkcU kqJXdD"></div><div data-role="redoc-description" html="&lt;p&gt;AEM Admin API is used to manage the lifecycle of content and code.&lt;/p&gt;
 " class="sc-euGpHm sc-exayXG fwfkcU kqJXdD"><p>AEM Admin API is used to manage the lifecycle of content and code.</p>
 </div></div></div></div></div><div class="sc-epzHnm bWkBKa"></div></div></div>
       <script>
-      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.1.0","info":{"version":"12.18.0","title":"AEM Admin API (Feature Preview)","description":"AEM Admin API is used to manage the lifecycle of content and code.","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://admin.hlx.page"}],"components":{"securitySchemes":{"AuthCookie":{"type":"apiKey","in":"cookie","name":"auth_token"},"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}}}},"searchIndex":{"store":[],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[],"invertedIndex":[],"pipeline":[]}},"options":{"schemasExpansionLevel":2}};
+      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.1.0","info":{"version":"12.18.1","title":"AEM Admin API (Feature Preview)","description":"AEM Admin API is used to manage the lifecycle of content and code.","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://admin.hlx.page"}],"components":{"securitySchemes":{"AuthCookie":{"type":"apiKey","in":"cookie","name":"auth_token"},"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}}}},"searchIndex":{"store":[],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[],"invertedIndex":[],"pipeline":[]}},"options":{"schemasExpansionLevel":2}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);
diff --git a/docs/admin.html b/docs/admin.html
index d86bd275..aa465cae 100644
--- a/docs/admin.html
+++ b/docs/admin.html
@@ -456,7 +456,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-dKGrn laenHu api-content"><div class="sc-dsLQwm diwyyM"><div class="sc-la-DxNn dSIRVR"><div class="sc-fQpRED htdgPt api-info"><h1 class="sc-iCZwEW sc-gjHHYa gfRsnu edbYXQ">AEM Admin API<!-- --> <span>(<!-- -->12.18.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-kyZTxD cwcfQE">Download</a></p><div class="sc-euGpHm sc-exayXG fwfkcU kqJXdD"><div class="sc-kwhYVV dgGfLY"><div class="sc-fyEUpq kqOgwj"> <!-- --> <span class="sc-ggPNws hrVgqq">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-euGpHm sc-exayXG fwfkcU kqJXdD"></div><div data-role="redoc-description" html="&lt;p&gt;AEM Admin API is used to manage the lifecycle of content and code.&lt;/p&gt;
+        " fill="currentColor"></path></g></svg></div></div><div class="sc-dKGrn laenHu api-content"><div class="sc-dsLQwm diwyyM"><div class="sc-la-DxNn dSIRVR"><div class="sc-fQpRED htdgPt api-info"><h1 class="sc-iCZwEW sc-gjHHYa gfRsnu edbYXQ">AEM Admin API<!-- --> <span>(<!-- -->12.18.1<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-kyZTxD cwcfQE">Download</a></p><div class="sc-euGpHm sc-exayXG fwfkcU kqJXdD"><div class="sc-kwhYVV dgGfLY"><div class="sc-fyEUpq kqOgwj"> <!-- --> <span class="sc-ggPNws hrVgqq">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-euGpHm sc-exayXG fwfkcU kqJXdD"></div><div data-role="redoc-description" html="&lt;p&gt;AEM Admin API is used to manage the lifecycle of content and code.&lt;/p&gt;
 " class="sc-euGpHm sc-exayXG fwfkcU kqJXdD"><p>AEM Admin API is used to manage the lifecycle of content and code.</p>
 </div></div></div></div><div id="tag/status" data-section-id="tag/status" class="sc-dsLQwm diwyyM"><div class="sc-la-DxNn dSIRVR"><div class="sc-fQpRED htdgPt"><h2 class="sc-knesRu cbpGTP"><a class="sc-jCbFiK hSvuOo" href="#tag/status" aria-label="tag/status"></a>status</h2></div></div><div class="sc-fQpRED gxopqJ"><div class="sc-euGpHm sc-exayXG fwfkcU kqJXdD redoc-markdown " html="&lt;p&gt;Status operations&lt;/p&gt;
 "><p>Status operations</p>
@@ -2434,7 +2434,7 @@
 " class="sc-euGpHm sc-exayXG fwfkcU kqJXdD sc-dHrNzZ dRdjww"><p>Sitemap configuration deleted.</p>
 </div></button></div></div></div><div class="sc-iKTcqh sc-gnpbhQ fTxZsC drGLlX"><div class="sc-dKsqdn dCbPd"><button class="sc-iAlELC gsBSOU"><span type="delete" class="sc-oeqTF ByFMv http-verb delete">delete</span><span class="sc-eowDPD jcAXWA">/config/{org}/sites/{site}/content/sitemap.yaml</span><svg class="sc-cBYhjr iMxoRf" 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-ezTrPE bFiOkX"><div class="sc-drnuxz hdRKqQ"><div html="" class="sc-euGpHm sc-exayXG fwfkcU jYGAQp"></div><div tabindex="0" role="button"><div class="sc-hDcvty jpmGrk"><span>https://admin.hlx.page</span>/config/{org}/sites/{site}/content/sitemap.yaml</div></div></div></div></div></div></div></div></div><div class="sc-epzHnm bWkBKa"></div></div></div>
       <script>
-      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.1.0","info":{"version":"12.18.0","title":"AEM Admin API","description":"AEM Admin API is used to manage the lifecycle of content and code.","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://admin.hlx.page"}],"tags":[{"name":"status","description":"Status operations"},{"name":"publish","description":"Publish operations"},{"name":"preview","description":"Preview operations"},{"name":"code","description":"Code bus operations"},{"name":"cache","description":"Cache operations"},{"name":"index","description":"Index operations"},{"name":"authentication","description":"The API uses your existing Identity Provider (IDP) to authenticate users with administrative access. The general flow is that you open `/login` in a browser, select the IDP you want to use, and then are redirected to the IDP login page. After successful login, you are redirected back to the Admin API with an auth token in the response cookie (`auth_token`). This token is then used to authenticate all subsequent requests. <br><br> Alternatively, you can provide an `authorization: token $API_KEY` header. In order to obtain an API_KEY, talk to your AEM project lead.\n"},{"name":"sitemap","description":"Sitemap operations"},{"name":"job","description":"Job operations"},{"name":"log","description":"Log operations"},{"name":"snapshot","description":"Snapshot operations"},{"name":"orgConfig","x-displayName":"Org Config","description":"Org Config operations"},{"name":"siteConfig","x-displayName":"Site Config","description":"Please note that most of the configuration objects that have an explicit schema can also be addressed directly, even if not listed in this documentation. <br> For example the production CDN configuration can be managed via the <code>/config/{org}/sites/{site}/cdn/prod.json</code> endpoint.\n"},{"name":"profileConfig","x-displayName":"Profile Config","description":"Please note that most of the configuration objects that have an explicit schema can also be addressed directly, even if not listed in this documentation. <br> For example the production CDN configuration can be managed via the <code>/config/{org}/profiles/default-profile/cdn/prod.json</code> endpoint.\n"},{"name":"indexConfig","x-displayName":"Index Config","description":"A configuration containing one or more index definitions.\n"},{"name":"sitemapConfig","x-displayName":"Sitemap Config","description":"A configuration containing one or more sitemap definitions.\n"}],"paths":{"/status/{owner}/{repo}/{ref}/{path}":{"get":{"operationId":"status","tags":["status"],"summary":"General status","description":"Returns the overall status of the respective resource. (If the `?edit=auto` query param is set, this requires a call to your content source see https://www.aem.live/docs/limits#rate-limits-number-of-preview-operations-per-time)","security":[{},{"AuthCookie":["preview:read","live:read","code:read","edit:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/statusEditUrlParam"}],"responses":{"200":{"description":"The overall status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/previewInfo"},{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/editInfo"},{"$ref":"#/components/schemas/codeInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"},{"$ref":"#/components/schemas/profileInfo"}]},"examples":{"success":{"description":"Success response of a preview document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","lastModifiedBy":"foo@adobe.com","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","lastModifiedBy":"anonymous","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"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}}}},"/status/{owner}/{repo}/{ref}/*":{"post":{"operationId":"bulkStatus","tags":["status"],"summary":"Start a bulk status job","description":"Fetches the status of all resources specified in the `paths` property in the payload. If a path ends with `/*`, it is assumed to be a folder and is recursively processed.<br><br> The response will contain the folliowing information about a resource: `path`, `sourceLastModified`, `previewLastModified` and `publishLastModified`. It is possible to filter the information returned, by passing a combination of `edit`, `preview` and `live` in the `select` property in the payload.<br><br> Note that the bulk status is performed asynchronously and the response will contain information about the created [job](#tag/job).\n","security":[{},{"AuthCookie":["edit:list","preview:list","live:list"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkStatusBody"},"examples":{"multiple-paths":{"$ref":"#/components/examples/example"}}}}},"responses":{"202":{"description":"Bulk status scheduled.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobCreated"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"status":202,"messageId":"37e92eec-020c-4eae-8f80-3db444c25056","job":{"topic":"status","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","data":{"paths":[{"prefix":"/en/"},{"path":"/en"},{"path":"/blog/"}]}},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/status/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/status"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}}}},"/live/{owner}/{repo}/{ref}/{path}":{"get":{"operationId":"getPublishStatus","tags":["publish"],"summary":"Publish Status","description":"Returns the publish status of the respective resource.","security":[{"AuthCookie":["live:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"The publish status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of a published document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}},"post":{"operationId":"publishResource","tags":["publish"],"summary":"Publish a resource","description":"Publish a resource by copying the resource content from the `preview` content-bus partition to the `live` content-bus partition. It additionally purges the _live_ cdn and the _byo_ cdn, if configured.\n","security":[{"AuthCookie":["preview:read","live:read","live:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/forceUpdateRedirectsParam"},{"$ref":"#/components/parameters/disableNotificationsParam"}],"responses":{"200":{"description":"Resource published.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of the published document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read","write"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"unpublishResource","tags":["publish"],"summary":"Un-publish a resource","description":"Un-publish a resource by deleting the content from from the `live` content-bus partition. It additionally purges the _live_ cdn and the _byo_ cdn, if configured.\n","security":[{"AuthCookie":["live:read","live:delete"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/disableNotificationsParam"}],"responses":{"204":{"description":"Resource unpublished"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/live/{owner}/{repo}/{ref}/*":{"post":{"operationId":"bulkPublish","tags":["publish"],"summary":"Start a bulk publish job","description":"Updates live resources specified in the `paths` property in the payload.<br> By default, only new and modified resources are updated, unless the `forceUpdate` property is set to `true`.<br> Note that configuration files, like `/.helix/config` or `redirects.json`, are always ignored during bulk publish.<br> Note that the bulk publish is performed asynchronously and this request will return information to the created job.\n","security":[{"AuthCookie":["preview:list","preview:read","preview:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkPublishBody"},"examples":{"multiple-paths":{"$ref":"#/components/examples/bulk-publish-payload_example"}}}}},"responses":{"202":{"description":"Bulk publish scheduled.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobCreated"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"status":202,"messageId":"37e92eec-020c-4eae-8f80-3db444c25056","job":{"topic":"publish","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","data":{"paths":[{"path":"/en"},{"path":"/blog/"},{"path":"/metadata.json"}]}},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/publish/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/publish"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/preview/{owner}/{repo}/{ref}/{path}":{"get":{"operationId":"previewStatus","tags":["preview"],"summary":"Preview status","description":"Returns the preview status of the respective resource.","security":[{"AuthCookie":["preview:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"The preview status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/previewInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of a preview document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","preview":{"status":200,"url":"https://main--repo--owner.hlx.page/en/2021/blog","lastModified":"2021-05-31T23:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/preview/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}},"post":{"operationId":"updatePreview","tags":["preview"],"summary":"Update preview","description":"Updates the preview resource by fetching the latest content from the content providers (e.g. sharepoint, google docs, BYOM) and storing it in `preview`.\n","security":[{"AuthCookie":["edit:read","preview:read","preview:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/forceUpdateRedirectsParam"},{"$ref":"#/components/parameters/word2mdVersionParam"},{"$ref":"#/components/parameters/gdocs2mdVersionParam"},{"$ref":"#/components/parameters/html2mdVersionParam"}],"responses":{"200":{"description":"Preview resource updated.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/previewInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","preview":{"status":200,"url":"https://main--repo--owner.hlx.page/en/2021/blog","lastModified":"2021-05-31T23:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/preview/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read","write"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}}},"delete":{"operationId":"deletePreview","tags":["preview"],"summary":"Delete preview","description":"Deletes a preview resource from the `preview` partition in the content-bus..\n","security":[{"AuthCookie":["preview:read","preview:delete"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/preview/{owner}/{repo}/{ref}/*":{"post":{"operationId":"bulkPreview","tags":["preview"],"summary":"Start a bulk preview job","description":"Updates preview resources specified in the `paths` property in the payload. If a path ends with `/*`, it is assume to be folder and is recursively previewed.<br> By default, only new and modified resources are updated, unless the `forceUpdate` property is set to `true`.<br> Note that configuration files, like `/.helix/config` or `redirects.json`, are always ignored during bulk preview.<br> Note that the bulk preview is performed asynchronously and this request will return information to the created job.\n","security":[{"AuthCookie":["edit:read","edit:list","preview:read","preview:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/word2mdVersionParam"},{"$ref":"#/components/parameters/gdocs2mdVersionParam"},{"$ref":"#/components/parameters/html2mdVersionParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkPreviewBody"},"examples":{"multiple-paths":{"$ref":"#/components/examples/bulk-preview-payload_example"}}}}},"responses":{"202":{"description":"Bulk preview scheduled.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobCreated"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"status":202,"messageId":"37e92eec-020c-4eae-8f80-3db444c25056","job":{"topic":"preview","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","data":{"paths":["/documents"]}},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/preview"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"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"},"429":{"$ref":"#/components/responses/429"},"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"},"429":{"$ref":"#/components/responses/429"},"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"},"429":{"$ref":"#/components/responses/429"},"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"},"429":{"$ref":"#/components/responses/429"},"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.\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"},"429":{"$ref":"#/components/responses/429"},"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"}}},"429":{"$ref":"#/components/responses/429"},"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"}}},"429":{"$ref":"#/components/responses/429"},"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"}}},"429":{"$ref":"#/components/responses/429"},"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"}}}}}}},"429":{"$ref":"#/components/responses/429"}}}},"/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"}}},"429":{"$ref":"#/components/responses/429"}}}},"/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"}}},"429":{"$ref":"#/components/responses/429"}}}},"/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"}}}}}}},"429":{"$ref":"#/components/responses/429"}}}},"/sitemap/{owner}/{repo}/{ref}/{path}":{"post":{"operationId":"generateSitemap","tags":["sitemap"],"summary":"Generates a sitemap","description":"Generates a sitemap. The path specified should be the destination path of a sitemap.\n","security":[{}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"Sitemap generated.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/sitemapInfo"}]},"examples":{"success":{"description":"Success response of generating a sitemap","value":{"paths":["/sitemap.xml"]}}}}}},"204":{"description":"Path specified is no destination for any sitemap configured"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"description":"No sitemap configuration found","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/job/{owner}/{repo}/{ref}/{topic}":{"get":{"operationId":"getJobList","tags":["job"],"summary":"Job List","description":"Returns the job list of jobs","security":[{"AuthCookie":["job:list"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/topicParam"}],"responses":{"200":{"description":"The Job List","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobList"},{"$ref":"#/components/schemas/jobListLink"}]},"examples":{"success":{"description":"Success response of a job list.","value":{"topic":"preview","jobs":[{"name":"job-123","state":"created","time":"2021-05-31T23:00:00Z","href":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123"},{"name":"job-124","state":"running","time":"2021-04-31T23:00:00Z","href":"https://admin.hlx.page/job/adobe/blog/main/preview/job-124"}],"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}}},"/job/{owner}/{repo}/{ref}/{topic}/{jobName}":{"get":{"operationId":"getJob","tags":["job"],"summary":"Job Status","description":"Returns the job status","security":[{"AuthCookie":["job:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/topicParam"},{"$ref":"#/components/parameters/jobNameParam"}],"responses":{"202":{"description":"The Job Status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobStatus"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"topic":"preview","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","progress":{"total":10,"processed":0,"failed":0},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123","details":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123/details","list":"https://admin.hlx.page/job/adobe/blog/main/preview"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}},"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"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/job/{owner}/{repo}/{ref}/{topic}/{jobName}/details":{"get":{"operationId":"getJobDetails","tags":["job"],"summary":"Job Status Details","description":"Returns the job status","security":[{"AuthCookie":["job:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/topicParam"},{"$ref":"#/components/parameters/jobNameParam"}],"responses":{"202":{"description":"The Job Status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobStatusDetails"},{"$ref":"#/components/schemas/jobLinksInfoDetails"}]},"examples":{"success":{"description":"Success response.","value":{"topic":"preview","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","progress":{"total":10,"processed":6,"failed":4},"data":{"paths":["/documents"]},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123/details","job":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/preview"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}}},"/log/{owner}/{repo}/{ref}":{"get":{"operationId":"getLogs","tags":["log"],"summary":"Returns logs","description":"Returns logs for a project. If there are more logs for the timespan specified, there will be a `next` link in the response to load the next batch.\n","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/sinceParam"},{"$ref":"#/components/parameters/nextTokenParam"}],"responses":{"200":{"description":"Log statements","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logResult"},"examples":{"success":{"description":"Success response of a log request.","value":{"from":"2023-11-07T14:00:00.000Z","to":"2023-11-07T16:15:12.454Z","entries":[{"timestamp":1699368094644,"duration":467,"status":201,"method":"POST,","route":"preview","path":"/my-page","contentBusId":"xyz","owner":"owner","repo":"repo","ref":"ref"},{"timestamp":1699368094645,"duration":1005,"status":202,"method":"POST","route":"live","snapshotId":"default","user":"foo@example.com","paths":["/","/docs/howto/","/docs/howto/one","/docs/howto/two"],"contentBusId":"abc","owner":"owner","repo":"repo","ref":"ref"},{"timestamp":1699372505155,"event":"dinner is ready","contentBusId":"xyz","owner":"owner","repo":"repo","ref":"ref"}],"nextToken":"ABAB==","links":{"next":"https://admin.hlx.page/log/owner/repo/ref/?nextToken=ABAB=="}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}},"post":{"operationId":"addLogs","tags":["log"],"summary":"Add logs","description":"Add logs to a project. The body should be in JSON format and contain an array called `entries`.\n","security":[{"AuthCookie":["log:read","log:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logEntriesBody"},"examples":{"multiple-entries":{"description":"This posts one entry to the audit log. To see what the added entry would look like, see the second entry in the [getLog](#tag/log/operation/getLogs) example.\n","value":{"entries":[{"event":"dinner is ready"}]}}}}}},"responses":{"201":{"description":"Logs added."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/snapshot/{owner}/{repo}/main":{"get":{"operationId":"listSnapshots","tags":["snapshot"],"summary":"List snapshots","description":"Returns a list of snapshot IDs","security":[{"AuthCookie":["snapshot:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"}],"responses":{"200":{"description":"The snapshot list","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snapshotList"},{"$ref":"#/components/schemas/snapshotLinksList"}]},"examples":{"success":{"description":"Success response of list snapshots.","value":{"snapshots":["default","backup","for-next-big-release"],"links":{"self":"https://admin.hlx.page/snapshot/adobe/blog/main"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/snapshot/{owner}/{repo}/main/{snapshotId}":{"get":{"operationId":"getSnapshotManifest","tags":["snapshot"],"summary":"Snapshot Manifest","description":"Returns the snapshot manifest","security":[{"AuthCookie":["snapshot:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"}],"responses":{"200":{"description":"The snapshot manifest","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snapshotManifest"},{"$ref":"#/components/schemas/snapshotLinksInfo"}]},"examples":{"success":{"description":"Success response of a snapshot manifest.","value":{"manifest":{"id":"12345","title":"Test Review","description":"ignore this review","created":"2021-04-31T23:00:00Z","lastModified":"2021-05-31T23:00:00Z","lastUpdated":"2021-05-31T23:00:00Z","resources":[{"path":"/foo"},{"path":"/bar"}]},"links":{"snapshot":"https://admin.hlx.page/snapshot/adobe/blog/main/12345"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}},"post":{"operationId":"updateSnapshotManifest","tags":["snapshot"],"summary":"Update snapshot Manifest","description":"Updates the Snapshot manifest and allows to lock or unlock the snapshot. Note that in order to lock the snapshot, the request role also needs to include the `preview:write` permission, and in order to unlock the snapshot, the `live:write` permission is needed.\n","security":[{"AuthCookie":["snapshot:write","preview:write","live:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"locked":{"type":"boolean"},"title":{"type":"string"},"description":{"type":"string"},"metadata":{"type":"object","additionalProperties":true}}}}}},"responses":{"200":{"description":"The snapshot manifest","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snapshotManifest"},{"$ref":"#/components/schemas/snapshotLinksInfo"}]},"examples":{"success":{"description":"Success response of a snapshot manifest.","value":{"manifest":{"title":"December release","id":"12345","created":"2021-04-31T23:00:00Z","lastModified":"2021-05-31T23:00:00Z","lastUpdated":"2021-05-31T23:00:00Z","resources":[{"path":"/foo"},{"path":"/bar"}]},"links":{"snapshot":"https://admin.hlx.page/snapshot/adobe/blog/main/12345"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}}},"/snapshot/{owner}/{repo}/main/{snapshotId}/{path}":{"get":{"operationId":"getSnapshot","tags":["snapshot"],"summary":"Snapshot status","description":"Returns the snapshot status of the respective resource.","security":[{"AuthCookie":["snapshot:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"The snapshot status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/previewInfo"},{"$ref":"#/components/schemas/snapshotInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of a snapshot document.","value":{"webPath":"/.snapshot/12345/en/2021/blog","resourcePath":"/.snapshot/12345/en/2021/blog.md","preview":{"status":200,"url":"https://main--repo--owner.hlx.page/.snapshot/12345/en/2021/blog","lastModified":"2021-05-31T23:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/.snapshot/12345/preview/en/2021/blog.md","permissions":["read","write"]},"snapshot":{"id":"12345","locked":"2021-05-31T23:00:00Z"},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}},"post":{"operationId":"createSnapshot","tags":["snapshot"],"summary":"Add resource to snapshot","description":"Creates a snapshot of the specified resource and stores it in the preview partition below the `.snapshot/snapshotId` folder. If the path param ends with a `*`, a snapshot of the entire subtree is created. If the snapshot is locked, a `409` response is returned.\n","security":[{"AuthCookie":["snapshot:read","snapshot:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/snFilterParam"}],"responses":{"200":{"description":"Successful snapshot response"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteSnapshot","tags":["snapshot"],"summary":"Delete snapshot","description":"Deletes a snapshot resource from the `preview` partition in the content-bus.  If the path param ends with a `*`, the entire subtree is deleted. If the snapshot is locked, a `409` response is returned.\n","security":[{"AuthCookie":["snapshot:read","snapshot:delete"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}},"/snapshot/{owner}/{repo}/main/{snapshotId}/*":{"post":{"operationId":"bulkSnapshot","tags":["snapshot"],"summary":"Start a bulk snapshot job","description":"Add all resources specified in the `paths` property in the payload.<br> By default, only new and modified resources are updated, unless the `forceUpdate` property is set to `true`.<br> Note that the bulk snapshot is performed synchronously for arrays with fewer than 200 resources and no wildcard paths, and asynchronously otherwise.<br> Note that without the appropriate `application/json` content type header, the request will be treated as a wildcard add with no body, resulting in all resources being added to the snapshot.\n","security":[{"AuthCookie":["snapshot:read","snapshot:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSnapshotBody"},"examples":{"multiple-paths":{"$ref":"#/components/examples/multiple-paths"},"wildcard":{"$ref":"#/components/examples/wildcard"}}}}},"responses":{"202":{"description":"Bulk snapshot.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobCreated"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"sync-success":{"description":"Successful job completed synchronously response.","value":{"status":202,"messageId":"37e92eec-020c-4eae-8f80-3db444c25056","job":{"topic":"snapshot","name":"job-123","state":"stopped","startTime":"2021-05-31T23:00:00Z","data":{"snapshotId":"snapshot-123","forceUpdate":false,"phase":"completed","paths":[{"path":"/en"},{"path":"/blog/"}],"resources":[{"resourcePath":"/en.md","webPath":"/en","status":200},{"resourcePath":"/blog/index.md","webPath":"/blog/","status":200}]}},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/snapshot/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/snapshot"}}},"async-success":{"description":"Successful asynchronous job created response.","value":{"status":202,"messageId":"37e92eec-020c-4eae-8f80-3db444c25056","job":{"topic":"publish","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","data":{"snapshotId":"snapshot-123","forceUpdate":false,"paths":[{"path":"/en/*"}]}},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/snapshot/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/snapshot"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/snapshot/{owner}/{repo}/main/{snapshotId}/{path}?publish=true":{"post":{"operationId":"publishSnapshotResource","tags":["snapshot"],"summary":"Publish snapshot resource","description":"Publish snapshot resources by copying the resource content from the snapshot location to the `live` content-bus partition. It additionally purges the _live_ cdn and the _byo_ cdn, if configured. If the path param ends with a `*` the resources of the path's entire subtree is published.\n","security":[{"AuthCookie":["snapshot:read","live:read","live:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/snPublishParam"}],"responses":{"200":{"description":"Resources published.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of the published document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read","write"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"202":{"description":"Snapshot publish job started","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snapshotJob"},{"$ref":"#/components/schemas/snapshotLinksPublishJob"}]},"examples":{"success":{"description":"Response of the created publish job.","value":{"job":{"topic":"publish","name":"job-2024-01-16t22-39-20-813z","state":"stopped","createTime":"2024-01-16T22:39:20.813Z","startTime":"2024-01-16T22:39:21.971Z","stopTime":"2024-01-16T22:39:24.693Z","invocationId":"96669ae6-cf90-530a-ac36-c4c7c85d27c8","data":{"paths":["/foo"],"snapshotId":"name","phase":"completed","resources":[{"path":"/foo","lastModified":"2024-01-16T22:39:24.693Z","status":200}]},"progress":{"total":1,"processed":1,"failed":0}},"links":{"list":"https://admin.hlx.page/job/owner/repo/main/publish","self":"https://admin.hlx.page/job/owner/repo/main/publish/job-2024-01-16t22-39-20-813z"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/snapshot/{owner}/{repo}/main/{snapshotId}?publish=true":{"post":{"operationId":"publishSnapshot","tags":["snapshot"],"summary":"Publish snapshot","description":"Publish a snapshot by copying all resources from the snapshot location to the `live` content-bus partition. It additionally purges the _live_ cdn and the _byo_ cdn, if configured.\n","security":[{"AuthCookie":["snapshot:read","live:read","live:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/snPublishParam"}],"responses":{"200":{"description":"Snapshot published.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of the published document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read","write"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"202":{"description":"Snapshot publish job started","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snapshotJob"},{"$ref":"#/components/schemas/snapshotLinksPublishJob"}]},"examples":{"success":{"description":"Response of the created publish job.","value":{"job":{"topic":"publish","name":"job-2024-01-16t22-39-20-813z","state":"stopped","createTime":"2024-01-16T22:39:20.813Z","startTime":"2024-01-16T22:39:21.971Z","stopTime":"2024-01-16T22:39:24.693Z","invocationId":"96669ae6-cf90-530a-ac36-c4c7c85d27c8","data":{"paths":["/foo"],"snapshotId":"name","phase":"completed","resources":[{"path":"/foo","lastModified":"2024-01-16T22:39:24.693Z","status":200}]},"progress":{"total":1,"processed":1,"failed":0}},"links":{"list":"https://admin.hlx.page/job/owner/repo/main/publish","self":"https://admin.hlx.page/job/owner/repo/main/publish/job-2024-01-16t22-39-20-813z"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/snapshot/{owner}/{repo}/main/{snapshotId}?review=[request,approve,reject]":{"post":{"operationId":"reviewSnapshot","tags":["snapshot"],"summary":"Change snapshot review state","description":"Performs a review operation on the snapshot. `request` locks the snapshot; `approve` publishes all resources, clears, and unlocks the snapshot; `reject` unlocks the snapshot. All operations can contain an optional `message` parameter which will be included in logs and events.\n","security":[{"AuthCookie":["snapshot:read","live:read","live:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/snReviewParam"},{"$ref":"#/components/parameters/snReviewMessageParam"}],"responses":{"204":{"description":"Snapshot review operation performed."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}.json":{"get":{"operationId":"getConfigOrg","tags":["orgConfig"],"summary":"Read Organisation Config","description":"Returns the organisation level configuration.","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/org"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigOrg","tags":["orgConfig"],"summary":"Update Organisation Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/org"}}}},"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"put":{"operationId":"createConfigOrg","tags":["orgConfig"],"summary":"Create Organisation Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/org"}}}},"responses":{"201":{"description":"Resource created."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteConfigOrg","tags":["orgConfig"],"summary":"Delete Organisation Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/users.json":{"get":{"operationId":"listOrgUsers","tags":["orgConfig"],"summary":"List Users","description":"Returns the org users","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/users"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateOrgUser","tags":["orgConfig"],"summary":"Create new org user","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/orgConfigUser"},{"$ref":"#/components/schemas/orgConfigUsers"}]}}}},"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/user"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}},"/config/{org}/users/${id}.json":{"get":{"operationId":"readOrgUser","tags":["orgConfig"],"summary":"Read user","description":"Returns the user","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/userIdParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/user"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"delete":{"operationId":"deleteOrgUser","tags":["orgConfig"],"summary":"Delete user","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/userIdParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/sites.json":{"get":{"operationId":"getConfigSites","tags":["siteConfig"],"summary":"List Site Config","description":"Returns the site level configuration names.","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"responses":{"200":{"description":"SiteConfigList (Schema)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sites"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}},"/config/{org}/sites/{site}.json":{"get":{"operationId":"getConfigSite","tags":["siteConfig"],"summary":"Read Site Config","description":"Returns the site level configuration. If `migrate` is set to `true`, the configuration will be aggregated based on the legacy config (fstab, .helix/config.xlsx, etc).\n","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"},{"$ref":"#/components/parameters/migrateParam"},{"$ref":"#/components/parameters/validateParam"}],"responses":{"200":{"description":"SiteConfig (Schema)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/site"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigSite","tags":["siteConfig"],"summary":"Update Site Config.","description":"Stores new site configuration. If `migrate` is set to `true`, the configuration will be aggregated based on the legacy config (fstab, .helix/config.xlsx, etc) and will overwrite the existing configuration.","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"},{"$ref":"#/components/parameters/migrateParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/site"}}}},"responses":{"200":{"description":"SiteConfig (Schema)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/site"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"put":{"operationId":"createSiteSite","tags":["siteConfig"],"summary":"Create Site Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/site"}}}},"responses":{"200":{"description":"SiteConfig (Schema)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/site"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"delete":{"operationId":"deleteConfigSite","tags":["siteConfig"],"summary":"Delete Site Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/sites/{site}/robots.txt":{"get":{"operationId":"getConfigSiteRobots","tags":["siteConfig"],"summary":"Read Site robots.txt Config","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"200":{"description":"robots.txt","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigSiteRobots","tags":["siteConfig"],"summary":"Update Site robots.txt Config.","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"requestBody":{"content":{"text/plain":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"robots.txt","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}},"/config/{org}/sites/{site}/tokens.json":{"get":{"operationId":"listSiteTokens","tags":["siteConfig"],"summary":"List access tokens","description":"Returns the access tokens","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tokens"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateSiteToken","tags":["siteConfig"],"summary":"Create new access token","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"[a-zA-Z0-9-_=]+"},"value":{"type":"string","pattern":"[a-zA-Z0-9-_=]+"},"created":{"type":"string","format":"date-time"}}}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}},"/config/{org}/sites/{site}/tokens/${id}.json":{"get":{"operationId":"readSiteToken","tags":["siteConfig"],"summary":"Read access token","description":"Returns the access token","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"},{"$ref":"#/components/parameters/tokenIdParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tokens"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"delete":{"operationId":"deleteSiteToken","tags":["siteConfig"],"summary":"Delete access token","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"},{"$ref":"#/components/parameters/tokenIdParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/aggregated/{site}.json":{"get":{"operationId":"getAggregatedConfigSite","tags":["siteConfig"],"summary":"Read Aggregated Site Config","description":"Returns the aggregated site level configuration. This includes the inherited values from the profile.\n","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"200":{"description":"SiteConfig (Schema)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/site"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}},"/config/{org}/profiles.json":{"get":{"operationId":"getConfigProfiles","tags":["profileConfig"],"summary":"List Profile Config","description":"Returns the configuration profile names.","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"responses":{"200":{"description":"ConfigProfileList (Schema)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/profiles"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}},"/config/{org}/profiles/{profile}.json":{"get":{"operationId":"getConfigProfile","tags":["profileConfig"],"summary":"Read Profile Config","description":"Returns the Profile level configuration.","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"responses":{"200":{"description":"profile config","content":{"application/json":{"schema":{"$ref":"#/components/schemas/profile"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigProfile","tags":["profileConfig"],"summary":"Update Profile Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/profile"}}}},"responses":{"200":{"description":"profile config","content":{"application/json":{"schema":{"$ref":"#/components/schemas/profile"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"put":{"operationId":"createConfigProfile","tags":["profileConfig"],"summary":"Create Profile Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/profile"}}}},"responses":{"201":{"description":"Resource created."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteConfigProfile","tags":["profileConfig"],"summary":"Delete Profile Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/profiles/{profile}/robots.txt":{"get":{"operationId":"getConfigProfileRobots","tags":["profileConfig"],"summary":"Read Profile robots.txt Config","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"responses":{"200":{"description":"robots.txt","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigProfileRobots","tags":["profileConfig"],"summary":"Update Profile robots.txt Config.","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"requestBody":{"content":{"text/plain":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"robots.txt","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}},"/config/{org}/profiles/{profile}/tokens.json":{"get":{"operationId":"listProfileTokens","tags":["profileConfig"],"summary":"List access tokens","description":"Returns the access tokens","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tokens"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateProfileToken","tags":["profileConfig"],"summary":"Create new access token","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"[a-zA-Z0-9-_=]+"},"value":{"type":"string","pattern":"[a-zA-Z0-9-_=]+"},"created":{"type":"string","format":"date-time"}}}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}},"/config/{org}/profiles/{profile}/tokens/${id}.json":{"get":{"operationId":"readProfileToken","tags":["profileConfig"],"summary":"Read access token","description":"Returns the access token","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"},{"$ref":"#/components/parameters/tokenIdParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tokens"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"delete":{"operationId":"deleteProfileToken","tags":["profileConfig"],"summary":"Delete access token","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"},{"$ref":"#/components/parameters/tokenIdParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/sites/{site}/content/query.yaml":{"get":{"operationId":"getIndexConfig","tags":["indexConfig"],"summary":"Read Index Configuration","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"200":{"description":"index configuration","content":{"text/yaml":{"schema":{"$ref":"#/components/schemas/indexconfig"},"examples":{"success":{"description":"Success response of reading an index configuration","value":"version: 1\nindices:\n  default:\n    include:\n      - '/**'\n    target: /query-index.json\n    properties:\n      lastModified:\n        select: none\n        value: parseTimestamp(headers[\"last-modified\"], \"ddd, DD MMM YYYY hh:mm:ss GMT\")\n"}}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateIndexConfig","tags":["indexConfig"],"summary":"Update Index Configuration","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"requestBody":{"content":{"text/yaml":{"schema":{"$ref":"#/components/schemas/indexconfig"}}},"required":true},"responses":{"204":{"description":"Index configuration updated"}}},"put":{"operationId":"createIndexConfig","tags":["indexConfig"],"summary":"Create Index Configuration","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"requestBody":{"content":{"text/yaml":{"schema":{"$ref":"#/components/schemas/indexconfig"}}},"required":true},"responses":{"201":{"description":"Index configuration created."},"409":{"description":"Site already has an index configuration, update it instead."}}},"delete":{"operationId":"deleteIndexConfig","tags":["indexConfig"],"summary":"Delete Index Configuration","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"204":{"description":"Index configuration deleted."}}}},"/config/{org}/sites/{site}/content/sitemap.yaml":{"get":{"operationId":"getSitemapConfig","tags":["sitemapConfig"],"summary":"Read Sitemap Configuration","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"200":{"description":"sitemap configuration","content":{"text/yaml":{"schema":{"$ref":"#/components/schemas/sitemapconfig"},"examples":{"success":{"description":"Success response of reading a sitemap configuration","value":"version: 1\nsitemaps:\n  default:\n    source: /sitemap-index.json\n    destination: /sitemap.xml\n    lastmod: YYYY-MM-DD\n"}}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateSitemapConfig","tags":["sitemapConfig"],"summary":"Update Sitemap Configuration","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"requestBody":{"content":{"text/yaml":{"schema":{"$ref":"#/components/schemas/sitemapconfig"}}},"required":true},"responses":{"204":{"description":"Sitemap configuration updated."}}},"put":{"operationId":"createSitemapConfig","tags":["sitemapConfig"],"summary":"Create Sitemap Configuration","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"requestBody":{"content":{"text/yaml":{"schema":{"$ref":"#/components/schemas/sitemapconfig"}}},"required":true},"responses":{"201":{"description":"Sitemap configuration created."},"409":{"description":"Site already has a sitemap configuration, update it instead."}}},"delete":{"operationId":"deleteSitemapConfig","tags":["sitemapConfig"],"summary":"Delete Sitemap Configuration","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"204":{"description":"Sitemap configuration deleted."}}}}},"components":{"securitySchemes":{"AuthCookie":{"type":"apiKey","in":"cookie","name":"auth_token"},"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SiteConfig":{"x-tags":["siteConfig"],"$ref":"#/components/schemas/site"},"SiteConfigList":{"x-tags":["siteConfig"],"$ref":"#/components/schemas/sites"},"OrgConfig":{"x-tags":["orgConfig"],"$ref":"#/components/schemas/org"},"ProfileConfig":{"x-tags":["profileConfig"],"$ref":"#/components/schemas/profile"},"ProfileConfigList":{"x-tags":["profileConfig"],"$ref":"#/components/schemas/profiles"},"AdminAccessConfig":{"$ref":"#/components/schemas/access-admin","x-tags":["siteConfig","profileConfig"]},"SiteAccessConfig":{"$ref":"#/components/schemas/access-site","x-tags":["siteConfig","profileConfig"]},"AccessConfig":{"$ref":"#/components/schemas/access","x-tags":["siteConfig","profileConfig"]},"CDNConfig":{"$ref":"#/components/schemas/cdn","x-tags":["siteConfig","profileConfig"]},"CodeConfig":{"$ref":"#/components/schemas/code","x-tags":["siteConfig","profileConfig"]},"ContentConfig":{"$ref":"#/components/schemas/content","x-tags":["siteConfig","profileConfig"]},"FoldersConfig":{"$ref":"#/components/schemas/folders","x-tags":["siteConfig","profileConfig"]},"HeadersConfig":{"$ref":"#/components/schemas/headers","x-tags":["siteConfig","profileConfig"]},"MetadataConfig":{"$ref":"#/components/schemas/metadata-source","x-tags":["siteConfig","profileConfig"]},"PublicConfig":{"$ref":"#/components/schemas/public","x-tags":["siteConfig","profileConfig"]},"GroupsConfig":{"$ref":"#/components/schemas/groups","x-tags":["siteConfig","orgConfig"]},"RobotsConfig":{"$ref":"#/components/schemas/robots","x-tags":["siteConfig","profileConfig"]},"SidekickConfig":{"$ref":"#/components/schemas/sidekick","x-tags":["siteConfig","profileConfig"]},"TokensConfig":{"$ref":"#/components/schemas/tokens","x-tags":["siteConfig","profileConfig"]},"IndexConfig":{"$ref":"#/components/schemas/indexconfig","x-tags":["indexConfig"]},"SitemapConfig":{"$ref":"#/components/schemas/sitemapconfig","x-tags":["sitemapConfig"]},"resourceInfo":{"required":["webPath","resourcePath"],"properties":{"webPath":{"description":"Relative path used on the websites.","type":"string"},"resourcePath":{"description":"Relative path of the content resource","type":"string"}}},"permissions":{"description":"Access permissions","required":["permissions"],"properties":{"permissions":{"type":"array","items":{"type":"string","enum":["read","write","delete"]}}}},"contentBusResource":{"required":["contentBusId"],"properties":{"contentBusId":{"description":"Full content-bus id.","type":"string"},"lastModified":{"description":"Last modification date. undefined when resource is missing.","type":"string","format":"date-time"},"contentType":{"description":"The resource content type. undefined when resource is missing.","type":"string"},"contentLength":{"description":"Size of the content in bytes. undefined when resource is missing.","type":"integer"},"redirectLocation":{"description":"Location for redirects as defined on the resource","type":"string","format":"url"},"configRedirectLocation":{"description":"Location for redirects as defined in the config (redirects.json)","type":"string","format":"url"},"sourceLocation":{"description":"Content provider specific id of the source.","type":"string","format":"url"},"sourceLastModified":{"description":"Last modification date of the source document.","type":"string","format":"date-time"}}},"liveInfo":{"required":["live"],"properties":{"live":{"description":"Information about the published resource.","allOf":[{"required":["url","status"]},{"properties":{"status":{"description":"HTTP status of response when fetching thre information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"},"url":{"description":"Live URL of the resource.","type":"string","format":"url"}}},{"$ref":"#/components/schemas/permissions"},{"$ref":"#/components/schemas/contentBusResource"}]}}},"previewInfo":{"required":["preview"],"properties":{"preview":{"description":"Information about the preview resource.","allOf":[{"required":["url","status"]},{"properties":{"status":{"description":"HTTP status of response when fetching the information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"},"url":{"description":"Preview URL of the resource.","type":"string","format":"url"}}},{"$ref":"#/components/schemas/permissions"},{"$ref":"#/components/schemas/contentBusResource"}]}}},"folderInfo":{"required":["name","path","url"],"properties":{"name":{"description":"Name of folder","type":"string"},"path":{"description":"Path of folder, relative to the mount root","type":"string"},"url":{"description":"URL of folder","type":"string","format":"url"}}},"editResource":{"description":"Edit information for a resource","properties":{"url":{"description":"URL of edit document.","type":"string","format":"url"},"sourceLocation":{"description":"Content provider specific id of the source","type":"string","format":"url"},"lastModified":{"description":"Last modification date of the source document.","type":"string","format":"date-time"},"name":{"description":"Name of the edit document","type":"string"},"contentType":{"description":"Content type of the edit document","type":"string"},"folders":{"description":"Information of parent folders of the edit document.","type":"array","items":{"$ref":"#/components/schemas/folderInfo"}}}},"editInfo":{"required":["edit"],"properties":{"edit":{"description":"Edit information for a resource","type":"object","allOf":[{"required":["url","status"]},{"properties":{"status":{"description":"HTTP status of response when fetching thre information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"}}},{"$ref":"#/components/schemas/editResource"}]}}},"codeBusResource":{"required":["codeBusId"],"properties":{"codeBusId":{"description":"Full code-bus id.","type":"string"},"lastModified":{"description":"Last modification date. undefined when resource is missing.","type":"string","format":"date-time"},"contentType":{"description":"The resource content type. undefined when resource is missing.","type":"string"},"contentLength":{"description":"Size of the content in bytes. undefined when resource is missing.","type":"integer"},"sourceLocation":{"description":"Content provider specific id of the source","type":"string","format":"url"},"sourceLastModified":{"description":"Last modification date of the source document.","type":"string","format":"date-time"}}},"codeInfo":{"required":["code"],"properties":{"code":{"description":"Information about a code bus resource","type":"object","allOf":[{"required":["status"]},{"properties":{"status":{"description":"HTTP status of response when fetching thre information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"}}},{"$ref":"#/components/schemas/codeBusResource"},{"$ref":"#/components/schemas/permissions"}]}}},"resourceLinksInfo":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"status":{"description":"link of the status api","example":"https://admin.hlx.page/status/owner/repo/ref","type":"string","format":"url"},"live":{"description":"link of the live api","example":"https://admin.hlx.page/live/owner/repo/ref","type":"string","format":"url"},"preview":{"description":"link of the preview api","example":"https://admin.hlx.page/preview/owner/repo/ref","type":"string","format":"url"},"code":{"description":"link of the code api","example":"https://admin.hlx.page/code/owner/repo/ref","type":"string","format":"url"}}}}},"profileInfo":{"properties":{"profile":{"description":"Profile data","additionalProperties":true,"properties":{"iss":{"description":"id token issuer","type":"string"},"email":{"description":"email of logged in user","type":"string"},"name":{"description":"name of logged in user","type":"string"},"ttl":{"description":"time to live of current id token","type":"number"}}}}},"bulkStatusBody":{"description":"bulk status body","required":["paths"],"properties":{"paths":{"description":"paths to filter the bulk status","type":"array","items":{"type":"string"}},"select":{"description":"a combination of `edit`, `preview` and `live`. The default is `['preview','live']`.","type":"array","items":{"type":"string","enum":["edit","preview","live"]}},"pathsOnly":{"description":"only return paths","type":"boolean","default":false}}},"jobStatus":{"required":["topic","name","state","startTime"],"properties":{"topic":{"description":"Job Topic","type":"string"},"name":{"description":"Job Name","type":"string"},"state":{"description":"Job State","type":"string"},"startTime":{"description":"Job start time","type":"string","format":"date-time"},"endTime":{"description":"Job end time","type":"string","format":"date-time"},"cancelled":{"description":"Flag indicating if job was cancelled","type":"boolean"},"data":{"description":"Custom job data","type":"object"},"progress":{"description":"job progress","type":"object"}}},"jobCreated":{"required":["messageId","job"],"properties":{"messageId":{"description":"Internal message id","type":"string"},"job":{"description":"Job state","type":"object","$ref":"#/components/schemas/jobStatus"}}},"jobLinksInfo":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"self":{"description":"link of the job api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13","type":"string","format":"url"},"details":{"description":"link of the job details api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13/details","type":"string","format":"url"},"list":{"description":"link of the job list","example":"https://admin.hlx.page/job/owner/repo/ref/preview","type":"string","format":"url"}}}}},"bulkPublishBody":{"description":"bulk publish body","required":["paths"],"properties":{"forceUpdate":{"description":"forces an update of the resources during bulk-publish","type":"boolean"},"paths":{"description":"paths to filter the bulk publish","type":"array","items":{"type":"string"}},"delete":{"description":"delete the resources from publish","type":"boolean","default":false}}},"bulkPreviewBody":{"description":"bulk preview body","required":["paths"],"properties":{"forceUpdate":{"description":"forces an update of the resources during bulk-preview","type":"boolean"},"paths":{"description":"paths to filter the bulk preview","type":"array","items":{"type":"string"}},"delete":{"description":"delete the resources from preview","type":"boolean","default":false}}},"changeEntry":{"description":"Describes the changes made to one resource.","required":["type","path"],"properties":{"type":{"description":"change type","type":"string","enum":["added","deleted","modified"]},"path":{"description":"Relative path of changed resource or `*` if this as a branch event.","type":"string"},"time":{"description":"timestamp of change","type":"string","format":"date-time"},"commit":{"description":"commit sha of change","type":"string"},"contentType":{"description":"the content type of the changed resource","type":"string"}}},"changeEventBody":{"description":"Change event payload","required":["changes"],"additionalProperties":true,"properties":{"source":{"description":"event source, eg: 'github'\n","type":"string"},"baseRef":{"description":"base ref for branch operations","type":"string"},"changes":{"description":"array of changes","type":"array","items":{"$ref":"#/components/schemas/changeEntry"}}}},"indexResource":{"description":"Information of the index","required":["name"],"properties":{"name":{"description":"Index name in helix-index.yaml","type":"string"},"githubLink":{"description":"Github url of the helix-index.yaml","example":"https://github.com/owner/repo/blob/main/helix-index.yaml#L4","type":"string","format":"url"},"indexedUrl":{"description":"URL of document that was indexed. Deprecation Note: The indexed html is always fetched from the preview/live url at the time of publishing and hence not required in helix-index.yaml anymore.\n","deprecated":true,"example":"https://main--owner--repo.hlx.page/en/2021/blog","type":"string","format":"url"},"lastModified":{"type":"string","format":"date-time"},"status":{"description":"status of index operation on resource","type":"number"}}},"indexInfo":{"required":["index"],"properties":{"index":{"description":"Information of the index","type":"object","$ref":"#/components/schemas/indexResource"}}},"loginLinks":{"required":["links"],"properties":{"links":{"description":"API navigation links","additionalProperties":{"type":"string","format":"url"}}}},"logoutLink":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"logout":{"description":"link of logout","example":"https://admin.hlx.page/logout","type":"string","format":"url"}}}}},"sitemapInfo":{"description":"Information for the sitemap that was generated","properties":{"paths":{"description":"Paths that were updated","type":"array","items":{"type":"string"}}}},"jobList":{"required":["topic","jobs"],"properties":{"topic":{"description":"Job Topic","type":"string"},"jobs":{"description":"Jobs","type":"array","items":{"required":["name","state","time","href"],"description":"Job info","type":"object","properties":{"name":{"description":"Job name","type":"string"},"state":{"description":"Job State","type":"string"},"time":{"description":"Job creation time","type":"string","format":"date-time"},"href":{"description":"link of the job api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13","type":"string","format":"url"}}}}}},"jobListLink":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"self":{"description":"link of the job list","example":"https://admin.hlx.page/job/owner/repo/ref/preview","type":"string","format":"url"}}}}},"jobStatusDetails":{"required":["topic","name","state","startTime","data"],"properties":{"topic":{"description":"Job Topic","type":"string"},"name":{"description":"Job Name","type":"string"},"state":{"description":"Job State","type":"string"},"startTime":{"description":"Job start time","type":"string","format":"date-time"},"endTime":{"description":"Job end time","type":"string","format":"date-time"},"cancelled":{"description":"Flag indicating if job was cancelled","type":"boolean"},"data":{"description":"Custom job data","type":"object"},"progress":{"description":"job progress","type":"object"}}},"jobLinksInfoDetails":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"self":{"description":"link of the job details api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13/details","type":"string","format":"url"},"job":{"description":"link of the job api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13","type":"string","format":"url"},"list":{"description":"link of the job list","example":"https://admin.hlx.page/job/owner/repo/ref/preview","type":"string","format":"url"}}}}},"logResult":{"description":"Log result","required":["entries"],"properties":{"entries":{"description":"entries in that page","type":"array","items":{"type":"object"}},"nextToken":{"description":"token to pass in next call to continue paging","type":"string"},"links":{"description":"API navigation links","properties":{"next":{"description":"link to the next batch","example":"https://admin.hlx.page/log/owner/repo/ref/?nextToken=ABAB==","type":"string","format":"url"}}},"from":{"description":"log start time","type":"string"},"to":{"description":"log end time","type":"string"}}},"logEntriesBody":{"description":"Add logs body","required":["entries"],"properties":{"entries":{"description":"entries to add to the logs","type":"array","items":{"type":"object"}}}},"snapshotList":{"required":["snapshots"],"properties":{"snapshots":{"description":"List of snapshot IDs","type":"array","items":{"type":"string"}}}},"snapshotLinksList":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"self":{"description":"link of the snapshot list api","example":"https://admin.hlx.page/snapshot/owner/repo/main","type":"string","format":"url"}}}}},"snapshotResource":{"description":"snapshot resource","type":"object","required":["path"],"properties":{"path":{"description":"path of the resource","type":"string"},"status":{"description":"status code for the resource","type":"number"},"lastModified":{"description":"last modified date of the resource","type":"string","format":"date-time"}}},"snapshotManifest":{"required":["manifest"],"properties":{"manifest":{"required":["id","created","lastModified","resources"],"properties":{"id":{"description":"The snapshot ID","type":"string"},"title":{"description":"The snapshot title","type":"string"},"description":{"description":"The snapshot description","type":"string"},"created":{"description":"Creation time","type":"string","format":"date-time"},"lastModified":{"description":"Last manifest modification time","type":"string","format":"date-time"},"lastUpdated":{"description":"Last time a resource was added or removed from this snapshot","type":"string","format":"date-time"},"locked":{"description":"Time when this snapshot was locked.","type":"string","format":"date-time"},"resources":{"description":"list of resources in the snapshot","type":"array","items":{"$ref":"#/components/schemas/snapshotResource"}}}}}},"snapshotLinksInfo":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"snapshot":{"description":"link of the status api","example":"https://admin.hlx.page/snapshot/owner/repo/ref/1234","type":"string","format":"url"}}}}},"snapshotInfo":{"required":["snapshot"],"properties":{"snapshot":{"required":["id"],"properties":{"id":{"description":"The snapshot ID","type":"string"},"locked":{"description":"Time when this snapshot was locked.","type":"string","format":"date-time"}}}}},"bulkSnapshotBody":{"description":"bulk snapshot body","required":["paths"],"properties":{"forceUpdate":{"description":"forces an update of the resources during bulk snapshot","type":"boolean"},"paths":{"description":"paths of resources to include in the bulk snapshot","type":"array","items":{"type":"string"}}}},"jobState":{"description":"Job state","type":"string","enum":["created","running","stopped"]},"snapshotJob":{"required":["job"],"properties":{"job":{"required":["topic","name","state","createTime","data","startTime","stopTime","invocationId","progress"],"properties":{"topic":{"description":"Job Topic","type":"string"},"name":{"description":"Job Name","type":"string"},"state":{"description":"Job State","$ref":"#/components/schemas/jobState"},"createTime":{"description":"Job creation time","type":"string","format":"date-time"},"stopTime":{"description":"Job end time","type":"string","format":"date-time"},"startTime":{"description":"Job start time","type":"string","format":"date-time"},"invocationId":{"description":"Job end time","type":"string"},"progress":{"type":"object","properties":{"total":{"description":"total number of resources","type":"number"},"processed":{"description":"number of resources processed","type":"number"},"failed":{"description":"number of resources failed","type":"number"}}},"data":{"description":"Snapshot job data","type":"object","properties":{"paths":{"description":"paths being published from snapshot","type":"array","items":{"type":"string"}},"forceUpdate":{"description":"force update of resources","type":"boolean"},"snapshotId":{"description":"snapshot id","type":"string"},"phase":{"description":"current phase of the job","type":"string"},"resources":{"description":"list of resources in the snapshot","type":"array","items":{"$ref":"#/components/schemas/snapshotResource"}}}}}}}},"snapshotLinksPublishJob":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"self":{"description":"link of the publish snapshot job api","example":"https://admin.hlx.page/job/owner/repo/main/publish/job-name","type":"string","format":"url"}}}}},"title":{"type":"string","description":"human readable title. has no influence on the configuration."},"description":{"type":"string","description":"description for clarity. has no influence on the configuration."},"user":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/user","title":"user","type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9-_=]+$"},"email":{"type":"string","format":"email"},"name":{"type":"string"},"roles":{"type":"array","items":{"type":"string","enum":["admin","author","publish","develop","basic_author","basic_publish","config","config_admin"]}}},"required":["id","email","roles"],"additionalProperties":false},"users":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/users","title":"users","type":"array","items":{"$ref":"#/components/schemas/user"}},"groups":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/groups","type":"object","title":"Groups","patternProperties":{"^[a-zA-Z0-9-_=]+$":{"type":"object","title":"Group","description":"A group of members. Can be referenced in access.admin.role.","properties":{"members":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"email"},"name":{"type":"string"}},"required":["email"]}}},"additionalProperties":false,"required":["members"]}},"additionalProperties":false},"tokens":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/tokens","title":"tokens","type":"object","patternProperties":{"^[a-zA-Z0-9-_=]+$":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9-_=]+$"},"hash":{"type":"string","pattern":"^[a-zA-Z0-9-_=]+$"},"created":{"type":"string","format":"date-time"}},"additionalProperties":false}},"additionalProperties":false},"org-access":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/org/access","$schema":"https://json-schema.org/draft/2019-09/schema","title":"Org Access Config","type":"object","properties":{"admin":{"type":"object","properties":{"apiKeyId":{"description":"the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them.","type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false},"org":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/org","title":"Helix Org Config","type":"object","properties":{"version":{"type":"integer","enum":[1],"default":1},"title":{"$ref":"#/components/schemas/title"},"description":{"$ref":"#/components/schemas/description"},"users":{"$ref":"#/components/schemas/users"},"groups":{"$ref":"#/components/schemas/groups"},"tokens":{"$ref":"#/components/schemas/tokens"},"access":{"$ref":"#/components/schemas/org-access"}},"required":["version"],"additionalProperties":false},"orgConfigUser":{"type":"object","description":"org user","required":["email","roles"],"properties":{"email":{"description":"email of the user","type":"string"},"roles":{"description":"role of the user","type":"array","items":{"type":"string","enum":["admin","author","publish","develop","basic_author","basic_publish","config","config_admin"]}}}},"orgConfigUsers":{"type":"array","description":"org users","items":{"$ref":"#/components/schemas/orgConfigUser"}},"content-source-google":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/content-source/google","title":"Google Content Source","type":"object","properties":{"type":{"const":"google"},"url":{"type":"string","format":"uri"},"id":{"description":"Google drive ID of the root folder; updated automatically when updating the url.","type":"string"}},"required":["type","url","id"],"additionalProperties":false},"content-source-onedrive":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/content-source/onedrive","title":"Onedrive Content Source","type":"object","properties":{"type":{"const":"onedrive"},"url":{"type":"string","format":"uri"},"tenantId":{"type":"string"},"itemId":{"description":"onedrive item ID of the root folder; currently not required as we don't know how setup will work.","type":"string"}},"required":["type","url"],"additionalProperties":false},"content-source-markup":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/content-source/markup","title":"Markup Content Source","type":"object","properties":{"type":{"const":"markup"},"url":{"type":"string","format":"uri"},"suffix":{"type":"string"}},"required":["type","url"],"additionalProperties":false},"content":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/content","type":"object","title":"Content source","description":"Defines the content bus location and source.","properties":{"title":{"$ref":"#/components/schemas/title"},"description":{"$ref":"#/components/schemas/description"},"contentBusId":{"type":"string"},"source":{"oneOf":[{"$ref":"#/components/schemas/content-source-google"},{"$ref":"#/components/schemas/content-source-onedrive"},{"$ref":"#/components/schemas/content-source-markup"}]},"overlay":{"oneOf":[{"$ref":"#/components/schemas/content-source-markup"}]}},"required":["contentBusId","source"],"additionalProperties":false},"code":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/code","title":"Code source","type":"object","description":"Defines the code bus location and source.","properties":{"title":{"$ref":"#/components/schemas/title"},"description":{"$ref":"#/components/schemas/description"},"owner":{"$comment":"Note, that owner/repo are no longer part of the hostname and can therefor have more allowed characters than in helix4","type":"string","pattern":"[a-zA-Z0-9_-]+"},"repo":{"type":"string","pattern":"[a-zA-Z0-9_-]+"},"source":{"type":"object","properties":{"type":{"const":"github"},"url":{"type":"string","format":"uri"}},"required":["type","url"],"additionalProperties":false}},"required":["owner","repo","source"]},"folders":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/folders","type":"object","title":"folders","patternProperties":{"^/[a-zA-Z0-9-/.]*$":{"type":"string"}},"additionalProperties":false},"keyValuePair":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false},"headers":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/headers","type":"object","title":"Helix Headers Config","patternProperties":{"^[a-zA-Z0-9-/._*]+$":{"type":"array","items":{"$ref":"#/components/schemas/keyValuePair"}}},"additionalProperties":false},"cdn-prod-fastly":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/cdn/prod/fastly","$schema":"https://json-schema.org/draft/2019-09/schema","title":"Fastly CDN Config","type":"object","description":"Production CDN configuration for Fastly","properties":{"type":{"type":"string","const":"fastly"},"host":{"description":"production host","type":"string"},"route":{"description":"Routes on the CDN that are rendered with Franklin","type":"array","items":{"type":"string"}},"serviceId":{"description":"The Fastly Service ID","type":"string"},"authToken":{"description":"A Fastly token for purging","type":"string"}},"required":["type","host","serviceId","authToken"],"additionalProperties":false},"cdn-prod-cloudflare":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/cdn/prod/cloudflare","$schema":"https://json-schema.org/draft/2019-09/schema","title":"Cloudflare CDN Config","type":"object","properties":{"type":{"type":"string","const":"cloudflare"},"host":{"description":"production host","type":"string"},"route":{"description":"Routes on the CDN that are rendered with Franklin","type":"array","items":{"type":"string"}},"plan":{"type":"string"},"zoneId":{"type":"string"},"apiToken":{"type":"string"}},"required":["type","host","plan","zoneId","apiToken"],"additionalProperties":false},"cdn-prod-akamai":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/cdn/prod/akamai","$schema":"https://json-schema.org/draft/2019-09/schema","title":"Akamai CDN Config","type":"object","properties":{"type":{"type":"string","const":"akamai"},"host":{"description":"production host","type":"string"},"route":{"description":"Routes on the CDN that are rendered with Franklin","type":"array","items":{"type":"string"}},"endpoint":{"type":"string"},"clientSecret":{"type":"string"},"clientToken":{"type":"string"},"accessToken":{"type":"string"}},"required":["type","host","endpoint","clientSecret","clientToken","accessToken"],"additionalProperties":false},"cdn-prod-managed":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/cdn/prod/managed","$schema":"https://json-schema.org/draft/2019-09/schema","title":"Managed CDN Config","type":"object","properties":{"type":{"type":"string","const":"managed"},"host":{"description":"production host","type":"string"},"route":{"description":"Routes on the CDN that are rendered with Franklin","type":"array","items":{"type":"string"}}},"required":["type","host"],"additionalProperties":false},"cdn-prod-cloudfront":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/cdn/prod/cloudfront","$schema":"https://json-schema.org/draft/2019-09/schema","title":"Cloudfront CDN Config","type":"object","properties":{"type":{"type":"string","const":"cloudfront"},"host":{"description":"production host","type":"string"},"route":{"description":"Routes on the CDN that are rendered with Franklin","type":"array","items":{"type":"string"}},"distributionId":{"type":"string"},"accessKeyId":{"type":"string"},"secretAccessKey":{"type":"string"}},"required":["type","host","distributionId","accessKeyId","secretAccessKey"],"additionalProperties":false},"cdn":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/cdn","$schema":"https://json-schema.org/draft/2019-09/schema","title":"CDN Config","type":"object","properties":{"prod":{"oneOf":[{"$ref":"#/components/schemas/cdn-prod-fastly"},{"$ref":"#/components/schemas/cdn-prod-cloudflare"},{"$ref":"#/components/schemas/cdn-prod-akamai"},{"$ref":"#/components/schemas/cdn-prod-managed"},{"$ref":"#/components/schemas/cdn-prod-cloudfront"},{"type":"object","title":"EmptyConfig","properties":{"host":{"description":"production host","type":"string"}},"required":["host"],"additionalProperties":false}]},"live":{"type":"object","properties":{"host":{"description":"Sidekick config to override the default preview host. it supports parameters $owner and $repo","examples":["main--$repo--page.example.com"],"type":"string"}},"required":["host"],"additionalProperties":false},"preview":{"type":"object","properties":{"host":{"description":"Sidekick config to override the default live host. it supports parameters $owner and $repo","examples":["main--$repo--live.example.com\""],"type":"string"}},"required":["host"],"additionalProperties":false}},"additionalProperties":false},"access-admin":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/access/admin","$schema":"https://json-schema.org/draft/2019-09/schema","title":"Admin Access Config","type":"object","properties":{"role":{"title":"Role","type":"object","patternProperties":{"^[a-z-_]+$":{"description":"The email glob of the users or a group reference for the respective role.","type":"array","items":{"type":"string"}}},"additionalProperties":false},"requireAuth":{"description":"Enforce authentication if set to true. If set to 'auto' it will enforce authentication if a role mapping is defined. defaults to 'auto'.","default":"auto","oneOf":[{"type":"boolean"},{"type":"string","enum":["auto"]}]},"defaultRole":{"description":"the default roles assigned to the users. defaults to `basic_publish` for unauthenticated setups.","type":"array","items":{"type":"string","enum":["admin","author","publish","develop","basic_author","basic_publish","config","config_admin"]}},"apiKeyId":{"description":"the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them.","type":"array","items":{"type":"string"}}},"additionalProperties":false},"access-site":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/access/site","$schema":"https://json-schema.org/draft/2019-09/schema","title":"Site Access Config","type":"object","properties":{"allow":{"description":"The email glob of the users or a group reference that are allowed access","type":"array","items":{"type":"string"}},"apiKeyId":{"description":"IDs of the api keys (tokens) that are allowed.","type":"array","items":{"type":"string"}},"clientCertDN":{"description":"the DNs of the client certificates that are allowed.","type":"array","items":{"type":"string"}}},"additionalProperties":false},"access":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/access","type":"object","title":"Access","properties":{"admin":{"$ref":"#/components/schemas/access-admin"},"site":{"$ref":"#/components/schemas/access-site"},"preview":{"$ref":"#/components/schemas/access-site"},"live":{"$ref":"#/components/schemas/access-site"}},"additionalProperties":false},"sidekickPlugin":{"type":"object","properties":{"id":{"type":"string","description":"The unique plugin ID"},"title":{"type":"string","description":"The button text"},"url":{"type":"string","description":"The URL to open when the button is clicked"},"containerId":{"type":"string","description":"The ID of the container to add this plugin to"},"environments":{"type":"array","items":{"type":"string","enum":["any","dev","admin","edit","preview","live","prod"]},"description":"The environments to display this plugin in","default":"any"},"event":{"type":"string","description":"The name of a custom event to fire when the button is clicked (defaults to id)"},"excludePaths":{"type":"array","items":{"type":"string"},"description":"Exclude the plugin from these paths","examples":["/foo/**","**/:x:**"]},"includePaths":{"type":"array","items":{"type":"string"},"description":"Include the plugin on these paths (overrides excludePaths)","examples":["/foo/bar/**","**.docx**"]},"isContainer":{"type":"boolean","description":"Turns the plugin into a container for other plugins"},"isPalette":{"type":"boolean","description":"Opens the URL in a palette instead of a new tab"},"paletteRect":{"type":"string","description":"he dimensions and position of a palette box"},"titleI18n":{"type":"object","description":"The button text in other supported languages","patternProperties":{"^[a-z]{2}(-[A-Z]{2})?$":{"type":"string","description":"ISO language code (`en` or `en-US`) with translated button text"}},"minProperties":1,"additionalProperties":false},"passConfig":{"type":"boolean","description":"Append ref, repo, owner, host, and project as query params on new URL button click"},"passReferrer":{"type":"boolean","description":"Append the referrer URL as a query param on new URL button click"}},"required":["id"],"dependentRequired":{"isPalette":["url"],"paletteRect":["isPalette"]}},"sidekick":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/sidekick","$schema":"https://json-schema.org/draft/2019-09/schema","definitions":{"sidekickPlugin":{"type":"object","properties":{"id":{"type":"string","description":"The unique plugin ID"},"title":{"type":"string","description":"The button text"},"url":{"type":"string","description":"The URL to open when the button is clicked"},"containerId":{"type":"string","description":"The ID of the container to add this plugin to"},"environments":{"type":"array","items":{"type":"string","enum":["any","dev","admin","edit","preview","live","prod"]},"description":"The environments to display this plugin in","default":"any"},"event":{"type":"string","description":"The name of a custom event to fire when the button is clicked (defaults to id)"},"excludePaths":{"type":"array","items":{"type":"string"},"description":"Exclude the plugin from these paths","examples":["/foo/**","**/:x:**"]},"includePaths":{"type":"array","items":{"type":"string"},"description":"Include the plugin on these paths (overrides excludePaths)","examples":["/foo/bar/**","**.docx**"]},"isContainer":{"type":"boolean","description":"Turns the plugin into a container for other plugins"},"isPalette":{"type":"boolean","description":"Opens the URL in a palette instead of a new tab"},"paletteRect":{"type":"string","description":"he dimensions and position of a palette box"},"titleI18n":{"type":"object","description":"The button text in other supported languages","patternProperties":{"^[a-z]{2}(-[A-Z]{2})?$":{"type":"string","description":"ISO language code (`en` or `en-US`) with translated button text"}},"minProperties":1,"additionalProperties":false},"passConfig":{"type":"boolean","description":"Append ref, repo, owner, host, and project as query params on new URL button click"},"passReferrer":{"type":"boolean","description":"Append the referrer URL as a query param on new URL button click"}},"required":["id"],"dependentRequired":{"isPalette":["url"],"paletteRect":["isPalette"]}}},"title":"Sidekick Config","type":"object","properties":{"plugins":{"type":"array","items":{"$ref":"#/components/schemas/sidekickPlugin"}}}},"metadata-source":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/metadata-source","type":"object","title":"metadata","properties":{"source":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"robots":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/robots","type":"object","title":"robots","properties":{"txt":{"type":"string"}},"additionalProperties":false},"public":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/public","type":"object","title":"public","description":"Public configuration"},"site":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/site","title":"Helix Site Config","type":"object","properties":{"version":{"type":"integer","enum":[1],"default":1},"name":{"type":"string","description":"Site name; part of the hostname","pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"},"title":{"$ref":"#/components/schemas/title"},"description":{"$ref":"#/components/schemas/description"},"content":{"$ref":"#/components/schemas/content"},"code":{"$ref":"#/components/schemas/code"},"folders":{"$ref":"#/components/schemas/folders"},"headers":{"$ref":"#/components/schemas/headers"},"cdn":{"$ref":"#/components/schemas/cdn"},"access":{"$ref":"#/components/schemas/access"},"tokens":{"$ref":"#/components/schemas/tokens"},"groups":{"$ref":"#/components/schemas/groups"},"sidekick":{"$ref":"#/components/schemas/sidekick"},"metadata":{"$ref":"#/components/schemas/metadata-source"},"robots":{"$ref":"#/components/schemas/robots"},"public":{"$ref":"#/components/schemas/public"},"extends":{"type":"object","properties":{"profile":{"type":"string","pattern":"^[0-9a-zA-Z-_]+$"}},"additionalProperties":false}},"required":["version","content","code"],"additionalProperties":false},"profile":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/profile","title":"Helix Profile Config","type":"object","properties":{"version":{"type":"integer","enum":[1],"default":1},"title":{"$ref":"#/components/schemas/title"},"description":{"$ref":"#/components/schemas/description"},"content":{"$ref":"#/components/schemas/content"},"code":{"$ref":"#/components/schemas/code"},"folders":{"$ref":"#/components/schemas/folders"},"headers":{"$ref":"#/components/schemas/headers"},"cdn":{"$ref":"#/components/schemas/cdn"},"access":{"$ref":"#/components/schemas/access"},"tokens":{"$ref":"#/components/schemas/tokens"},"groups":{"$ref":"#/components/schemas/groups"},"sidekick":{"$ref":"#/components/schemas/sidekick"},"metadata":{"$ref":"#/components/schemas/metadata-source"},"robots":{"$ref":"#/components/schemas/robots"},"public":{"$ref":"#/components/schemas/public"}},"required":["version"],"additionalProperties":false},"indexconfig":{"$id":"https://ns.adobe.com/helix/shared/indexconfig","$schema":"http://json-schema.org/draft-07/schema#","title":"Index Configuration","type":"object","properties":{"version":{"type":"integer","enum":[1],"default":1},"indices":{"type":"object","patternProperties":{"^[a-zA-Z0-9-_=]+$":{"title":"An individual index","type":"object","properties":{"include":{"type":"array","title":"Include","description":"Glob patterns for paths where this index is used.","items":{"type":"string"},"examples":["/blog/**","/en/publish/*/*/*/*"]},"exclude":{"type":"array","title":"Exclude","description":"Glob patterns for paths where this index must not be used.","items":{"type":"string"},"examples":["/drafts/**"]},"target":{"type":"string","format":"uri-reference","description":"The data sink to store the extracted data in. This can be an Excel workbook, a Google spreadsheet or an S3 object"},"properties":{"type":"object","title":"Properties","description":"The properties to add to the index","patternProperties":{"^[a-zA-Z0-9-_=]+$":{"type":"object","title":"Property","oneOf":[{"title":"Single-Value Property","description":"The property in an index. The value will be stored as a single cardinal value.","type":"object","properties":{"selectFirst":{"type":"string","description":"A CSS selector expression that selects the first matching node in the HTML (DOM) or Markdown (MDAST) syntax tree"},"value":{"type":"string","description":"A ES6 template literal expression that extracts the value from the matching node(s) to be stored in the index"}},"additionalProperties":false,"required":["selectFirst","value"]},{"title":"Multi-value property, concatenated to a single value","description":"The property in an index. The value will be stored as a single cardinal value.","type":"object","properties":{"select":{"type":"string","description":"A CSS selector expression that selects all matching nodes in the HTML (DOM) or Markdown (MDAST) syntax tree"},"value":{"type":"string","description":"A ES6 template literal expression that extracts the value from the matching node(s) to be stored in the index"}},"additionalProperties":false,"required":["select","value"]},{"title":"Multi-Value Property","description":"The property in an index. The value will be stored as a list of values","type":"object","properties":{"select":{"type":"string","description":"A CSS selector expression that selects all matching nodes in the HTML (DOM) or Markdown (MDAST) syntax tree"},"values":{"type":"string","description":"A ES6 template literal expression that extracts the values from the matching nodes to be stored in the index"}},"additionalProperties":false,"required":["select","values"]}]}}}},"required":["properties"]}}}}},"hreflang":{"type":"string","title":"HREF Language","description":"The HREF language to use when listing alternates according to [RFC 5988](https://datatracker.ietf.org/doc/html/rfc5988).","pattern":"^((?:(en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang))|((?:([A-Za-z]{2,3}(-(?:[A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-(?:[A-Za-z]{4}))?(-(?:[A-Za-z]{2}|[0-9]{3}))?(-(?:[A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-(?:[0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(?:x(-[A-Za-z0-9]{1,8})+))?)|(?:x(-[A-Za-z0-9]{1,8})+))$"},"sitemapconfig":{"$id":"https://ns.adobe.com/helix/shared/sitemapconfig","$schema":"http://json-schema.org/draft-07/schema#","title":"Sitemap Configuration","$defs":{"hreflang":{"type":"string","title":"HREF Language","description":"The HREF language to use when listing alternates according to [RFC 5988](https://datatracker.ietf.org/doc/html/rfc5988).","pattern":"^((?:(en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang))|((?:([A-Za-z]{2,3}(-(?:[A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-(?:[A-Za-z]{4}))?(-(?:[A-Za-z]{2}|[0-9]{3}))?(-(?:[A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-(?:[0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(?:x(-[A-Za-z0-9]{1,8})+))?)|(?:x(-[A-Za-z0-9]{1,8})+))$"}},"type":"object","properties":{"version":{"type":"integer","enum":[1],"default":1},"sitemaps":{"type":"object","patternProperties":{"^[a-zA-Z0-9-_=]+$":{"type":"object","properties":{"source":{"type":"string","title":"Source","description":"The source resource path to get records from. These records should at least contain a path property."},"origin":{"type":"string","title":"Origin","description":"The origin to prepend to paths found in the source."},"destination":{"type":"string","title":"Path","description":"The destination resource path to store sitemap to."},"lastmod":{"type":"string","title":"Lastmod","description":"The format to use for last modification of a location. If not present, no last modification is added.","examples":["YYYY-MM-DD","YYYY-MM-DD hh:mm:ss"]},"languages":{"type":"object","title":"Sitemap Languages","description":"The languages to add to the sitemap","patternProperties":{"^[a-zA-Z0-9-_=]+$":{"properties":{"source":{"type":"string","title":"Source","description":"The source resource path to get records from. These records should at least contain a path property."},"destination":{"type":"string","title":"Path","description":"The destination resource path to store sitemap to."},"hreflang":{"anyOf":[{"$ref":"#/components/schemas/hreflang"},{"type":"array","items":{"$ref":"#/components/schemas/hreflang"}}]},"alternate":{"type":"string","title":"Alternate","description":"How to compute the respective path in that language. If not present, paths do not contain a language specific part.","examples":["/{path}","/en/{path}","/german/{path}"]},"extension":{"type":"string","title":"Location extension","description":"Extension to append to every location generated for this sitemap. Default is empty","examples":[".html"]}},"required":["destination","hreflang"]}}},"extension":{"type":"string","title":"Location extension","description":"Extension to append to every location generated for this sitemap. Default is empty","examples":[".html"]}},"required":[]}}}}},"sites":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/sites","title":"Helix Sites List","type":"object","properties":{"sites":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false}}},"required":["sites"],"additionalProperties":false},"profiles":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/profiles","title":"Helix Profiles List","type":"object","properties":{"profiles":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false}}},"required":["profiles"],"additionalProperties":false}},"parameters":{"ownerParam":{"name":"owner","in":"path","description":"Repository owner.","required":true,"schema":{"type":"string"}},"repoParam":{"name":"repo","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},"refParam":{"name":"ref","in":"path","description":"Ref (branch) of repository.","required":true,"schema":{"type":"string"}},"pathParam":{"name":"path","in":"path","description":"Relative path of the resource","required":true,"schema":{"type":"string"}},"statusEditUrlParam":{"name":"editUrl","in":"query","description":"Optional URL of the edit (authoring) document","required":false,"schema":{"oneOf":[{"type":"string","format":"url"},{"type":"string","enum":["auto"]}]}},"forceUpdateRedirectsParam":{"name":"forceUpdateRedirects","in":"query","description":"forces an update of the redirects (only applies when updating/publishing redirects.json)","required":false,"schema":{"type":"boolean"}},"disableNotificationsParam":{"name":"disableNotifications","in":"query","description":"disables notifications for affected resources","schema":{"type":"boolean"}},"word2mdVersionParam":{"name":"hlx-word2md-version","in":"query","description":"selects the version to use when invoking the word2md service.","required":false,"schema":{"type":"string"}},"gdocs2mdVersionParam":{"name":"hlx-gdocs2md-version","in":"query","description":"selects the version to use when invoking the gdocs2md service.","required":false,"schema":{"type":"string"}},"html2mdVersionParam":{"name":"hlx-html2md-version","in":"query","description":"selects the version to use when invoking the html2md service.","required":false,"schema":{"type":"string"}},"branchParam":{"name":"branch","in":"query","description":"Optional branch specifier in case the branch name contains slashes or uppercase characters.","required":false,"schema":{"oneOf":[{"type":"string","format":"url"},{"type":"string","enum":["auto"]}]}},"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"}},"sinceParam":{"name":"since","in":"query","description":"Indicates the time span to retrieve logs for, as a number and a unit in short notation (`s`, `m`, `h` or `d`). Not usable in combination with either `from` or `to`.\n","required":false,"schema":{"type":"string","example":"5m"}},"nextTokenParam":{"name":"nextToken","in":"query","description":"Token returned from a previous call to continue\n","required":false,"schema":{"type":"string"}},"snIdParam":{"name":"snapshotId","in":"path","description":"Id of the snapshot","required":true,"schema":{"type":"string"}},"snFilterParam":{"name":"filter","in":"query","description":"Filters the resources that are selected for snapshot. If set to `modified` only the resources that have a preview date newer than the live date are selected.\n","schema":{"enum":["all","modified"],"default":"all"}},"snPublishParam":{"name":"publish","in":"query","description":"Indicates that the snapshot should be published.\n","schema":{"enum":["true"]}},"snReviewParam":{"name":"review","in":"query","description":"State to move the snapshot into.\n","schema":{"enum":["request","approve","reject"]}},"snReviewMessageParam":{"name":"message","in":"query","description":"Message of the review action, included in logs and events.\n","schema":{"type":"string"}},"orgParam":{"name":"org","in":"path","description":"organisation name.","required":true,"schema":{"type":"string"}},"userIdParam":{"name":"id","in":"path","description":"user id.","required":true,"schema":{"type":"string"}},"siteParam":{"name":"site","in":"path","description":"site id.","required":true,"schema":{"type":"string"}},"migrateParam":{"name":"migrate","in":"query","description":"indicates to migrate the config.","required":false,"schema":{"type":"boolean"}},"validateParam":{"name":"validate","in":"query","description":"indicates to validate the config to be migrated. only effective when `migrate` is set to `true`.","required":false,"schema":{"type":"boolean"}},"tokenIdParam":{"name":"id","in":"path","description":"access token id.","required":true,"schema":{"type":"string"}},"profileParam":{"name":"profile","in":"path","description":"profile name.","required":true,"schema":{"type":"string"}}},"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"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}},"examples":{"example":{"summary":"fetch status of multiple files","value":{"select":["edit","preview","live"],"paths":["/en","/en/*","/blog/"]}},"bulk-publish-payload_example":{"summary":"publish multiple files","value":{"forceUpdate":true,"paths":["/en","/metadata.json","/blog/"],"delete":false}},"bulk-preview-payload_example":{"summary":"preview multiple files","value":{"forceUpdate":true,"paths":["/en","/en/*","/metadata.json","/blog/"],"delete":false}},"change-event-payload_example":{"summary":"Multiple files event example","value":{"type":"github","baseRef":"","installationId":995843,"changes":[{"path":"new-file.txt","time":"2021-05-04T13:40:15+09:00","type":"added","contentType":"text/plain; charset=utf-8","commit":"5edf98811d50b5b948f6f890f0c4367095490dbd"},{"path":"src/html.htl","time":"2021-05-04T13:40:15+09:00","type":"deleted","contentType":"application/octet-stream","commit":"5edf98811d50b5b948f6f890f0c4367095490dbd"},{"path":"README.md","time":"2021-05-04T13:40:15+09:00","type":"modified","contentType":"text/markdown; charset=utf-8","commit":"5edf98811d50b5b948f6f890f0c4367095490dbd"},{"path":"fail.md","time":"2021-05-04T13:40:15+09:00","type":"modified","contentType":"text/markdown; charset=utf-8","commit":"5edf98811d50b5b948f6f890f0c4367095490dbd"}]}},"multiple-paths":{"summary":"snapshot multiple files","value":{"forceUpdate":true,"paths":["/en","/blog/"]}},"wildcard":{"summary":"snapshot multiple files with wildcard","value":{"forceUpdate":false,"paths":["/en/*"]}}}},"x-tagGroups":[{"name":"Authoring and Publishing","tags":["status","publish","preview","code","cache","index","sitemap","snapshot"]},{"name":"Operations","tags":["authentication","log","job"]},{"name":"Configuration Management","tags":["orgConfig","siteConfig","profileConfig","indexConfig","sitemapConfig"]}]}},"searchIndex":{"store":["tag/status","tag/status/operation/status","tag/status/operation/bulkStatus","tag/publish","tag/publish/operation/getPublishStatus","tag/publish/operation/publishResource","tag/publish/operation/unpublishResource","tag/publish/operation/bulkPublish","tag/preview","tag/preview/operation/previewStatus","tag/preview/operation/updatePreview","tag/preview/operation/deletePreview","tag/preview/operation/bulkPreview","tag/code","tag/code/operation/codeStatus","tag/code/operation/updateCode","tag/code/operation/deleteCode","tag/code/operation/batchCode","tag/cache","tag/cache/operation/purgeCache","tag/index","tag/index/operation/getIndexStatus","tag/index/operation/indexResource","tag/index/operation/indexRemovePage","tag/sitemap","tag/sitemap/operation/generateSitemap","tag/snapshot","tag/snapshot/operation/listSnapshots","tag/snapshot/operation/getSnapshotManifest","tag/snapshot/operation/updateSnapshotManifest","tag/snapshot/operation/getSnapshot","tag/snapshot/operation/createSnapshot","tag/snapshot/operation/deleteSnapshot","tag/snapshot/operation/bulkSnapshot","tag/snapshot/operation/publishSnapshotResource","tag/snapshot/operation/publishSnapshot","tag/snapshot/operation/reviewSnapshot","tag/authentication","tag/authentication/operation/login","tag/authentication/operation/login-repo","tag/authentication/operation/logout","tag/authentication/operation/profile","tag/log","tag/log/operation/getLogs","tag/log/operation/addLogs","tag/job","tag/job/operation/getJobList","tag/job/operation/getJob","tag/job/operation/stopJob","tag/job/operation/getJobDetails","tag/orgConfig","schema/OrgConfig","schema/GroupsConfig","tag/orgConfig/operation/getConfigOrg","tag/orgConfig/operation/updateConfigOrg","tag/orgConfig/operation/createConfigOrg","tag/orgConfig/operation/deleteConfigOrg","tag/orgConfig/operation/listOrgUsers","tag/orgConfig/operation/updateOrgUser","tag/orgConfig/operation/readOrgUser","tag/orgConfig/operation/deleteOrgUser","tag/siteConfig","schema/SiteConfig","schema/SiteConfigList","schema/AdminAccessConfig","schema/SiteAccessConfig","schema/AccessConfig","schema/CDNConfig","schema/CodeConfig","schema/ContentConfig","schema/FoldersConfig","schema/HeadersConfig","schema/MetadataConfig","schema/PublicConfig","schema/GroupsConfig","schema/RobotsConfig","schema/SidekickConfig","schema/TokensConfig","tag/siteConfig/operation/getConfigSites","tag/siteConfig/operation/getConfigSite","tag/siteConfig/operation/updateConfigSite","tag/siteConfig/operation/createSiteSite","tag/siteConfig/operation/deleteConfigSite","tag/siteConfig/operation/getConfigSiteRobots","tag/siteConfig/operation/updateConfigSiteRobots","tag/siteConfig/operation/listSiteTokens","tag/siteConfig/operation/updateSiteToken","tag/siteConfig/operation/readSiteToken","tag/siteConfig/operation/deleteSiteToken","tag/siteConfig/operation/getAggregatedConfigSite","tag/profileConfig","schema/ProfileConfig","schema/ProfileConfigList","schema/AdminAccessConfig","schema/SiteAccessConfig","schema/AccessConfig","schema/CDNConfig","schema/CodeConfig","schema/ContentConfig","schema/FoldersConfig","schema/HeadersConfig","schema/MetadataConfig","schema/PublicConfig","schema/RobotsConfig","schema/SidekickConfig","schema/TokensConfig","tag/profileConfig/operation/getConfigProfiles","tag/profileConfig/operation/getConfigProfile","tag/profileConfig/operation/updateConfigProfile","tag/profileConfig/operation/createConfigProfile","tag/profileConfig/operation/deleteConfigProfile","tag/profileConfig/operation/getConfigProfileRobots","tag/profileConfig/operation/updateConfigProfileRobots","tag/profileConfig/operation/listProfileTokens","tag/profileConfig/operation/updateProfileToken","tag/profileConfig/operation/readProfileToken","tag/profileConfig/operation/deleteProfileToken","tag/indexConfig","schema/IndexConfig","tag/indexConfig/operation/getIndexConfig","tag/indexConfig/operation/updateIndexConfig","tag/indexConfig/operation/createIndexConfig","tag/indexConfig/operation/deleteIndexConfig","tag/sitemapConfig","schema/SitemapConfig","tag/sitemapConfig/operation/getSitemapConfig","tag/sitemapConfig/operation/updateSitemapConfig","tag/sitemapConfig/operation/createSitemapConfig","tag/sitemapConfig/operation/deleteSitemapConfig"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,2.355]],["description/0",[0,2.639,1,3.346]],["title/1",[0,1.89,2,3.441]],["description/1",[0,1.262,3,0.991,4,3.05,5,1.864,6,0.991,7,3.05,8,3.05,9,2.299,10,2.047,11,3.05,12,2.7,13,1.95,14,3.05,15,3.05,16,3.05,17,3.05]],["title/2",[0,1.354,18,2.466,19,1.999,20,1.513]],["description/2",[0,1.04,3,0.468,6,0.816,19,0.88,21,1.167,22,0.921,23,1.883,24,1.893,25,1.275,26,1.021,27,0.361,28,1.275,29,1.167,30,1.085,31,1.44,32,1.78,33,1.78,34,1.44,35,2.367,36,1.44,37,1.44,38,1.44,39,1.44,40,1.44,41,1.44,42,1.44,43,1.44,44,0.708,45,0.921,46,1.085,47,1.44,48,0.921,49,1.021,50,1.085,51,0.756,52,1.44,53,1.44]],["title/3",[54,2.797]],["description/3",[1,3.346,54,3.134]],["title/4",[0,1.89,54,2.244]],["description/4",[0,2.012,3,1.579,5,2.971,6,1.579,54,2.389,55,3.938]],["title/5",[6,1.483,54,2.244]],["description/5",[6,1.393,13,1.754,44,1.348,45,1.754,54,1.348,55,2.222,56,2.222,57,2.879,58,2.741,59,1.754,60,1.608,61,1.677,62,2.418,63,1.677,64,0.912]],["title/6",[6,1.483,65,4.042]],["description/6",[6,1.029,13,2.025,45,2.025,55,2.566,57,2.127,58,2.025,59,2.025,60,1.857,61,1.936,62,2.701,63,1.936,64,1.053,65,2.805,66,1.51]],["title/7",[18,2.466,19,1.999,20,1.513,54,1.608]],["description/7",[3,0.545,6,0.93,10,1.125,19,1.75,20,0.775,22,1.071,23,0.945,24,2.158,35,1.188,45,1.071,48,1.83,49,1.188,50,1.263,51,0.88,54,0.824,64,0.557,67,1.251,68,1.484,69,1.358,70,1.071,71,1.358,72,1.358,73,1.358,74,1.358,75,1.484,76,1.484,77,1.484,78,1.484,79,1.484,80,1.484,81,1.676,82,1.125,83,1.676]],["title/8",[44,2.797]],["description/8",[1,3.346,44,3.134]],["title/9",[0,1.89,44,2.244]],["description/9",[0,2.012,3,1.579,5,2.971,6,1.579,44,2.389,84,3.938]],["title/10",[44,2.244,67,1.995]],["description/10",[6,0.991,13,2.975,21,2.47,44,2.287,67,1.333,84,2.47,85,2.7,86,2.47,87,3.05,88,3.05,89,3.05,90,3.05,91,3.05,92,2.299]],["title/11",[44,2.244,66,2.176]],["description/11",[6,1.491,44,3.074,57,3.08,58,2.933,66,2.187,84,3.717]],["title/12",[18,2.466,19,1.999,20,1.513,44,1.608]],["description/12",[3,0.476,6,0.829,10,0.984,19,1.559,20,0.678,22,0.937,23,1.438,24,1.923,25,1.298,26,1.039,27,0.367,28,1.298,29,1.187,30,1.105,35,1.039,44,1.254,48,1.631,49,1.039,50,1.105,51,0.769,64,0.487,67,1.115,69,1.187,70,0.937,71,1.187,72,1.187,73,1.187,74,1.187,75,1.298,76,1.298,77,1.298,78,1.298,79,1.298,80,1.298,82,0.984,93,1.466,94,1.466,95,1.466]],["title/13",[96,3.478]],["description/13",[1,3.104,96,3.615,97,4.791]],["title/14",[0,1.578,96,2.33,97,3.087]],["description/14",[0,1.899,3,1.491,5,2.805,6,1.491,96,2.805,97,3.717,98,3.717]],["title/15",[67,1.995,96,2.79]],["description/15",[5,1.288,6,0.685,13,1.347,21,1.707,23,1.188,27,0.528,30,1.588,59,1.347,60,1.236,61,1.288,62,1.957,63,1.288,64,0.7,67,1.516,85,1.866,92,1.588,98,1.707,99,3.583,100,3.47,101,1.866,102,1.866,103,1.866,104,2.107]],["title/16",[66,2.176,96,2.79]],["description/16",[6,1.164,59,2.291,60,2.101,61,2.191,62,2.961,63,2.191,64,1.191,66,1.708,96,2.191,98,2.903,99,2.903]],["title/17",[67,1.665,96,2.33,105,3.375]],["description/17",[59,2.107,60,1.932,61,2.014,62,2.782,63,2.014,64,1.095,67,1.44,99,2.669,106,3.295,107,2.918,108,2.918,109,3.295,110,3.295]],["title/18",[111,4.609]],["description/18",[1,3.346,111,5.164]],["title/19",[45,2.436,60,2.235,111,3.087]],["description/19",[5,2.099,6,1.116,60,2.983,61,2.099,62,2.869,63,2.099,64,1.141,112,3.04,113,3.433,114,3.433,115,3.433]],["title/20",[116,2.888]],["description/20",[1,3.346,116,3.236]],["title/21",[0,1.89,116,2.317]],["description/21",[0,2.012,3,1.579,5,2.971,6,1.579,116,2.467,117,3.938]],["title/22",[6,1.483,118,4.565]],["description/22",[6,1.603,23,1.858,27,0.826,30,2.484,54,1.62,101,2.918,102,2.918,103,2.918,116,1.673,117,2.669,119,3.295,120,2.918,121,3.295]],["title/23",[6,1.238,116,1.934,122,3.375]],["description/23",[6,1.792,116,2.8,117,4.468,122,4.884]],["title/24",[123,3.209]],["description/24",[1,3.346,123,3.595]],["title/25",[2,3.441,123,2.574]],["description/25",[2,3.275,22,2.778,23,3.397,123,3.397,124,4.345,125,4.345]],["title/26",[126,2.237]],["description/26",[1,3.346,126,2.506]],["title/27",[126,1.794,127,2.481]],["description/27",[3,1.679,126,2.031,127,2.809,128,5.167,129,5.167]],["title/28",[126,1.794,130,3.441]],["description/28",[3,1.792,126,2.168,130,4.158,131,4.468]],["title/29",[67,1.665,126,1.498,130,2.873]],["description/29",[48,1.502,67,1.027,82,1.577,126,2.15,130,1.771,131,1.903,132,2.349,133,2.858,134,3.357,135,3.357,136,2.349,137,3.791,138,1.903,139,2.349,140,3.791,141,2.349]],["title/30",[0,1.89,126,1.794]],["description/30",[0,2.012,3,1.579,5,2.971,6,1.579,126,1.911,142,3.938]],["title/31",[6,1.238,126,1.498,143,2.873]],["description/31",[3,0.763,6,0.763,9,1.771,22,1.502,23,1.325,26,1.665,27,0.589,29,1.903,32,1.665,44,1.155,51,1.99,58,1.502,92,1.771,120,2.08,126,1.874,133,1.771,142,1.903,144,2.349,145,1.903,146,1.903,147,2.08]],["title/32",[66,2.176,126,1.794]],["description/32",[3,0.891,6,0.891,9,2.068,23,1.547,26,1.944,27,0.687,32,1.944,44,1.348,57,1.842,58,1.754,66,2.044,126,1.686,133,2.068,142,2.222,145,2.222,146,2.222,147,2.429]],["title/33",[18,2.466,19,1.999,20,1.513,126,1.286]],["description/33",[6,1.284,10,0.95,13,0.905,19,0.865,22,0.905,23,1.395,24,1.865,48,1.581,49,1.003,50,1.067,67,0.618,68,1.253,69,1.146,70,0.905,71,1.146,72,1.146,73,1.146,74,1.146,82,0.95,126,0.972,131,1.146,143,1.865,148,1.415,149,1.253,150,1.415,151,1.415,152,2.474,153,1.415,154,1.415,155,1.415,156,1.415,157,1.415,158,1.253,159,1.415,160,1.253,161,1.415,162,1.415,163,1.415]],["title/34",[6,1.238,54,1.873,126,1.498]],["description/34",[6,1.437,9,1.588,13,1.347,23,1.188,26,1.494,27,0.528,45,1.347,54,1.706,56,1.707,57,1.415,58,1.347,59,1.347,60,1.236,61,1.288,62,1.957,63,1.288,64,0.7,126,1.364,145,1.707,146,1.707,164,1.866,165,2.107,166,2.107]],["title/35",[54,2.244,126,1.794]],["description/35",[6,0.955,45,1.88,54,1.445,56,2.382,57,1.974,58,1.88,59,1.88,60,1.724,61,1.797,62,2.552,63,1.797,64,0.977,126,1.779,164,2.603,167,2.94]],["title/36",[107,2.897,126,1.286,168,2.897,169,3.271]],["description/36",[1,1.945,6,0.742,33,1.619,49,1.619,54,1.123,82,1.533,108,2.022,112,2.022,126,2.115,133,1.721,134,3.281,138,1.85,168,2.022,170,2.284,171,2.284,172,2.284,173,2.284,174,2.284,175,1.396,176,2.284]],["title/37",[177,5.038]],["description/37",[2,0.966,32,0.909,46,0.966,82,0.861,86,1.837,135,1.135,158,1.135,177,2.008,178,2.268,179,3.05,180,1.135,181,1.282,182,2.471,183,0.82,184,1.282,185,0.651,186,1.282,187,1.282,188,2.162,189,1.282,190,1.282,191,1.837,192,1.282,193,1.282,194,1.282,195,1.282,196,1.282,197,1.548,198,1.282,199,1.282,200,1.282,201,1.282,202,1.282,203,1.282,204,2.268,205,1.282,206,1.282,207,1.282,208,0.966,209,1.282]],["title/38",[46,3.441,188,3.236]],["description/38",[46,3.664,86,3.938,182,3.938,188,4.609,210,4.861]],["title/39",[188,3.236,211,4.565]],["description/39",[182,3.938,191,3.938,208,3.664,212,4.861,213,4.861,214,4.861]],["title/40",[215,5.038]],["description/40",[175,2.656,188,3.079,191,3.52,215,3.847,216,4.345,217,4.345,218,4.345,219,4.345]],["title/41",[35,3.236,220,2.317]],["description/41",[35,3.91,220,3.585,221,5.516]],["title/42",[175,3.478]],["description/42",[1,3.346,175,3.897]],["title/43",[3,1.483,175,2.79]],["description/43",[3,1.071,22,2.107,32,2.336,105,2.918,175,3.016,208,2.484,222,2.669,223,3.295,224,4.934,225,3.295,226,3.295,227,2.918]],["title/44",[143,3.441,175,2.79]],["description/44",[12,3.319,33,2.656,143,2.825,149,3.319,160,3.319,175,2.291,208,2.825,227,3.319,228,3.748,229,3.748,230,3.748]],["title/45",[20,2.632]],["description/45",[1,3.346,20,2.949]],["title/46",[20,2.112,127,2.481]],["description/46",[3,1.679,20,3.132,127,2.809,231,5.167]],["title/47",[0,1.89,20,2.112]],["description/47",[0,2.283,3,1.792,20,2.552,232,4.884]],["title/48",[20,2.112,233,4.042]],["description/48",[20,2.736,232,5.237,233,5.237]],["title/49",[0,1.578,20,1.763,234,3.811]],["description/49",[0,2.283,3,1.792,20,2.552,235,5.516]],["title/50",[236,3.441,237,1.589]],["description/50",[1,3.104,236,4.458,237,2.059]],["title/51",[238,5.69]],["description/51",[27,1.382,239,1.604,240,1.604,241,5.516]],["title/52",[242,5.038]],["description/52",[27,1.382,239,1.604,240,1.604,243,4.884]],["title/53",[237,1.327,244,2.071,245,2.701]],["description/53",[3,1.679,64,1.718,245,3.663,246,3.663,247,3.895]],["title/54",[67,1.665,237,1.327,245,2.701]],["description/54",[247,5.211]],["title/55",[51,2,237,1.327,245,2.701]],["description/55",[247,5.211]],["title/56",[66,1.816,237,1.327,245,2.701]],["description/56",[247,5.211]],["title/57",[127,2.481,183,2.918]],["description/57",[3,1.792,183,3.526,236,4.158,248,4.884]],["title/58",[51,1.717,70,2.091,183,2.091,236,2.466]],["description/58",[248,6.122]],["title/59",[183,2.918,244,2.481]],["description/59",[3,1.922,183,3.781,249,5.237]],["title/60",[66,2.176,183,2.918]],["description/60",[249,6.122]],["title/61",[237,1.589,250,2.317]],["description/61",[48,1.697,62,1.497,64,1.389,127,1.442,251,2.35,252,2.35,253,2.35,254,2.35,255,2.35,256,2.35,257,2.35,258,2.35,259,2.35,260,2.35,261,2.35,262,2.35,263,2.35,264,2.654,265,2.35]],["title/62",[266,5.69]],["description/62",[27,1.382,239,1.604,240,1.604,267,5.516]],["title/63",[268,5.69]],["description/63",[27,1.382,239,1.604,240,1.604,269,5.516]],["title/64",[270,5.038]],["description/64",[27,1.382,239,1.604,240,1.604,271,4.884]],["title/65",[272,5.038]],["description/65",[27,1.382,239,1.604,240,1.604,273,4.884]],["title/66",[274,5.038]],["description/66",[27,1.382,239,1.604,240,1.604,275,4.884]],["title/67",[276,5.038]],["description/67",[27,1.382,239,1.604,240,1.604,277,4.884]],["title/68",[278,5.038]],["description/68",[27,1.382,239,1.604,240,1.604,279,4.884]],["title/69",[280,5.038]],["description/69",[27,1.382,239,1.604,240,1.604,281,4.884]],["title/70",[282,5.038]],["description/70",[27,1.382,239,1.604,240,1.604,283,4.884]],["title/71",[284,5.038]],["description/71",[27,1.382,239,1.604,240,1.604,285,4.884]],["title/72",[286,5.038]],["description/72",[27,1.382,239,1.604,240,1.604,287,4.884]],["title/73",[288,5.038]],["description/73",[27,1.382,239,1.604,240,1.604,289,4.884]],["title/74",[242,5.038]],["description/74",[27,1.382,239,1.604,240,1.604,243,4.884]],["title/75",[290,5.038]],["description/75",[27,1.382,239,1.604,240,1.604,291,4.884]],["title/76",[292,5.038]],["description/76",[27,1.382,239,1.604,240,1.604,293,4.884]],["title/77",[294,5.038]],["description/77",[27,1.382,239,1.604,240,1.604,295,4.884]],["title/78",[127,2.071,237,1.327,250,1.934]],["description/78",[3,1.579,64,1.616,246,3.445,250,2.467,296,4.304,297,4.861]],["title/79",[237,1.327,244,2.071,250,1.934]],["description/79",[3,0.991,10,2.047,64,1.547,237,1.062,246,2.162,250,1.548,298,2.7,299,2.7,300,2.299,301,2.7,302,2.7,303,2.7,304,2.7,305,2.7,306,2.299]],["title/80",[67,1.665,237,1.327,250,1.934]],["description/80",[10,1.842,64,1.755,70,1.754,92,2.068,180,2.429,237,0.955,250,1.392,298,2.429,299,2.429,300,2.068,301,2.429,302,2.429,303,2.429,304,2.429,305,2.429,306,2.068,307,2.743]],["title/81",[51,2,237,1.327,250,1.934]],["description/81",[306,5.211]],["title/82",[66,1.816,237,1.327,250,1.934]],["description/82",[306,5.211]],["title/83",[237,1.139,244,1.778,250,1.66,308,2.466]],["description/83",[309,6.122]],["title/84",[67,1.429,237,1.139,250,1.66,308,2.466]],["description/84",[309,6.122]],["title/85",[127,2.071,185,1.934,197,1.934]],["description/85",[3,1.792,185,2.8,197,2.8,310,4.884]],["title/86",[51,1.717,70,2.091,185,1.66,197,1.66]],["description/86",[310,6.122]],["title/87",[185,1.934,197,1.934,244,2.071]],["description/87",[3,1.792,185,2.8,197,2.8,311,4.884]],["title/88",[66,1.816,185,1.934,197,1.934]],["description/88",[311,6.122]],["title/89",[237,1.139,244,1.778,250,1.66,300,2.466]],["description/89",[3,1.276,64,1.305,138,3.182,220,1.994,246,2.784,250,1.994,300,2.961,312,3.928,313,3.928,314,3.928]],["title/90",[220,2.317,237,1.589]],["description/90",[48,1.697,62,1.497,64,1.389,127,1.442,251,2.35,252,2.35,253,2.35,254,2.35,255,2.35,256,2.35,257,2.35,258,2.35,259,2.35,260,2.35,261,2.35,262,2.35,263,2.35,265,2.35,315,2.654]],["title/91",[316,5.69]],["description/91",[27,1.382,239,1.604,240,1.604,317,5.516]],["title/92",[318,5.69]],["description/92",[27,1.382,239,1.604,240,1.604,319,5.516]],["title/93",[270,5.038]],["description/93",[27,1.382,239,1.604,240,1.604,271,4.884]],["title/94",[272,5.038]],["description/94",[27,1.382,239,1.604,240,1.604,273,4.884]],["title/95",[274,5.038]],["description/95",[27,1.382,239,1.604,240,1.604,275,4.884]],["title/96",[276,5.038]],["description/96",[27,1.382,239,1.604,240,1.604,277,4.884]],["title/97",[278,5.038]],["description/97",[27,1.382,239,1.604,240,1.604,279,4.884]],["title/98",[280,5.038]],["description/98",[27,1.382,239,1.604,240,1.604,281,4.884]],["title/99",[282,5.038]],["description/99",[27,1.382,239,1.604,240,1.604,283,4.884]],["title/100",[284,5.038]],["description/100",[27,1.382,239,1.604,240,1.604,285,4.884]],["title/101",[286,5.038]],["description/101",[27,1.382,239,1.604,240,1.604,287,4.884]],["title/102",[288,5.038]],["description/102",[27,1.382,239,1.604,240,1.604,289,4.884]],["title/103",[290,5.038]],["description/103",[27,1.382,239,1.604,240,1.604,291,4.884]],["title/104",[292,5.038]],["description/104",[27,1.382,239,1.604,240,1.604,293,4.884]],["title/105",[294,5.038]],["description/105",[27,1.382,239,1.604,240,1.604,295,4.884]],["title/106",[127,2.071,220,1.934,237,1.327]],["description/106",[3,1.679,64,1.718,220,2.623,296,4.576,320,5.167]],["title/107",[220,1.934,237,1.327,244,2.071]],["description/107",[3,1.679,64,1.718,220,2.623,246,3.663,321,3.895]],["title/108",[67,1.665,220,1.934,237,1.327]],["description/108",[321,5.211]],["title/109",[51,2,220,1.934,237,1.327]],["description/109",[321,5.211]],["title/110",[66,1.816,220,1.934,237,1.327]],["description/110",[321,5.211]],["title/111",[220,1.66,237,1.139,244,1.778,308,2.466]],["description/111",[322,6.122]],["title/112",[67,1.429,220,1.66,237,1.139,308,2.466]],["description/112",[322,6.122]],["title/113",[127,2.071,185,1.934,197,1.934]],["description/113",[3,1.792,185,2.8,197,2.8,323,4.884]],["title/114",[51,1.717,70,2.091,185,1.66,197,1.66]],["description/114",[323,6.122]],["title/115",[185,1.934,197,1.934,244,2.071]],["description/115",[3,1.792,185,2.8,197,2.8,324,4.884]],["title/116",[66,1.816,185,1.934,197,1.934]],["description/116",[324,6.122]],["title/117",[116,2.317,237,1.589]],["description/117",[33,3.445,64,1.616,116,2.467,222,3.938,325,4.304,326,4.304]],["title/118",[327,5.69]],["description/118",[27,1.382,239,1.604,240,1.604,328,5.516]],["title/119",[64,1.267,116,1.934,244,2.071]],["description/119",[329,5.211]],["title/120",[64,1.267,67,1.665,116,1.934]],["description/120",[329,5.211]],["title/121",[51,2,64,1.267,116,1.934]],["description/121",[329,5.211]],["title/122",[64,1.267,66,1.816,116,1.934]],["description/122",[329,5.211]],["title/123",[123,2.574,237,1.589]],["description/123",[33,3.445,64,1.616,123,2.741,222,3.938,325,4.304,326,4.304]],["title/124",[330,5.69]],["description/124",[27,1.382,239,1.604,240,1.604,331,5.516]],["title/125",[64,1.267,123,2.149,244,2.071]],["description/125",[332,5.211]],["title/126",[64,1.267,67,1.665,123,2.149]],["description/126",[332,5.211]],["title/127",[51,2,64,1.267,123,2.149]],["description/127",[332,5.211]],["title/128",[64,1.267,66,1.816,123,2.149]],["description/128",[332,5.211]]],"invertedIndex":[["",{"_index":27,"title":{},"description":{"2":{},"12":{},"15":{},"22":{},"31":{},"32":{},"34":{},"51":{},"52":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"104":{},"105":{},"118":{},"124":{}}}],["200",{"_index":151,"title":{},"description":{"33":{}}}],["409",{"_index":147,"title":{},"description":{"31":{},"32":{}}}],["_byo_",{"_index":63,"title":{},"description":{"5":{},"6":{},"15":{},"16":{},"17":{},"19":{},"34":{},"35":{}}}],["_live_",{"_index":61,"title":{},"description":{"5":{},"6":{},"15":{},"16":{},"17":{},"19":{},"34":{},"35":{}}}],["access",{"_index":185,"title":{"85":{},"86":{},"87":{},"88":{},"113":{},"114":{},"115":{},"116":{}},"description":{"37":{},"85":{},"87":{},"113":{},"115":{}}}],["accessconfig",{"_index":274,"title":{"66":{},"95":{}},"description":{}}],["accordingli",{"_index":109,"title":{},"description":{"17":{}}}],["ad",{"_index":163,"title":{},"description":{"33":{}}}],["add",{"_index":143,"title":{"31":{},"44":{}},"description":{"33":{},"44":{}}}],["addition",{"_index":59,"title":{},"description":{"5":{},"6":{},"15":{},"16":{},"17":{},"34":{},"35":{}}}],["address",{"_index":255,"title":{},"description":{"61":{},"90":{}}}],["admin",{"_index":195,"title":{},"description":{"37":{}}}],["adminaccessconfig",{"_index":270,"title":{"64":{},"93":{}},"description":{}}],["administr",{"_index":184,"title":{},"description":{"37":{}}}],["aem",{"_index":207,"title":{},"description":{"37":{}}}],["aggreg",{"_index":300,"title":{"89":{}},"description":{"79":{},"80":{},"89":{}}}],["allow",{"_index":132,"title":{},"description":{"29":{}}}],["altern",{"_index":202,"title":{},"description":{"37":{}}}],["alway",{"_index":78,"title":{},"description":{"7":{},"12":{}}}],["api",{"_index":178,"title":{},"description":{"37":{}}}],["api_key",{"_index":204,"title":{},"description":{"37":{}}}],["application/json",{"_index":156,"title":{},"description":{"33":{}}}],["appropri",{"_index":155,"title":{},"description":{"33":{}}}],["approv",{"_index":170,"title":{},"description":{"36":{}}}],["array",{"_index":149,"title":{},"description":{"33":{},"44":{}}}],["assum",{"_index":28,"title":{},"description":{"2":{},"12":{}}}],["asynchron",{"_index":50,"title":{},"description":{"2":{},"7":{},"12":{},"33":{}}}],["auth",{"_index":196,"title":{},"description":{"37":{}}}],["auth_token",{"_index":199,"title":{},"description":{"37":{}}}],["authent",{"_index":177,"title":{"37":{}},"description":{"37":{}}}],["author",{"_index":203,"title":{},"description":{"37":{}}}],["auto",{"_index":211,"title":{"39":{}},"description":{}}],["avail",{"_index":210,"title":{},"description":{"38":{}}}],["back",{"_index":194,"title":{},"description":{"37":{}}}],["base",{"_index":301,"title":{},"description":{"79":{},"80":{}}}],["batch",{"_index":105,"title":{"17":{}},"description":{"43":{}}}],["be",{"_index":162,"title":{},"description":{"33":{}}}],["below",{"_index":120,"title":{},"description":{"22":{},"31":{}}}],["bodi",{"_index":160,"title":{},"description":{"33":{},"44":{}}}],["br",{"_index":259,"title":{},"description":{"61":{},"90":{}}}],["br><br",{"_index":201,"title":{},"description":{"37":{}}}],["browser",{"_index":189,"title":{},"description":{"37":{}}}],["bu",{"_index":97,"title":{"14":{}},"description":{"13":{},"14":{}}}],["bulk",{"_index":19,"title":{"2":{},"7":{},"12":{},"33":{}},"description":{"2":{},"7":{},"12":{},"33":{}}}],["byom",{"_index":91,"title":{},"description":{"10":{}}}],["cach",{"_index":111,"title":{"18":{},"19":{}},"description":{"18":{}}}],["cache/{owner}/{repo}/{ref}/{path",{"_index":115,"title":{},"description":{"19":{}}}],["call",{"_index":12,"title":{},"description":{"1":{},"44":{}}}],["cdn",{"_index":62,"title":{},"description":{"5":{},"6":{},"15":{},"16":{},"17":{},"19":{},"34":{},"35":{},"61":{},"90":{}}}],["cdnconfig",{"_index":276,"title":{"67":{},"96":{}},"description":{}}],["chang",{"_index":107,"title":{"36":{}},"description":{"17":{}}}],["clear",{"_index":171,"title":{},"description":{"36":{}}}],["code",{"_index":96,"title":{"13":{},"14":{},"15":{},"16":{},"17":{}},"description":{"13":{},"14":{},"16":{}}}],["code-bu",{"_index":99,"title":{},"description":{"15":{},"16":{},"17":{}}}],["code/{owner}/{repo}/{ref",{"_index":110,"title":{},"description":{"17":{}}}],["code/{owner}/{repo}/{ref}/{path",{"_index":98,"title":{},"description":{"14":{},"15":{},"16":{}}}],["code>/config/{org}/profiles/default-profile/cdn/prod.json</cod",{"_index":315,"title":{},"description":{"90":{}}}],["code>/config/{org}/sites/{site}/cdn/prod.json</cod",{"_index":264,"title":{},"description":{"61":{}}}],["codeconfig",{"_index":278,"title":{"68":{},"97":{}},"description":{}}],["combin",{"_index":42,"title":{},"description":{"2":{}}}],["config",{"_index":237,"title":{"50":{},"53":{},"54":{},"55":{},"56":{},"61":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"89":{},"90":{},"106":{},"107":{},"108":{},"109":{},"110":{},"111":{},"112":{},"117":{},"123":{}},"description":{"50":{},"79":{},"80":{}}}],["config/{org}.json",{"_index":247,"title":{},"description":{"53":{},"54":{},"55":{},"56":{}}}],["config/{org}/aggregated/{site}.json",{"_index":314,"title":{},"description":{"89":{}}}],["config/{org}/profiles.json",{"_index":320,"title":{},"description":{"106":{}}}],["config/{org}/profiles/{profile}.json",{"_index":321,"title":{},"description":{"107":{},"108":{},"109":{},"110":{}}}],["config/{org}/profiles/{profile}/robots.txt",{"_index":322,"title":{},"description":{"111":{},"112":{}}}],["config/{org}/profiles/{profile}/tokens.json",{"_index":323,"title":{},"description":{"113":{},"114":{}}}],["config/{org}/profiles/{profile}/tokens/${id}.json",{"_index":324,"title":{},"description":{"115":{},"116":{}}}],["config/{org}/sites.json",{"_index":297,"title":{},"description":{"78":{}}}],["config/{org}/sites/{site}.json",{"_index":306,"title":{},"description":{"79":{},"80":{},"81":{},"82":{}}}],["config/{org}/sites/{site}/content/query.yaml",{"_index":329,"title":{},"description":{"119":{},"120":{},"121":{},"122":{}}}],["config/{org}/sites/{site}/content/sitemap.yaml",{"_index":332,"title":{},"description":{"125":{},"126":{},"127":{},"128":{}}}],["config/{org}/sites/{site}/robots.txt",{"_index":309,"title":{},"description":{"83":{},"84":{}}}],["config/{org}/sites/{site}/tokens.json",{"_index":310,"title":{},"description":{"85":{},"86":{}}}],["config/{org}/sites/{site}/tokens/${id}.json",{"_index":311,"title":{},"description":{"87":{},"88":{}}}],["config/{org}/users.json",{"_index":248,"title":{},"description":{"57":{},"58":{}}}],["config/{org}/users/${id}.json",{"_index":249,"title":{},"description":{"59":{},"60":{}}}],["configur",{"_index":64,"title":{"119":{},"120":{},"121":{},"122":{},"125":{},"126":{},"127":{},"128":{}},"description":{"5":{},"6":{},"7":{},"12":{},"15":{},"16":{},"17":{},"19":{},"34":{},"35":{},"53":{},"61":{},"78":{},"79":{},"80":{},"89":{},"90":{},"106":{},"107":{},"117":{},"123":{}}}],["contain",{"_index":33,"title":{},"description":{"2":{},"36":{},"44":{},"117":{},"123":{}}}],["content",{"_index":13,"title":{},"description":{"1":{},"5":{},"6":{},"10":{},"15":{},"33":{},"34":{}}}],["content-bu",{"_index":57,"title":{},"description":{"5":{},"6":{},"11":{},"32":{},"34":{},"35":{}}}],["contentconfig",{"_index":280,"title":{"69":{},"98":{}},"description":{}}],["cooki",{"_index":198,"title":{},"description":{"37":{}}}],["copi",{"_index":56,"title":{},"description":{"5":{},"34":{},"35":{}}}],["correspond",{"_index":212,"title":{},"description":{"39":{}}}],["creat",{"_index":51,"title":{"55":{},"58":{},"81":{},"86":{},"109":{},"114":{},"121":{},"127":{}},"description":{"2":{},"7":{},"12":{},"31":{}}}],["current",{"_index":217,"title":{},"description":{"40":{}}}],["default",{"_index":69,"title":{},"description":{"7":{},"12":{},"33":{}}}],["definit",{"_index":326,"title":{},"description":{"117":{},"123":{}}}],["delet",{"_index":66,"title":{"11":{},"16":{},"32":{},"56":{},"60":{},"82":{},"88":{},"110":{},"116":{},"122":{},"128":{}},"description":{"6":{},"11":{},"16":{},"32":{}}}],["destin",{"_index":124,"title":{},"description":{"25":{}}}],["detail",{"_index":234,"title":{"49":{}},"description":{}}],["directli",{"_index":256,"title":{},"description":{"61":{},"90":{}}}],["directori",{"_index":104,"title":{},"description":{"15":{}}}],["display",{"_index":221,"title":{},"description":{"41":{}}}],["doc",{"_index":90,"title":{},"description":{"10":{}}}],["document",{"_index":258,"title":{},"description":{"61":{},"90":{}}}],["dure",{"_index":80,"title":{},"description":{"7":{},"12":{}}}],["e.g",{"_index":87,"title":{},"description":{"10":{}}}],["edit",{"_index":43,"title":{},"description":{"2":{}}}],["edit=auto",{"_index":7,"title":{},"description":{"1":{}}}],["end",{"_index":26,"title":{},"description":{"2":{},"12":{},"31":{},"32":{},"34":{}}}],["endpoint",{"_index":265,"title":{},"description":{"61":{},"90":{}}}],["entir",{"_index":145,"title":{},"description":{"31":{},"32":{},"34":{}}}],["entri",{"_index":230,"title":{},"description":{"44":{}}}],["etc",{"_index":305,"title":{},"description":{"79":{},"80":{}}}],["even",{"_index":257,"title":{},"description":{"61":{},"90":{}}}],["event",{"_index":108,"title":{},"description":{"17":{},"36":{}}}],["exampl",{"_index":260,"title":{},"description":{"61":{},"90":{}}}],["exist",{"_index":180,"title":{},"description":{"37":{},"80":{}}}],["explicit",{"_index":253,"title":{},"description":{"61":{},"90":{}}}],["fetch",{"_index":21,"title":{},"description":{"2":{},"10":{},"15":{}}}],["fewer",{"_index":150,"title":{},"description":{"33":{}}}],["file",{"_index":75,"title":{},"description":{"7":{},"12":{}}}],["filter",{"_index":40,"title":{},"description":{"2":{}}}],["flow",{"_index":186,"title":{},"description":{"37":{}}}],["folder",{"_index":29,"title":{},"description":{"2":{},"12":{},"31":{}}}],["foldersconfig",{"_index":282,"title":{"70":{},"99":{}},"description":{}}],["folliow",{"_index":34,"title":{},"description":{"2":{}}}],["forceupd",{"_index":73,"title":{},"description":{"7":{},"12":{},"33":{}}}],["format",{"_index":229,"title":{},"description":{"44":{}}}],["fstab",{"_index":303,"title":{},"description":{"79":{},"80":{}}}],["gener",{"_index":2,"title":{"1":{},"25":{}},"description":{"25":{},"37":{}}}],["github",{"_index":100,"title":{},"description":{"15":{}}}],["googl",{"_index":89,"title":{},"description":{"10":{}}}],["groupsconfig",{"_index":242,"title":{"52":{},"74":{}},"description":{}}],["header",{"_index":158,"title":{},"description":{"33":{},"37":{}}}],["headersconfig",{"_index":284,"title":{"71":{},"100":{}},"description":{}}],["helix/config",{"_index":76,"title":{},"description":{"7":{},"12":{}}}],["helix/config.xlsx",{"_index":304,"title":{},"description":{"79":{},"80":{}}}],["hook",{"_index":114,"title":{},"description":{"19":{}}}],["https://www.aem.live/docs/limits#rate-limits-number-of-preview-operations-per-tim",{"_index":16,"title":{},"description":{"1":{}}}],["id",{"_index":128,"title":{},"description":{"27":{}}}],["ident",{"_index":181,"title":{},"description":{"37":{}}}],["idp",{"_index":182,"title":{},"description":{"37":{},"38":{},"39":{}}}],["ignor",{"_index":79,"title":{},"description":{"7":{},"12":{}}}],["includ",{"_index":138,"title":{},"description":{"29":{},"36":{},"89":{}}}],["index",{"_index":116,"title":{"20":{},"21":{},"23":{},"117":{},"119":{},"120":{},"121":{},"122":{}},"description":{"20":{},"21":{},"22":{},"23":{},"117":{}}}],["index/{owner}/{repo}/{ref}/{path",{"_index":117,"title":{},"description":{"21":{},"22":{},"23":{}}}],["indexconfig",{"_index":327,"title":{"118":{}},"description":{}}],["inform",{"_index":35,"title":{"41":{}},"description":{"2":{},"7":{},"12":{},"41":{}}}],["inherit",{"_index":312,"title":{},"description":{"89":{}}}],["invok",{"_index":113,"title":{},"description":{"19":{}}}],["job",{"_index":20,"title":{"2":{},"7":{},"12":{},"33":{},"45":{},"46":{},"47":{},"48":{},"49":{}},"description":{"7":{},"12":{},"45":{},"46":{},"47":{},"48":{},"49":{}}}],["job/{owner}/{repo}/{ref}/{top",{"_index":231,"title":{},"description":{"46":{}}}],["job/{owner}/{repo}/{ref}/{topic}/{jobnam",{"_index":232,"title":{},"description":{"47":{},"48":{}}}],["job/{owner}/{repo}/{ref}/{topic}/{jobname}/detail",{"_index":235,"title":{},"description":{"49":{}}}],["job](#tag/job",{"_index":52,"title":{},"description":{"2":{}}}],["json",{"_index":228,"title":{},"description":{"44":{}}}],["last",{"_index":101,"title":{},"description":{"15":{},"22":{}}}],["latest",{"_index":85,"title":{},"description":{"10":{},"15":{}}}],["lead",{"_index":209,"title":{},"description":{"37":{}}}],["legaci",{"_index":302,"title":{},"description":{"79":{},"80":{}}}],["level",{"_index":246,"title":{},"description":{"53":{},"78":{},"79":{},"89":{},"107":{}}}],["link",{"_index":225,"title":{},"description":{"43":{}}}],["list",{"_index":127,"title":{"27":{},"46":{},"57":{},"78":{},"85":{},"106":{},"113":{}},"description":{"27":{},"46":{},"61":{},"90":{}}}],["live",{"_index":45,"title":{"19":{}},"description":{"2":{},"5":{},"6":{},"7":{},"34":{},"35":{}}}],["live/{owner}/{repo}/{ref",{"_index":83,"title":{},"description":{"7":{}}}],["live/{owner}/{repo}/{ref}/{path",{"_index":55,"title":{},"description":{"4":{},"5":{},"6":{}}}],["live:writ",{"_index":141,"title":{},"description":{"29":{}}}],["load",{"_index":226,"title":{},"description":{"43":{}}}],["locat",{"_index":164,"title":{},"description":{"34":{},"35":{}}}],["lock",{"_index":133,"title":{},"description":{"29":{},"31":{},"32":{},"36":{}}}],["log",{"_index":175,"title":{"42":{},"43":{},"44":{}},"description":{"36":{},"40":{},"42":{},"43":{},"44":{}}}],["log/{owner}/{repo}/{ref",{"_index":227,"title":{},"description":{"43":{},"44":{}}}],["login",{"_index":188,"title":{"38":{},"39":{}},"description":{"37":{},"38":{},"40":{}}}],["login/{owner}/{repo}/{ref",{"_index":214,"title":{},"description":{"39":{}}}],["logout",{"_index":215,"title":{"40":{}},"description":{"40":{}}}],["manag",{"_index":262,"title":{},"description":{"61":{},"90":{}}}],["manifest",{"_index":130,"title":{"28":{},"29":{}},"description":{"28":{},"29":{}}}],["messag",{"_index":173,"title":{},"description":{"36":{}}}],["metadataconfig",{"_index":286,"title":{"72":{},"101":{}},"description":{}}],["migrat",{"_index":298,"title":{},"description":{"79":{},"80":{}}}],["modifi",{"_index":71,"title":{},"description":{"7":{},"12":{},"33":{}}}],["more",{"_index":222,"title":{},"description":{"43":{},"117":{},"123":{}}}],["name",{"_index":296,"title":{},"description":{"78":{},"106":{}}}],["need",{"_index":137,"title":{},"description":{"29":{}}}],["new",{"_index":70,"title":{"58":{},"86":{},"114":{}},"description":{"7":{},"12":{},"33":{},"80":{}}}],["next",{"_index":224,"title":{},"description":{"43":{}}}],["note",{"_index":48,"title":{},"description":{"2":{},"7":{},"12":{},"29":{},"33":{},"61":{},"90":{}}}],["object",{"_index":252,"title":{},"description":{"61":{},"90":{}}}],["obtain",{"_index":205,"title":{},"description":{"37":{}}}],["on",{"_index":325,"title":{},"description":{"117":{},"123":{}}}],["open",{"_index":187,"title":{},"description":{"37":{}}}],["oper",{"_index":1,"title":{},"description":{"0":{},"3":{},"8":{},"13":{},"18":{},"20":{},"24":{},"26":{},"36":{},"42":{},"45":{},"50":{}}}],["option",{"_index":112,"title":{},"description":{"19":{},"36":{}}}],["order",{"_index":135,"title":{},"description":{"29":{},"37":{}}}],["org",{"_index":236,"title":{"50":{},"58":{}},"description":{"50":{},"57":{}}}],["organis",{"_index":245,"title":{"53":{},"54":{},"55":{},"56":{}},"description":{"53":{}}}],["orgconfig",{"_index":238,"title":{"51":{}},"description":{}}],["otherwise.<br",{"_index":153,"title":{},"description":{"33":{}}}],["out",{"_index":216,"title":{},"description":{"40":{}}}],["overal",{"_index":4,"title":{},"description":{"1":{}}}],["overwrit",{"_index":307,"title":{},"description":{"80":{}}}],["page",{"_index":192,"title":{},"description":{"37":{}}}],["param",{"_index":9,"title":{},"description":{"1":{},"31":{},"32":{},"34":{}}}],["paramet",{"_index":174,"title":{},"description":{"36":{}}}],["partit",{"_index":58,"title":{},"description":{"5":{},"6":{},"11":{},"31":{},"32":{},"34":{},"35":{}}}],["pass",{"_index":41,"title":{},"description":{"2":{}}}],["path",{"_index":23,"title":{},"description":{"2":{},"7":{},"12":{},"15":{},"22":{},"25":{},"31":{},"32":{},"33":{},"34":{}}}],["path'",{"_index":165,"title":{},"description":{"34":{}}}],["payload",{"_index":25,"title":{},"description":{"2":{},"12":{}}}],["payload.<br",{"_index":68,"title":{},"description":{"7":{},"33":{}}}],["payload.<br><br",{"_index":47,"title":{},"description":{"2":{}}}],["perform",{"_index":49,"title":{},"description":{"2":{},"7":{},"12":{},"33":{},"36":{}}}],["permiss",{"_index":140,"title":{},"description":{"29":{}}}],["pleas",{"_index":251,"title":{},"description":{"61":{},"90":{}}}],["possibl",{"_index":39,"title":{},"description":{"2":{}}}],["preview",{"_index":44,"title":{"8":{},"9":{},"10":{},"11":{},"12":{}},"description":{"2":{},"5":{},"8":{},"9":{},"10":{},"11":{},"12":{},"31":{},"32":{}}}],["preview.<br",{"_index":94,"title":{},"description":{"12":{}}}],["preview/{owner}/{repo}/{ref",{"_index":95,"title":{},"description":{"12":{}}}],["preview/{owner}/{repo}/{ref}/{path",{"_index":84,"title":{},"description":{"9":{},"10":{},"11":{}}}],["preview:writ",{"_index":139,"title":{},"description":{"29":{}}}],["previewed.<br",{"_index":93,"title":{},"description":{"12":{}}}],["previewlastmodifi",{"_index":37,"title":{},"description":{"2":{}}}],["process",{"_index":106,"title":{},"description":{"17":{}}}],["processed.<br><br",{"_index":31,"title":{},"description":{"2":{}}}],["product",{"_index":261,"title":{},"description":{"61":{},"90":{}}}],["profil",{"_index":220,"title":{"41":{},"90":{},"106":{},"107":{},"108":{},"109":{},"110":{},"111":{},"112":{}},"description":{"41":{},"89":{},"106":{},"107":{}}}],["profileconfig",{"_index":316,"title":{"91":{}},"description":{}}],["profileconfiglist",{"_index":318,"title":{"92":{}},"description":{}}],["project",{"_index":208,"title":{},"description":{"37":{},"39":{},"43":{},"44":{}}}],["properti",{"_index":24,"title":{},"description":{"2":{},"7":{},"12":{},"33":{}}}],["provid",{"_index":86,"title":{},"description":{"10":{},"37":{},"38":{}}}],["publicconfig",{"_index":288,"title":{"73":{},"102":{}},"description":{}}],["publish",{"_index":54,"title":{"3":{},"4":{},"5":{},"7":{},"34":{},"35":{}},"description":{"3":{},"4":{},"5":{},"7":{},"22":{},"34":{},"35":{},"36":{}}}],["publish.<br",{"_index":81,"title":{},"description":{"7":{}}}],["publishlastmodifi",{"_index":38,"title":{},"description":{"2":{}}}],["purg",{"_index":60,"title":{"19":{}},"description":{"5":{},"6":{},"15":{},"16":{},"17":{},"19":{},"34":{},"35":{}}}],["queri",{"_index":8,"title":{},"description":{"1":{}}}],["re-index",{"_index":118,"title":{"22":{}},"description":{}}],["read",{"_index":244,"title":{"53":{},"59":{},"79":{},"83":{},"87":{},"89":{},"107":{},"111":{},"115":{},"119":{},"125":{}},"description":{}}],["recurs",{"_index":30,"title":{},"description":{"2":{},"12":{},"15":{},"22":{}}}],["redirect",{"_index":191,"title":{},"description":{"37":{},"39":{},"40":{}}}],["redirects.json",{"_index":77,"title":{},"description":{"7":{},"12":{}}}],["reindex",{"_index":119,"title":{},"description":{"22":{}}}],["reject",{"_index":172,"title":{},"description":{"36":{}}}],["remov",{"_index":122,"title":{"23":{}},"description":{"23":{}}}],["request",{"_index":82,"title":{},"description":{"7":{},"12":{},"29":{},"33":{},"36":{},"37":{}}}],["requir",{"_index":11,"title":{},"description":{"1":{}}}],["resourc",{"_index":6,"title":{"5":{},"6":{},"22":{},"23":{},"31":{},"34":{}},"description":{"1":{},"2":{},"4":{},"5":{},"6":{},"7":{},"9":{},"10":{},"11":{},"12":{},"14":{},"15":{},"16":{},"19":{},"21":{},"22":{},"23":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{}}}],["respect",{"_index":5,"title":{},"description":{"1":{},"4":{},"9":{},"14":{},"15":{},"19":{},"21":{},"30":{}}}],["respons",{"_index":32,"title":{},"description":{"2":{},"31":{},"32":{},"37":{},"43":{}}}],["result",{"_index":161,"title":{},"description":{"33":{}}}],["return",{"_index":3,"title":{"43":{}},"description":{"1":{},"2":{},"4":{},"7":{},"9":{},"12":{},"14":{},"21":{},"27":{},"28":{},"30":{},"31":{},"32":{},"43":{},"46":{},"47":{},"49":{},"53":{},"57":{},"59":{},"78":{},"79":{},"85":{},"87":{},"89":{},"106":{},"107":{},"113":{},"115":{}}}],["review",{"_index":168,"title":{"36":{}},"description":{"36":{}}}],["robots.txt",{"_index":308,"title":{"83":{},"84":{},"111":{},"112":{}},"description":{}}],["robotsconfig",{"_index":290,"title":{"75":{},"103":{}},"description":{}}],["role",{"_index":136,"title":{},"description":{"29":{}}}],["schema",{"_index":254,"title":{},"description":{"61":{},"90":{}}}],["schemadefinit",{"_index":239,"title":{},"description":{"51":{},"52":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"104":{},"105":{},"118":{},"124":{}}}],["schemaref=\"#/components/schemas/accessconfig",{"_index":275,"title":{},"description":{"66":{},"95":{}}}],["schemaref=\"#/components/schemas/adminaccessconfig",{"_index":271,"title":{},"description":{"64":{},"93":{}}}],["schemaref=\"#/components/schemas/cdnconfig",{"_index":277,"title":{},"description":{"67":{},"96":{}}}],["schemaref=\"#/components/schemas/codeconfig",{"_index":279,"title":{},"description":{"68":{},"97":{}}}],["schemaref=\"#/components/schemas/contentconfig",{"_index":281,"title":{},"description":{"69":{},"98":{}}}],["schemaref=\"#/components/schemas/foldersconfig",{"_index":283,"title":{},"description":{"70":{},"99":{}}}],["schemaref=\"#/components/schemas/groupsconfig",{"_index":243,"title":{},"description":{"52":{},"74":{}}}],["schemaref=\"#/components/schemas/headersconfig",{"_index":285,"title":{},"description":{"71":{},"100":{}}}],["schemaref=\"#/components/schemas/indexconfig",{"_index":328,"title":{},"description":{"118":{}}}],["schemaref=\"#/components/schemas/metadataconfig",{"_index":287,"title":{},"description":{"72":{},"101":{}}}],["schemaref=\"#/components/schemas/orgconfig",{"_index":241,"title":{},"description":{"51":{}}}],["schemaref=\"#/components/schemas/profileconfig",{"_index":317,"title":{},"description":{"91":{}}}],["schemaref=\"#/components/schemas/profileconfiglist",{"_index":319,"title":{},"description":{"92":{}}}],["schemaref=\"#/components/schemas/publicconfig",{"_index":289,"title":{},"description":{"73":{},"102":{}}}],["schemaref=\"#/components/schemas/robotsconfig",{"_index":291,"title":{},"description":{"75":{},"103":{}}}],["schemaref=\"#/components/schemas/sidekickconfig",{"_index":293,"title":{},"description":{"76":{},"104":{}}}],["schemaref=\"#/components/schemas/siteaccessconfig",{"_index":273,"title":{},"description":{"65":{},"94":{}}}],["schemaref=\"#/components/schemas/siteconfig",{"_index":267,"title":{},"description":{"62":{}}}],["schemaref=\"#/components/schemas/siteconfiglist",{"_index":269,"title":{},"description":{"63":{}}}],["schemaref=\"#/components/schemas/sitemapconfig",{"_index":331,"title":{},"description":{"124":{}}}],["schemaref=\"#/components/schemas/tokensconfig",{"_index":295,"title":{},"description":{"77":{},"105":{}}}],["screen",{"_index":219,"title":{},"description":{"40":{}}}],["see",{"_index":15,"title":{},"description":{"1":{}}}],["segment",{"_index":102,"title":{},"description":{"15":{},"22":{}}}],["select",{"_index":46,"title":{"38":{}},"description":{"2":{},"37":{},"38":{}}}],["session",{"_index":218,"title":{},"description":{"40":{}}}],["set",{"_index":10,"title":{},"description":{"1":{},"7":{},"12":{},"33":{},"79":{},"80":{}}}],["setup",{"_index":213,"title":{},"description":{"39":{}}}],["sharepoint",{"_index":88,"title":{},"description":{"10":{}}}],["showwriteonly={tru",{"_index":240,"title":{},"description":{"51":{},"52":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"104":{},"105":{},"118":{},"124":{}}}],["sidekickconfig",{"_index":292,"title":{"76":{},"104":{}},"description":{}}],["site",{"_index":250,"title":{"61":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"89":{}},"description":{"78":{},"79":{},"80":{},"89":{}}}],["siteaccessconfig",{"_index":272,"title":{"65":{},"94":{}},"description":{}}],["siteconfig",{"_index":266,"title":{"62":{}},"description":{}}],["siteconfiglist",{"_index":268,"title":{"63":{}},"description":{}}],["sitemap",{"_index":123,"title":{"24":{},"25":{},"123":{},"125":{},"126":{},"127":{},"128":{}},"description":{"24":{},"25":{},"123":{}}}],["sitemap/{owner}/{repo}/{ref}/{path",{"_index":125,"title":{},"description":{"25":{}}}],["sitemapconfig",{"_index":330,"title":{"124":{}},"description":{}}],["snapshot",{"_index":126,"title":{"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{}},"description":{"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{}}}],["snapshot/snapshotid",{"_index":144,"title":{},"description":{"31":{}}}],["snapshot/{owner}/{repo}/main",{"_index":129,"title":{},"description":{"27":{}}}],["snapshot/{owner}/{repo}/main/{snapshotid",{"_index":131,"title":{},"description":{"28":{},"29":{},"33":{}}}],["snapshot/{owner}/{repo}/main/{snapshotid}/{path",{"_index":142,"title":{},"description":{"30":{},"31":{},"32":{}}}],["snapshot/{owner}/{repo}/main/{snapshotid}/{path}?publish=tru",{"_index":166,"title":{},"description":{"34":{}}}],["snapshot/{owner}/{repo}/main/{snapshotid}?publish=tru",{"_index":167,"title":{},"description":{"35":{}}}],["snapshot/{owner}/{repo}/main/{snapshotid}?review=[request,approve,reject",{"_index":176,"title":{},"description":{"36":{}}}],["sourc",{"_index":14,"title":{},"description":{"1":{}}}],["sourcelastmodifi",{"_index":36,"title":{},"description":{"2":{}}}],["specifi",{"_index":22,"title":{},"description":{"2":{},"7":{},"12":{},"25":{},"31":{},"33":{},"43":{}}}],["start",{"_index":18,"title":{"2":{},"7":{},"12":{},"33":{}},"description":{}}],["state",{"_index":169,"title":{"36":{}},"description":{}}],["statu",{"_index":0,"title":{"0":{},"1":{},"2":{},"4":{},"9":{},"14":{},"21":{},"30":{},"47":{},"49":{}},"description":{"0":{},"1":{},"2":{},"4":{},"9":{},"14":{},"21":{},"30":{},"47":{},"49":{}}}],["status/{owner}/{repo}/{ref",{"_index":53,"title":{},"description":{"2":{}}}],["status/{owner}/{repo}/{ref}/{path",{"_index":17,"title":{},"description":{"1":{}}}],["stop",{"_index":233,"title":{"48":{}},"description":{"48":{}}}],["store",{"_index":92,"title":{},"description":{"10":{},"15":{},"31":{},"80":{}}}],["sub",{"_index":121,"title":{},"description":{"22":{}}}],["subsequ",{"_index":200,"title":{},"description":{"37":{}}}],["subtre",{"_index":146,"title":{},"description":{"31":{},"32":{},"34":{}}}],["success",{"_index":193,"title":{},"description":{"37":{}}}],["synchron",{"_index":148,"title":{},"description":{"33":{}}}],["talk",{"_index":206,"title":{},"description":{"37":{}}}],["timespan",{"_index":223,"title":{},"description":{"43":{}}}],["token",{"_index":197,"title":{"85":{},"86":{},"87":{},"88":{},"113":{},"114":{},"115":{},"116":{}},"description":{"37":{},"85":{},"87":{},"113":{},"115":{}}}],["tokensconfig",{"_index":294,"title":{"77":{},"105":{}},"description":{}}],["treat",{"_index":159,"title":{},"description":{"33":{}}}],["tree",{"_index":103,"title":{},"description":{"15":{},"22":{}}}],["true",{"_index":299,"title":{},"description":{"79":{},"80":{}}}],["true`.<br",{"_index":74,"title":{},"description":{"7":{},"12":{},"33":{}}}],["type",{"_index":157,"title":{},"description":{"33":{}}}],["un-publish",{"_index":65,"title":{"6":{}},"description":{"6":{}}}],["unless",{"_index":72,"title":{},"description":{"7":{},"12":{},"33":{}}}],["unlock",{"_index":134,"title":{},"description":{"29":{},"36":{}}}],["updat",{"_index":67,"title":{"10":{},"15":{},"17":{},"29":{},"54":{},"80":{},"84":{},"108":{},"112":{},"120":{},"126":{}},"description":{"7":{},"10":{},"12":{},"15":{},"17":{},"29":{},"33":{}}}],["us",{"_index":179,"title":{},"description":{"37":{}}}],["user",{"_index":183,"title":{"57":{},"58":{},"59":{},"60":{}},"description":{"37":{},"57":{},"59":{}}}],["valu",{"_index":313,"title":{},"description":{"89":{}}}],["via",{"_index":263,"title":{},"description":{"61":{},"90":{}}}],["want",{"_index":190,"title":{},"description":{"37":{}}}],["wildcard",{"_index":152,"title":{},"description":{"33":{}}}],["without",{"_index":154,"title":{},"description":{"33":{}}}]],"pipeline":[]}},"options":{"schemasExpansionLevel":2}};
+      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.1.0","info":{"version":"12.18.1","title":"AEM Admin API","description":"AEM Admin API is used to manage the lifecycle of content and code.","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://admin.hlx.page"}],"tags":[{"name":"status","description":"Status operations"},{"name":"publish","description":"Publish operations"},{"name":"preview","description":"Preview operations"},{"name":"code","description":"Code bus operations"},{"name":"cache","description":"Cache operations"},{"name":"index","description":"Index operations"},{"name":"authentication","description":"The API uses your existing Identity Provider (IDP) to authenticate users with administrative access. The general flow is that you open `/login` in a browser, select the IDP you want to use, and then are redirected to the IDP login page. After successful login, you are redirected back to the Admin API with an auth token in the response cookie (`auth_token`). This token is then used to authenticate all subsequent requests. <br><br> Alternatively, you can provide an `authorization: token $API_KEY` header. In order to obtain an API_KEY, talk to your AEM project lead.\n"},{"name":"sitemap","description":"Sitemap operations"},{"name":"job","description":"Job operations"},{"name":"log","description":"Log operations"},{"name":"snapshot","description":"Snapshot operations"},{"name":"orgConfig","x-displayName":"Org Config","description":"Org Config operations"},{"name":"siteConfig","x-displayName":"Site Config","description":"Please note that most of the configuration objects that have an explicit schema can also be addressed directly, even if not listed in this documentation. <br> For example the production CDN configuration can be managed via the <code>/config/{org}/sites/{site}/cdn/prod.json</code> endpoint.\n"},{"name":"profileConfig","x-displayName":"Profile Config","description":"Please note that most of the configuration objects that have an explicit schema can also be addressed directly, even if not listed in this documentation. <br> For example the production CDN configuration can be managed via the <code>/config/{org}/profiles/default-profile/cdn/prod.json</code> endpoint.\n"},{"name":"indexConfig","x-displayName":"Index Config","description":"A configuration containing one or more index definitions.\n"},{"name":"sitemapConfig","x-displayName":"Sitemap Config","description":"A configuration containing one or more sitemap definitions.\n"}],"paths":{"/status/{owner}/{repo}/{ref}/{path}":{"get":{"operationId":"status","tags":["status"],"summary":"General status","description":"Returns the overall status of the respective resource. (If the `?edit=auto` query param is set, this requires a call to your content source see https://www.aem.live/docs/limits#rate-limits-number-of-preview-operations-per-time)","security":[{},{"AuthCookie":["preview:read","live:read","code:read","edit:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/statusEditUrlParam"}],"responses":{"200":{"description":"The overall status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/previewInfo"},{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/editInfo"},{"$ref":"#/components/schemas/codeInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"},{"$ref":"#/components/schemas/profileInfo"}]},"examples":{"success":{"description":"Success response of a preview document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","lastModifiedBy":"foo@adobe.com","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","lastModifiedBy":"anonymous","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"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}}}},"/status/{owner}/{repo}/{ref}/*":{"post":{"operationId":"bulkStatus","tags":["status"],"summary":"Start a bulk status job","description":"Fetches the status of all resources specified in the `paths` property in the payload. If a path ends with `/*`, it is assumed to be a folder and is recursively processed.<br><br> The response will contain the folliowing information about a resource: `path`, `sourceLastModified`, `previewLastModified` and `publishLastModified`. It is possible to filter the information returned, by passing a combination of `edit`, `preview` and `live` in the `select` property in the payload.<br><br> Note that the bulk status is performed asynchronously and the response will contain information about the created [job](#tag/job).\n","security":[{},{"AuthCookie":["edit:list","preview:list","live:list"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkStatusBody"},"examples":{"multiple-paths":{"$ref":"#/components/examples/example"}}}}},"responses":{"202":{"description":"Bulk status scheduled.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobCreated"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"status":202,"messageId":"37e92eec-020c-4eae-8f80-3db444c25056","job":{"topic":"status","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","data":{"paths":[{"prefix":"/en/"},{"path":"/en"},{"path":"/blog/"}]}},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/status/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/status"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}}}},"/live/{owner}/{repo}/{ref}/{path}":{"get":{"operationId":"getPublishStatus","tags":["publish"],"summary":"Publish Status","description":"Returns the publish status of the respective resource.","security":[{"AuthCookie":["live:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"The publish status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of a published document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}},"post":{"operationId":"publishResource","tags":["publish"],"summary":"Publish a resource","description":"Publish a resource by copying the resource content from the `preview` content-bus partition to the `live` content-bus partition. It additionally purges the _live_ cdn and the _byo_ cdn, if configured.\n","security":[{"AuthCookie":["preview:read","live:read","live:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/forceUpdateRedirectsParam"},{"$ref":"#/components/parameters/disableNotificationsParam"}],"responses":{"200":{"description":"Resource published.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of the published document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read","write"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"unpublishResource","tags":["publish"],"summary":"Un-publish a resource","description":"Un-publish a resource by deleting the content from from the `live` content-bus partition. It additionally purges the _live_ cdn and the _byo_ cdn, if configured.\n","security":[{"AuthCookie":["live:read","live:delete"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/disableNotificationsParam"}],"responses":{"204":{"description":"Resource unpublished"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/live/{owner}/{repo}/{ref}/*":{"post":{"operationId":"bulkPublish","tags":["publish"],"summary":"Start a bulk publish job","description":"Updates live resources specified in the `paths` property in the payload.<br> By default, only new and modified resources are updated, unless the `forceUpdate` property is set to `true`.<br> Note that configuration files, like `/.helix/config` or `redirects.json`, are always ignored during bulk publish.<br> Note that the bulk publish is performed asynchronously and this request will return information to the created job.\n","security":[{"AuthCookie":["preview:list","preview:read","preview:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkPublishBody"},"examples":{"multiple-paths":{"$ref":"#/components/examples/bulk-publish-payload_example"}}}}},"responses":{"202":{"description":"Bulk publish scheduled.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobCreated"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"status":202,"messageId":"37e92eec-020c-4eae-8f80-3db444c25056","job":{"topic":"publish","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","data":{"paths":[{"path":"/en"},{"path":"/blog/"},{"path":"/metadata.json"}]}},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/publish/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/publish"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/preview/{owner}/{repo}/{ref}/{path}":{"get":{"operationId":"previewStatus","tags":["preview"],"summary":"Preview status","description":"Returns the preview status of the respective resource.","security":[{"AuthCookie":["preview:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"The preview status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/previewInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of a preview document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","preview":{"status":200,"url":"https://main--repo--owner.hlx.page/en/2021/blog","lastModified":"2021-05-31T23:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/preview/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}},"post":{"operationId":"updatePreview","tags":["preview"],"summary":"Update preview","description":"Updates the preview resource by fetching the latest content from the content providers (e.g. sharepoint, google docs, BYOM) and storing it in `preview`.\n","security":[{"AuthCookie":["edit:read","preview:read","preview:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/forceUpdateRedirectsParam"},{"$ref":"#/components/parameters/word2mdVersionParam"},{"$ref":"#/components/parameters/gdocs2mdVersionParam"},{"$ref":"#/components/parameters/html2mdVersionParam"}],"responses":{"200":{"description":"Preview resource updated.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/previewInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","preview":{"status":200,"url":"https://main--repo--owner.hlx.page/en/2021/blog","lastModified":"2021-05-31T23:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/preview/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read","write"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"503":{"$ref":"#/components/responses/503"}}},"delete":{"operationId":"deletePreview","tags":["preview"],"summary":"Delete preview","description":"Deletes a preview resource from the `preview` partition in the content-bus..\n","security":[{"AuthCookie":["preview:read","preview:delete"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/preview/{owner}/{repo}/{ref}/*":{"post":{"operationId":"bulkPreview","tags":["preview"],"summary":"Start a bulk preview job","description":"Updates preview resources specified in the `paths` property in the payload. If a path ends with `/*`, it is assume to be folder and is recursively previewed.<br> By default, only new and modified resources are updated, unless the `forceUpdate` property is set to `true`.<br> Note that configuration files, like `/.helix/config` or `redirects.json`, are always ignored during bulk preview.<br> Note that the bulk preview is performed asynchronously and this request will return information to the created job.\n","security":[{"AuthCookie":["edit:read","edit:list","preview:read","preview:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/word2mdVersionParam"},{"$ref":"#/components/parameters/gdocs2mdVersionParam"},{"$ref":"#/components/parameters/html2mdVersionParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkPreviewBody"},"examples":{"multiple-paths":{"$ref":"#/components/examples/bulk-preview-payload_example"}}}}},"responses":{"202":{"description":"Bulk preview scheduled.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobCreated"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"status":202,"messageId":"37e92eec-020c-4eae-8f80-3db444c25056","job":{"topic":"preview","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","data":{"paths":["/documents"]}},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/preview"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"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"},"429":{"$ref":"#/components/responses/429"},"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"},"429":{"$ref":"#/components/responses/429"},"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"},"429":{"$ref":"#/components/responses/429"},"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"},"429":{"$ref":"#/components/responses/429"},"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.\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"},"429":{"$ref":"#/components/responses/429"},"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"}}},"429":{"$ref":"#/components/responses/429"},"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"}}},"429":{"$ref":"#/components/responses/429"},"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"}}},"429":{"$ref":"#/components/responses/429"},"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"}}}}}}},"429":{"$ref":"#/components/responses/429"}}}},"/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"}}},"429":{"$ref":"#/components/responses/429"}}}},"/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"}}},"429":{"$ref":"#/components/responses/429"}}}},"/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"}}}}}}},"429":{"$ref":"#/components/responses/429"}}}},"/sitemap/{owner}/{repo}/{ref}/{path}":{"post":{"operationId":"generateSitemap","tags":["sitemap"],"summary":"Generates a sitemap","description":"Generates a sitemap. The path specified should be the destination path of a sitemap.\n","security":[{}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"Sitemap generated.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/sitemapInfo"}]},"examples":{"success":{"description":"Success response of generating a sitemap","value":{"paths":["/sitemap.xml"]}}}}}},"204":{"description":"Path specified is no destination for any sitemap configured"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"description":"No sitemap configuration found","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/job/{owner}/{repo}/{ref}/{topic}":{"get":{"operationId":"getJobList","tags":["job"],"summary":"Job List","description":"Returns the job list of jobs","security":[{"AuthCookie":["job:list"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/topicParam"}],"responses":{"200":{"description":"The Job List","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobList"},{"$ref":"#/components/schemas/jobListLink"}]},"examples":{"success":{"description":"Success response of a job list.","value":{"topic":"preview","jobs":[{"name":"job-123","state":"created","time":"2021-05-31T23:00:00Z","href":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123"},{"name":"job-124","state":"running","time":"2021-04-31T23:00:00Z","href":"https://admin.hlx.page/job/adobe/blog/main/preview/job-124"}],"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}}},"/job/{owner}/{repo}/{ref}/{topic}/{jobName}":{"get":{"operationId":"getJob","tags":["job"],"summary":"Job Status","description":"Returns the job status","security":[{"AuthCookie":["job:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/topicParam"},{"$ref":"#/components/parameters/jobNameParam"}],"responses":{"202":{"description":"The Job Status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobStatus"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"success":{"description":"Success response.","value":{"topic":"preview","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","progress":{"total":10,"processed":0,"failed":0},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123","details":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123/details","list":"https://admin.hlx.page/job/adobe/blog/main/preview"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}},"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"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/job/{owner}/{repo}/{ref}/{topic}/{jobName}/details":{"get":{"operationId":"getJobDetails","tags":["job"],"summary":"Job Status Details","description":"Returns the job status","security":[{"AuthCookie":["job:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"},{"$ref":"#/components/parameters/topicParam"},{"$ref":"#/components/parameters/jobNameParam"}],"responses":{"202":{"description":"The Job Status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobStatusDetails"},{"$ref":"#/components/schemas/jobLinksInfoDetails"}]},"examples":{"success":{"description":"Success response.","value":{"topic":"preview","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","progress":{"total":10,"processed":6,"failed":4},"data":{"paths":["/documents"]},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123/details","job":"https://admin.hlx.page/job/adobe/blog/main/preview/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/preview"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}}},"/log/{owner}/{repo}/{ref}":{"get":{"operationId":"getLogs","tags":["log"],"summary":"Returns logs","description":"Returns logs for a project. If there are more logs for the timespan specified, there will be a `next` link in the response to load the next batch.\n","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/sinceParam"},{"$ref":"#/components/parameters/nextTokenParam"}],"responses":{"200":{"description":"Log statements","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logResult"},"examples":{"success":{"description":"Success response of a log request.","value":{"from":"2023-11-07T14:00:00.000Z","to":"2023-11-07T16:15:12.454Z","entries":[{"timestamp":1699368094644,"duration":467,"status":201,"method":"POST,","route":"preview","path":"/my-page","contentBusId":"xyz","owner":"owner","repo":"repo","ref":"ref"},{"timestamp":1699368094645,"duration":1005,"status":202,"method":"POST","route":"live","snapshotId":"default","user":"foo@example.com","paths":["/","/docs/howto/","/docs/howto/one","/docs/howto/two"],"contentBusId":"abc","owner":"owner","repo":"repo","ref":"ref"},{"timestamp":1699372505155,"event":"dinner is ready","contentBusId":"xyz","owner":"owner","repo":"repo","ref":"ref"}],"nextToken":"ABAB==","links":{"next":"https://admin.hlx.page/log/owner/repo/ref/?nextToken=ABAB=="}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}},"post":{"operationId":"addLogs","tags":["log"],"summary":"Add logs","description":"Add logs to a project. The body should be in JSON format and contain an array called `entries`.\n","security":[{"AuthCookie":["log:read","log:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/refParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logEntriesBody"},"examples":{"multiple-entries":{"description":"This posts one entry to the audit log. To see what the added entry would look like, see the second entry in the [getLog](#tag/log/operation/getLogs) example.\n","value":{"entries":[{"event":"dinner is ready"}]}}}}}},"responses":{"201":{"description":"Logs added."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/snapshot/{owner}/{repo}/main":{"get":{"operationId":"listSnapshots","tags":["snapshot"],"summary":"List snapshots","description":"Returns a list of snapshot IDs","security":[{"AuthCookie":["snapshot:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"}],"responses":{"200":{"description":"The snapshot list","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snapshotList"},{"$ref":"#/components/schemas/snapshotLinksList"}]},"examples":{"success":{"description":"Success response of list snapshots.","value":{"snapshots":["default","backup","for-next-big-release"],"links":{"self":"https://admin.hlx.page/snapshot/adobe/blog/main"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}}},"/snapshot/{owner}/{repo}/main/{snapshotId}":{"get":{"operationId":"getSnapshotManifest","tags":["snapshot"],"summary":"Snapshot Manifest","description":"Returns the snapshot manifest","security":[{"AuthCookie":["snapshot:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"}],"responses":{"200":{"description":"The snapshot manifest","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snapshotManifest"},{"$ref":"#/components/schemas/snapshotLinksInfo"}]},"examples":{"success":{"description":"Success response of a snapshot manifest.","value":{"manifest":{"id":"12345","title":"Test Review","description":"ignore this review","created":"2021-04-31T23:00:00Z","lastModified":"2021-05-31T23:00:00Z","lastUpdated":"2021-05-31T23:00:00Z","resources":[{"path":"/foo"},{"path":"/bar"}]},"links":{"snapshot":"https://admin.hlx.page/snapshot/adobe/blog/main/12345"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"}}},"post":{"operationId":"updateSnapshotManifest","tags":["snapshot"],"summary":"Update snapshot Manifest","description":"Updates the Snapshot manifest and allows to lock or unlock the snapshot. Note that in order to lock the snapshot, the request role also needs to include the `preview:write` permission, and in order to unlock the snapshot, the `live:write` permission is needed.\n","security":[{"AuthCookie":["snapshot:write","preview:write","live:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"locked":{"type":"boolean"},"title":{"type":"string"},"description":{"type":"string"},"metadata":{"type":"object","additionalProperties":true}}}}}},"responses":{"200":{"description":"The snapshot manifest","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snapshotManifest"},{"$ref":"#/components/schemas/snapshotLinksInfo"}]},"examples":{"success":{"description":"Success response of a snapshot manifest.","value":{"manifest":{"title":"December release","id":"12345","created":"2021-04-31T23:00:00Z","lastModified":"2021-05-31T23:00:00Z","lastUpdated":"2021-05-31T23:00:00Z","resources":[{"path":"/foo"},{"path":"/bar"}]},"links":{"snapshot":"https://admin.hlx.page/snapshot/adobe/blog/main/12345"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}}},"/snapshot/{owner}/{repo}/main/{snapshotId}/{path}":{"get":{"operationId":"getSnapshot","tags":["snapshot"],"summary":"Snapshot status","description":"Returns the snapshot status of the respective resource.","security":[{"AuthCookie":["snapshot:read"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"200":{"description":"The snapshot status","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/previewInfo"},{"$ref":"#/components/schemas/snapshotInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of a snapshot document.","value":{"webPath":"/.snapshot/12345/en/2021/blog","resourcePath":"/.snapshot/12345/en/2021/blog.md","preview":{"status":200,"url":"https://main--repo--owner.hlx.page/.snapshot/12345/en/2021/blog","lastModified":"2021-05-31T23:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/.snapshot/12345/preview/en/2021/blog.md","permissions":["read","write"]},"snapshot":{"id":"12345","locked":"2021-05-31T23:00:00Z"},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"}}},"post":{"operationId":"createSnapshot","tags":["snapshot"],"summary":"Add resource to snapshot","description":"Creates a snapshot of the specified resource and stores it in the preview partition below the `.snapshot/snapshotId` folder. If the path param ends with a `*`, a snapshot of the entire subtree is created. If the snapshot is locked, a `409` response is returned.\n","security":[{"AuthCookie":["snapshot:read","snapshot:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/snFilterParam"}],"responses":{"200":{"description":"Successful snapshot response"},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteSnapshot","tags":["snapshot"],"summary":"Delete snapshot","description":"Deletes a snapshot resource from the `preview` partition in the content-bus.  If the path param ends with a `*`, the entire subtree is deleted. If the snapshot is locked, a `409` response is returned.\n","security":[{"AuthCookie":["snapshot:read","snapshot:delete"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/pathParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}},"/snapshot/{owner}/{repo}/main/{snapshotId}/*":{"post":{"operationId":"bulkSnapshot","tags":["snapshot"],"summary":"Start a bulk snapshot job","description":"Add all resources specified in the `paths` property in the payload.<br> By default, only new and modified resources are updated, unless the `forceUpdate` property is set to `true`.<br> Note that the bulk snapshot is performed synchronously for arrays with fewer than 200 resources and no wildcard paths, and asynchronously otherwise.<br> Note that without the appropriate `application/json` content type header, the request will be treated as a wildcard add with no body, resulting in all resources being added to the snapshot.\n","security":[{"AuthCookie":["snapshot:read","snapshot:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulkSnapshotBody"},"examples":{"multiple-paths":{"$ref":"#/components/examples/multiple-paths"},"wildcard":{"$ref":"#/components/examples/wildcard"}}}}},"responses":{"202":{"description":"Bulk snapshot.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/jobCreated"},{"$ref":"#/components/schemas/jobLinksInfo"}]},"examples":{"sync-success":{"description":"Successful job completed synchronously response.","value":{"status":202,"messageId":"37e92eec-020c-4eae-8f80-3db444c25056","job":{"topic":"snapshot","name":"job-123","state":"stopped","startTime":"2021-05-31T23:00:00Z","data":{"snapshotId":"snapshot-123","forceUpdate":false,"phase":"completed","paths":[{"path":"/en"},{"path":"/blog/"}],"resources":[{"resourcePath":"/en.md","webPath":"/en","status":200},{"resourcePath":"/blog/index.md","webPath":"/blog/","status":200}]}},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/snapshot/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/snapshot"}}},"async-success":{"description":"Successful asynchronous job created response.","value":{"status":202,"messageId":"37e92eec-020c-4eae-8f80-3db444c25056","job":{"topic":"publish","name":"job-123","state":"created","startTime":"2021-05-31T23:00:00Z","data":{"snapshotId":"snapshot-123","forceUpdate":false,"paths":[{"path":"/en/*"}]}},"links":{"self":"https://admin.hlx.page/job/adobe/blog/main/snapshot/job-123","list":"https://admin.hlx.page/job/adobe/blog/main/snapshot"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/snapshot/{owner}/{repo}/main/{snapshotId}/{path}?publish=true":{"post":{"operationId":"publishSnapshotResource","tags":["snapshot"],"summary":"Publish snapshot resource","description":"Publish snapshot resources by copying the resource content from the snapshot location to the `live` content-bus partition. It additionally purges the _live_ cdn and the _byo_ cdn, if configured. If the path param ends with a `*` the resources of the path's entire subtree is published.\n","security":[{"AuthCookie":["snapshot:read","live:read","live:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/pathParam"},{"$ref":"#/components/parameters/snPublishParam"}],"responses":{"200":{"description":"Resources published.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of the published document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read","write"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"202":{"description":"Snapshot publish job started","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snapshotJob"},{"$ref":"#/components/schemas/snapshotLinksPublishJob"}]},"examples":{"success":{"description":"Response of the created publish job.","value":{"job":{"topic":"publish","name":"job-2024-01-16t22-39-20-813z","state":"stopped","createTime":"2024-01-16T22:39:20.813Z","startTime":"2024-01-16T22:39:21.971Z","stopTime":"2024-01-16T22:39:24.693Z","invocationId":"96669ae6-cf90-530a-ac36-c4c7c85d27c8","data":{"paths":["/foo"],"snapshotId":"name","phase":"completed","resources":[{"path":"/foo","lastModified":"2024-01-16T22:39:24.693Z","status":200}]},"progress":{"total":1,"processed":1,"failed":0}},"links":{"list":"https://admin.hlx.page/job/owner/repo/main/publish","self":"https://admin.hlx.page/job/owner/repo/main/publish/job-2024-01-16t22-39-20-813z"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/snapshot/{owner}/{repo}/main/{snapshotId}?publish=true":{"post":{"operationId":"publishSnapshot","tags":["snapshot"],"summary":"Publish snapshot","description":"Publish a snapshot by copying all resources from the snapshot location to the `live` content-bus partition. It additionally purges the _live_ cdn and the _byo_ cdn, if configured.\n","security":[{"AuthCookie":["snapshot:read","live:read","live:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/snPublishParam"}],"responses":{"200":{"description":"Snapshot published.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/resourceInfo"},{"$ref":"#/components/schemas/liveInfo"},{"$ref":"#/components/schemas/resourceLinksInfo"}]},"examples":{"success":{"description":"Success response of the published document.","value":{"webPath":"/en/2021/blog","resourcePath":"/en/2021/blog.md","live":{"status":200,"url":"https://repo--owner.hlx.live/en/2021/blog","lastModified":"2021-05-29T22:00:00Z","contentBusId":"h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md","sourceLocation":"onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ","sourceLastModified":"2021-05-29T21:00:00Z","permissions":["read","write"]},"links":{"status":"https://admin.hlx.page/status/adobe/blog/main/blog","preview":"https://admin.hlx.page/preview/adobe/blog/main/blog","live":"https://admin.hlx.page/live/adobe/blog/main/blog","code":"https://admin.hlx.page/code/adobe/blog/main/blog"}}}}}}},"202":{"description":"Snapshot publish job started","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/snapshotJob"},{"$ref":"#/components/schemas/snapshotLinksPublishJob"}]},"examples":{"success":{"description":"Response of the created publish job.","value":{"job":{"topic":"publish","name":"job-2024-01-16t22-39-20-813z","state":"stopped","createTime":"2024-01-16T22:39:20.813Z","startTime":"2024-01-16T22:39:21.971Z","stopTime":"2024-01-16T22:39:24.693Z","invocationId":"96669ae6-cf90-530a-ac36-c4c7c85d27c8","data":{"paths":["/foo"],"snapshotId":"name","phase":"completed","resources":[{"path":"/foo","lastModified":"2024-01-16T22:39:24.693Z","status":200}]},"progress":{"total":1,"processed":1,"failed":0}},"links":{"list":"https://admin.hlx.page/job/owner/repo/main/publish","self":"https://admin.hlx.page/job/owner/repo/main/publish/job-2024-01-16t22-39-20-813z"}}}}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}},"/snapshot/{owner}/{repo}/main/{snapshotId}?review=[request,approve,reject]":{"post":{"operationId":"reviewSnapshot","tags":["snapshot"],"summary":"Change snapshot review state","description":"Performs a review operation on the snapshot. `request` locks the snapshot; `approve` publishes all resources, clears, and unlocks the snapshot; `reject` unlocks the snapshot. All operations can contain an optional `message` parameter which will be included in logs and events.\n","security":[{"AuthCookie":["snapshot:read","live:read","live:write"]}],"parameters":[{"$ref":"#/components/parameters/ownerParam"},{"$ref":"#/components/parameters/repoParam"},{"$ref":"#/components/parameters/snIdParam"},{"$ref":"#/components/parameters/snReviewParam"},{"$ref":"#/components/parameters/snReviewMessageParam"}],"responses":{"204":{"description":"Snapshot review operation performed."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}.json":{"get":{"operationId":"getConfigOrg","tags":["orgConfig"],"summary":"Read Organisation Config","description":"Returns the organisation level configuration.","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/org"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigOrg","tags":["orgConfig"],"summary":"Update Organisation Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/org"}}}},"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"put":{"operationId":"createConfigOrg","tags":["orgConfig"],"summary":"Create Organisation Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/org"}}}},"responses":{"201":{"description":"Resource created."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteConfigOrg","tags":["orgConfig"],"summary":"Delete Organisation Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/users.json":{"get":{"operationId":"listOrgUsers","tags":["orgConfig"],"summary":"List Users","description":"Returns the org users","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/users"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateOrgUser","tags":["orgConfig"],"summary":"Create new org user","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/orgConfigUser"},{"$ref":"#/components/schemas/orgConfigUsers"}]}}}},"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/user"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}},"/config/{org}/users/${id}.json":{"get":{"operationId":"readOrgUser","tags":["orgConfig"],"summary":"Read user","description":"Returns the user","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/userIdParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/user"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"delete":{"operationId":"deleteOrgUser","tags":["orgConfig"],"summary":"Delete user","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/userIdParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/sites.json":{"get":{"operationId":"getConfigSites","tags":["siteConfig"],"summary":"List Site Config","description":"Returns the site level configuration names.","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"responses":{"200":{"description":"SiteConfigList (Schema)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sites"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}},"/config/{org}/sites/{site}.json":{"get":{"operationId":"getConfigSite","tags":["siteConfig"],"summary":"Read Site Config","description":"Returns the site level configuration. If `migrate` is set to `true`, the configuration will be aggregated based on the legacy config (fstab, .helix/config.xlsx, etc).\n","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"},{"$ref":"#/components/parameters/migrateParam"},{"$ref":"#/components/parameters/validateParam"}],"responses":{"200":{"description":"SiteConfig (Schema)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/site"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigSite","tags":["siteConfig"],"summary":"Update Site Config.","description":"Stores new site configuration. If `migrate` is set to `true`, the configuration will be aggregated based on the legacy config (fstab, .helix/config.xlsx, etc) and will overwrite the existing configuration.","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"},{"$ref":"#/components/parameters/migrateParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/site"}}}},"responses":{"200":{"description":"SiteConfig (Schema)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/site"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"put":{"operationId":"createSiteSite","tags":["siteConfig"],"summary":"Create Site Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/site"}}}},"responses":{"200":{"description":"SiteConfig (Schema)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/site"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"delete":{"operationId":"deleteConfigSite","tags":["siteConfig"],"summary":"Delete Site Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/sites/{site}/robots.txt":{"get":{"operationId":"getConfigSiteRobots","tags":["siteConfig"],"summary":"Read Site robots.txt Config","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"200":{"description":"robots.txt","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigSiteRobots","tags":["siteConfig"],"summary":"Update Site robots.txt Config.","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"requestBody":{"content":{"text/plain":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"robots.txt","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}},"/config/{org}/sites/{site}/tokens.json":{"get":{"operationId":"listSiteTokens","tags":["siteConfig"],"summary":"List access tokens","description":"Returns the access tokens","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tokens"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateSiteToken","tags":["siteConfig"],"summary":"Create new access token","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"[a-zA-Z0-9-_=]+"},"value":{"type":"string","pattern":"[a-zA-Z0-9-_=]+"},"created":{"type":"string","format":"date-time"}}}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}},"/config/{org}/sites/{site}/tokens/${id}.json":{"get":{"operationId":"readSiteToken","tags":["siteConfig"],"summary":"Read access token","description":"Returns the access token","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"},{"$ref":"#/components/parameters/tokenIdParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tokens"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"delete":{"operationId":"deleteSiteToken","tags":["siteConfig"],"summary":"Delete access token","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"},{"$ref":"#/components/parameters/tokenIdParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/aggregated/{site}.json":{"get":{"operationId":"getAggregatedConfigSite","tags":["siteConfig"],"summary":"Read Aggregated Site Config","description":"Returns the aggregated site level configuration. This includes the inherited values from the profile.\n","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"200":{"description":"SiteConfig (Schema)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/site"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}},"/config/{org}/profiles.json":{"get":{"operationId":"getConfigProfiles","tags":["profileConfig"],"summary":"List Profile Config","description":"Returns the configuration profile names.","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"}],"responses":{"200":{"description":"ConfigProfileList (Schema)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/profiles"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}},"/config/{org}/profiles/{profile}.json":{"get":{"operationId":"getConfigProfile","tags":["profileConfig"],"summary":"Read Profile Config","description":"Returns the Profile level configuration.","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"responses":{"200":{"description":"profile config","content":{"application/json":{"schema":{"$ref":"#/components/schemas/profile"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigProfile","tags":["profileConfig"],"summary":"Update Profile Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/profile"}}}},"responses":{"200":{"description":"profile config","content":{"application/json":{"schema":{"$ref":"#/components/schemas/profile"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"put":{"operationId":"createConfigProfile","tags":["profileConfig"],"summary":"Create Profile Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/profile"}}}},"responses":{"201":{"description":"Resource created."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}},"delete":{"operationId":"deleteConfigProfile","tags":["profileConfig"],"summary":"Delete Profile Config","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/profiles/{profile}/robots.txt":{"get":{"operationId":"getConfigProfileRobots","tags":["profileConfig"],"summary":"Read Profile robots.txt Config","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"responses":{"200":{"description":"robots.txt","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateConfigProfileRobots","tags":["profileConfig"],"summary":"Update Profile robots.txt Config.","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"requestBody":{"content":{"text/plain":{"schema":{"type":"string"}}}},"responses":{"200":{"description":"robots.txt","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}},"/config/{org}/profiles/{profile}/tokens.json":{"get":{"operationId":"listProfileTokens","tags":["profileConfig"],"summary":"List access tokens","description":"Returns the access tokens","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tokens"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateProfileToken","tags":["profileConfig"],"summary":"Create new access token","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"[a-zA-Z0-9-_=]+"},"value":{"type":"string","pattern":"[a-zA-Z0-9-_=]+"},"created":{"type":"string","format":"date-time"}}}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}}},"/config/{org}/profiles/{profile}/tokens/${id}.json":{"get":{"operationId":"readProfileToken","tags":["profileConfig"],"summary":"Read access token","description":"Returns the access token","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"},{"$ref":"#/components/parameters/tokenIdParam"}],"responses":{"200":{"description":"data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tokens"}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"delete":{"operationId":"deleteProfileToken","tags":["profileConfig"],"summary":"Delete access token","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/profileParam"},{"$ref":"#/components/parameters/tokenIdParam"}],"responses":{"204":{"description":"Resource deleted."},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"409":{"$ref":"#/components/responses/409"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}},"/config/{org}/sites/{site}/content/query.yaml":{"get":{"operationId":"getIndexConfig","tags":["indexConfig"],"summary":"Read Index Configuration","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"200":{"description":"index configuration","content":{"text/yaml":{"schema":{"$ref":"#/components/schemas/indexconfig"},"examples":{"success":{"description":"Success response of reading an index configuration","value":"version: 1\nindices:\n  default:\n    include:\n      - '/**'\n    target: /query-index.json\n    properties:\n      lastModified:\n        select: none\n        value: parseTimestamp(headers[\"last-modified\"], \"ddd, DD MMM YYYY hh:mm:ss GMT\")\n"}}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateIndexConfig","tags":["indexConfig"],"summary":"Update Index Configuration","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"requestBody":{"content":{"text/yaml":{"schema":{"$ref":"#/components/schemas/indexconfig"}}},"required":true},"responses":{"204":{"description":"Index configuration updated"}}},"put":{"operationId":"createIndexConfig","tags":["indexConfig"],"summary":"Create Index Configuration","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"requestBody":{"content":{"text/yaml":{"schema":{"$ref":"#/components/schemas/indexconfig"}}},"required":true},"responses":{"201":{"description":"Index configuration created."},"409":{"description":"Site already has an index configuration, update it instead."}}},"delete":{"operationId":"deleteIndexConfig","tags":["indexConfig"],"summary":"Delete Index Configuration","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"204":{"description":"Index configuration deleted."}}}},"/config/{org}/sites/{site}/content/sitemap.yaml":{"get":{"operationId":"getSitemapConfig","tags":["sitemapConfig"],"summary":"Read Sitemap Configuration","security":[{"AuthCookie":["config:read"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"200":{"description":"sitemap configuration","content":{"text/yaml":{"schema":{"$ref":"#/components/schemas/sitemapconfig"},"examples":{"success":{"description":"Success response of reading a sitemap configuration","value":"version: 1\nsitemaps:\n  default:\n    source: /sitemap-index.json\n    destination: /sitemap.xml\n    lastmod: YYYY-MM-DD\n"}}}}},"400":{"description":"Invalid request url.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"401":{"description":"Not authenticated"},"403":{"description":"Access role does not have the required permission"},"404":{"description":"Resource not found.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"405":{"description":"Method not allowed.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"$ref":"#/components/responses/429"},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}}},"post":{"operationId":"updateSitemapConfig","tags":["sitemapConfig"],"summary":"Update Sitemap Configuration","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"requestBody":{"content":{"text/yaml":{"schema":{"$ref":"#/components/schemas/sitemapconfig"}}},"required":true},"responses":{"204":{"description":"Sitemap configuration updated."}}},"put":{"operationId":"createSitemapConfig","tags":["sitemapConfig"],"summary":"Create Sitemap Configuration","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"requestBody":{"content":{"text/yaml":{"schema":{"$ref":"#/components/schemas/sitemapconfig"}}},"required":true},"responses":{"201":{"description":"Sitemap configuration created."},"409":{"description":"Site already has a sitemap configuration, update it instead."}}},"delete":{"operationId":"deleteSitemapConfig","tags":["sitemapConfig"],"summary":"Delete Sitemap Configuration","security":[{"AuthCookie":["config:write"]}],"parameters":[{"$ref":"#/components/parameters/orgParam"},{"$ref":"#/components/parameters/siteParam"}],"responses":{"204":{"description":"Sitemap configuration deleted."}}}}},"components":{"securitySchemes":{"AuthCookie":{"type":"apiKey","in":"cookie","name":"auth_token"},"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SiteConfig":{"x-tags":["siteConfig"],"$ref":"#/components/schemas/site"},"SiteConfigList":{"x-tags":["siteConfig"],"$ref":"#/components/schemas/sites"},"OrgConfig":{"x-tags":["orgConfig"],"$ref":"#/components/schemas/org"},"ProfileConfig":{"x-tags":["profileConfig"],"$ref":"#/components/schemas/profile"},"ProfileConfigList":{"x-tags":["profileConfig"],"$ref":"#/components/schemas/profiles"},"AdminAccessConfig":{"$ref":"#/components/schemas/access-admin","x-tags":["siteConfig","profileConfig"]},"SiteAccessConfig":{"$ref":"#/components/schemas/access-site","x-tags":["siteConfig","profileConfig"]},"AccessConfig":{"$ref":"#/components/schemas/access","x-tags":["siteConfig","profileConfig"]},"CDNConfig":{"$ref":"#/components/schemas/cdn","x-tags":["siteConfig","profileConfig"]},"CodeConfig":{"$ref":"#/components/schemas/code","x-tags":["siteConfig","profileConfig"]},"ContentConfig":{"$ref":"#/components/schemas/content","x-tags":["siteConfig","profileConfig"]},"FoldersConfig":{"$ref":"#/components/schemas/folders","x-tags":["siteConfig","profileConfig"]},"HeadersConfig":{"$ref":"#/components/schemas/headers","x-tags":["siteConfig","profileConfig"]},"MetadataConfig":{"$ref":"#/components/schemas/metadata-source","x-tags":["siteConfig","profileConfig"]},"PublicConfig":{"$ref":"#/components/schemas/public","x-tags":["siteConfig","profileConfig"]},"GroupsConfig":{"$ref":"#/components/schemas/groups","x-tags":["siteConfig","orgConfig"]},"RobotsConfig":{"$ref":"#/components/schemas/robots","x-tags":["siteConfig","profileConfig"]},"SidekickConfig":{"$ref":"#/components/schemas/sidekick","x-tags":["siteConfig","profileConfig"]},"TokensConfig":{"$ref":"#/components/schemas/tokens","x-tags":["siteConfig","profileConfig"]},"IndexConfig":{"$ref":"#/components/schemas/indexconfig","x-tags":["indexConfig"]},"SitemapConfig":{"$ref":"#/components/schemas/sitemapconfig","x-tags":["sitemapConfig"]},"resourceInfo":{"required":["webPath","resourcePath"],"properties":{"webPath":{"description":"Relative path used on the websites.","type":"string"},"resourcePath":{"description":"Relative path of the content resource","type":"string"}}},"permissions":{"description":"Access permissions","required":["permissions"],"properties":{"permissions":{"type":"array","items":{"type":"string","enum":["read","write","delete"]}}}},"contentBusResource":{"required":["contentBusId"],"properties":{"contentBusId":{"description":"Full content-bus id.","type":"string"},"lastModified":{"description":"Last modification date. undefined when resource is missing.","type":"string","format":"date-time"},"contentType":{"description":"The resource content type. undefined when resource is missing.","type":"string"},"contentLength":{"description":"Size of the content in bytes. undefined when resource is missing.","type":"integer"},"redirectLocation":{"description":"Location for redirects as defined on the resource","type":"string","format":"url"},"configRedirectLocation":{"description":"Location for redirects as defined in the config (redirects.json)","type":"string","format":"url"},"sourceLocation":{"description":"Content provider specific id of the source.","type":"string","format":"url"},"sourceLastModified":{"description":"Last modification date of the source document.","type":"string","format":"date-time"}}},"liveInfo":{"required":["live"],"properties":{"live":{"description":"Information about the published resource.","allOf":[{"required":["url","status"]},{"properties":{"status":{"description":"HTTP status of response when fetching thre information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"},"url":{"description":"Live URL of the resource.","type":"string","format":"url"}}},{"$ref":"#/components/schemas/permissions"},{"$ref":"#/components/schemas/contentBusResource"}]}}},"previewInfo":{"required":["preview"],"properties":{"preview":{"description":"Information about the preview resource.","allOf":[{"required":["url","status"]},{"properties":{"status":{"description":"HTTP status of response when fetching the information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"},"url":{"description":"Preview URL of the resource.","type":"string","format":"url"}}},{"$ref":"#/components/schemas/permissions"},{"$ref":"#/components/schemas/contentBusResource"}]}}},"folderInfo":{"required":["name","path","url"],"properties":{"name":{"description":"Name of folder","type":"string"},"path":{"description":"Path of folder, relative to the mount root","type":"string"},"url":{"description":"URL of folder","type":"string","format":"url"}}},"editResource":{"description":"Edit information for a resource","properties":{"url":{"description":"URL of edit document.","type":"string","format":"url"},"sourceLocation":{"description":"Content provider specific id of the source","type":"string","format":"url"},"lastModified":{"description":"Last modification date of the source document.","type":"string","format":"date-time"},"name":{"description":"Name of the edit document","type":"string"},"contentType":{"description":"Content type of the edit document","type":"string"},"folders":{"description":"Information of parent folders of the edit document.","type":"array","items":{"$ref":"#/components/schemas/folderInfo"}}}},"editInfo":{"required":["edit"],"properties":{"edit":{"description":"Edit information for a resource","type":"object","allOf":[{"required":["url","status"]},{"properties":{"status":{"description":"HTTP status of response when fetching thre information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"}}},{"$ref":"#/components/schemas/editResource"}]}}},"codeBusResource":{"required":["codeBusId"],"properties":{"codeBusId":{"description":"Full code-bus id.","type":"string"},"lastModified":{"description":"Last modification date. undefined when resource is missing.","type":"string","format":"date-time"},"contentType":{"description":"The resource content type. undefined when resource is missing.","type":"string"},"contentLength":{"description":"Size of the content in bytes. undefined when resource is missing.","type":"integer"},"sourceLocation":{"description":"Content provider specific id of the source","type":"string","format":"url"},"sourceLastModified":{"description":"Last modification date of the source document.","type":"string","format":"date-time"}}},"codeInfo":{"required":["code"],"properties":{"code":{"description":"Information about a code bus resource","type":"object","allOf":[{"required":["status"]},{"properties":{"status":{"description":"HTTP status of response when fetching thre information of the resource","type":"number"},"error":{"description":"Message of error when there was a problem fetching the information of the resource"}}},{"$ref":"#/components/schemas/codeBusResource"},{"$ref":"#/components/schemas/permissions"}]}}},"resourceLinksInfo":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"status":{"description":"link of the status api","example":"https://admin.hlx.page/status/owner/repo/ref","type":"string","format":"url"},"live":{"description":"link of the live api","example":"https://admin.hlx.page/live/owner/repo/ref","type":"string","format":"url"},"preview":{"description":"link of the preview api","example":"https://admin.hlx.page/preview/owner/repo/ref","type":"string","format":"url"},"code":{"description":"link of the code api","example":"https://admin.hlx.page/code/owner/repo/ref","type":"string","format":"url"}}}}},"profileInfo":{"properties":{"profile":{"description":"Profile data","additionalProperties":true,"properties":{"iss":{"description":"id token issuer","type":"string"},"email":{"description":"email of logged in user","type":"string"},"name":{"description":"name of logged in user","type":"string"},"ttl":{"description":"time to live of current id token","type":"number"}}}}},"bulkStatusBody":{"description":"bulk status body","required":["paths"],"properties":{"paths":{"description":"paths to filter the bulk status","type":"array","items":{"type":"string"}},"select":{"description":"a combination of `edit`, `preview` and `live`. The default is `['preview','live']`.","type":"array","items":{"type":"string","enum":["edit","preview","live"]}},"pathsOnly":{"description":"only return paths","type":"boolean","default":false}}},"jobStatus":{"required":["topic","name","state","startTime"],"properties":{"topic":{"description":"Job Topic","type":"string"},"name":{"description":"Job Name","type":"string"},"state":{"description":"Job State","type":"string"},"startTime":{"description":"Job start time","type":"string","format":"date-time"},"endTime":{"description":"Job end time","type":"string","format":"date-time"},"cancelled":{"description":"Flag indicating if job was cancelled","type":"boolean"},"data":{"description":"Custom job data","type":"object"},"progress":{"description":"job progress","type":"object"}}},"jobCreated":{"required":["messageId","job"],"properties":{"messageId":{"description":"Internal message id","type":"string"},"job":{"description":"Job state","type":"object","$ref":"#/components/schemas/jobStatus"}}},"jobLinksInfo":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"self":{"description":"link of the job api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13","type":"string","format":"url"},"details":{"description":"link of the job details api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13/details","type":"string","format":"url"},"list":{"description":"link of the job list","example":"https://admin.hlx.page/job/owner/repo/ref/preview","type":"string","format":"url"}}}}},"bulkPublishBody":{"description":"bulk publish body","required":["paths"],"properties":{"forceUpdate":{"description":"forces an update of the resources during bulk-publish","type":"boolean"},"paths":{"description":"paths to filter the bulk publish","type":"array","items":{"type":"string"}},"delete":{"description":"delete the resources from publish","type":"boolean","default":false}}},"bulkPreviewBody":{"description":"bulk preview body","required":["paths"],"properties":{"forceUpdate":{"description":"forces an update of the resources during bulk-preview","type":"boolean"},"paths":{"description":"paths to filter the bulk preview","type":"array","items":{"type":"string"}},"delete":{"description":"delete the resources from preview","type":"boolean","default":false}}},"changeEntry":{"description":"Describes the changes made to one resource.","required":["type","path"],"properties":{"type":{"description":"change type","type":"string","enum":["added","deleted","modified"]},"path":{"description":"Relative path of changed resource or `*` if this as a branch event.","type":"string"},"time":{"description":"timestamp of change","type":"string","format":"date-time"},"commit":{"description":"commit sha of change","type":"string"},"contentType":{"description":"the content type of the changed resource","type":"string"}}},"changeEventBody":{"description":"Change event payload","required":["changes"],"additionalProperties":true,"properties":{"source":{"description":"event source, eg: 'github'\n","type":"string"},"baseRef":{"description":"base ref for branch operations","type":"string"},"changes":{"description":"array of changes","type":"array","items":{"$ref":"#/components/schemas/changeEntry"}}}},"indexResource":{"description":"Information of the index","required":["name"],"properties":{"name":{"description":"Index name in helix-index.yaml","type":"string"},"githubLink":{"description":"Github url of the helix-index.yaml","example":"https://github.com/owner/repo/blob/main/helix-index.yaml#L4","type":"string","format":"url"},"indexedUrl":{"description":"URL of document that was indexed. Deprecation Note: The indexed html is always fetched from the preview/live url at the time of publishing and hence not required in helix-index.yaml anymore.\n","deprecated":true,"example":"https://main--owner--repo.hlx.page/en/2021/blog","type":"string","format":"url"},"lastModified":{"type":"string","format":"date-time"},"status":{"description":"status of index operation on resource","type":"number"}}},"indexInfo":{"required":["index"],"properties":{"index":{"description":"Information of the index","type":"object","$ref":"#/components/schemas/indexResource"}}},"loginLinks":{"required":["links"],"properties":{"links":{"description":"API navigation links","additionalProperties":{"type":"string","format":"url"}}}},"logoutLink":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"logout":{"description":"link of logout","example":"https://admin.hlx.page/logout","type":"string","format":"url"}}}}},"sitemapInfo":{"description":"Information for the sitemap that was generated","properties":{"paths":{"description":"Paths that were updated","type":"array","items":{"type":"string"}}}},"jobList":{"required":["topic","jobs"],"properties":{"topic":{"description":"Job Topic","type":"string"},"jobs":{"description":"Jobs","type":"array","items":{"required":["name","state","time","href"],"description":"Job info","type":"object","properties":{"name":{"description":"Job name","type":"string"},"state":{"description":"Job State","type":"string"},"time":{"description":"Job creation time","type":"string","format":"date-time"},"href":{"description":"link of the job api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13","type":"string","format":"url"}}}}}},"jobListLink":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"self":{"description":"link of the job list","example":"https://admin.hlx.page/job/owner/repo/ref/preview","type":"string","format":"url"}}}}},"jobStatusDetails":{"required":["topic","name","state","startTime","data"],"properties":{"topic":{"description":"Job Topic","type":"string"},"name":{"description":"Job Name","type":"string"},"state":{"description":"Job State","type":"string"},"startTime":{"description":"Job start time","type":"string","format":"date-time"},"endTime":{"description":"Job end time","type":"string","format":"date-time"},"cancelled":{"description":"Flag indicating if job was cancelled","type":"boolean"},"data":{"description":"Custom job data","type":"object"},"progress":{"description":"job progress","type":"object"}}},"jobLinksInfoDetails":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"self":{"description":"link of the job details api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13/details","type":"string","format":"url"},"job":{"description":"link of the job api","example":"https://admin.hlx.page/job/owner/repo/ref/preview/job-13","type":"string","format":"url"},"list":{"description":"link of the job list","example":"https://admin.hlx.page/job/owner/repo/ref/preview","type":"string","format":"url"}}}}},"logResult":{"description":"Log result","required":["entries"],"properties":{"entries":{"description":"entries in that page","type":"array","items":{"type":"object"}},"nextToken":{"description":"token to pass in next call to continue paging","type":"string"},"links":{"description":"API navigation links","properties":{"next":{"description":"link to the next batch","example":"https://admin.hlx.page/log/owner/repo/ref/?nextToken=ABAB==","type":"string","format":"url"}}},"from":{"description":"log start time","type":"string"},"to":{"description":"log end time","type":"string"}}},"logEntriesBody":{"description":"Add logs body","required":["entries"],"properties":{"entries":{"description":"entries to add to the logs","type":"array","items":{"type":"object"}}}},"snapshotList":{"required":["snapshots"],"properties":{"snapshots":{"description":"List of snapshot IDs","type":"array","items":{"type":"string"}}}},"snapshotLinksList":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"self":{"description":"link of the snapshot list api","example":"https://admin.hlx.page/snapshot/owner/repo/main","type":"string","format":"url"}}}}},"snapshotResource":{"description":"snapshot resource","type":"object","required":["path"],"properties":{"path":{"description":"path of the resource","type":"string"},"status":{"description":"status code for the resource","type":"number"},"lastModified":{"description":"last modified date of the resource","type":"string","format":"date-time"}}},"snapshotManifest":{"required":["manifest"],"properties":{"manifest":{"required":["id","created","lastModified","resources"],"properties":{"id":{"description":"The snapshot ID","type":"string"},"title":{"description":"The snapshot title","type":"string"},"description":{"description":"The snapshot description","type":"string"},"created":{"description":"Creation time","type":"string","format":"date-time"},"lastModified":{"description":"Last manifest modification time","type":"string","format":"date-time"},"lastUpdated":{"description":"Last time a resource was added or removed from this snapshot","type":"string","format":"date-time"},"locked":{"description":"Time when this snapshot was locked.","type":"string","format":"date-time"},"resources":{"description":"list of resources in the snapshot","type":"array","items":{"$ref":"#/components/schemas/snapshotResource"}}}}}},"snapshotLinksInfo":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"snapshot":{"description":"link of the status api","example":"https://admin.hlx.page/snapshot/owner/repo/ref/1234","type":"string","format":"url"}}}}},"snapshotInfo":{"required":["snapshot"],"properties":{"snapshot":{"required":["id"],"properties":{"id":{"description":"The snapshot ID","type":"string"},"locked":{"description":"Time when this snapshot was locked.","type":"string","format":"date-time"}}}}},"bulkSnapshotBody":{"description":"bulk snapshot body","required":["paths"],"properties":{"forceUpdate":{"description":"forces an update of the resources during bulk snapshot","type":"boolean"},"paths":{"description":"paths of resources to include in the bulk snapshot","type":"array","items":{"type":"string"}}}},"jobState":{"description":"Job state","type":"string","enum":["created","running","stopped"]},"snapshotJob":{"required":["job"],"properties":{"job":{"required":["topic","name","state","createTime","data","startTime","stopTime","invocationId","progress"],"properties":{"topic":{"description":"Job Topic","type":"string"},"name":{"description":"Job Name","type":"string"},"state":{"description":"Job State","$ref":"#/components/schemas/jobState"},"createTime":{"description":"Job creation time","type":"string","format":"date-time"},"stopTime":{"description":"Job end time","type":"string","format":"date-time"},"startTime":{"description":"Job start time","type":"string","format":"date-time"},"invocationId":{"description":"Job end time","type":"string"},"progress":{"type":"object","properties":{"total":{"description":"total number of resources","type":"number"},"processed":{"description":"number of resources processed","type":"number"},"failed":{"description":"number of resources failed","type":"number"}}},"data":{"description":"Snapshot job data","type":"object","properties":{"paths":{"description":"paths being published from snapshot","type":"array","items":{"type":"string"}},"forceUpdate":{"description":"force update of resources","type":"boolean"},"snapshotId":{"description":"snapshot id","type":"string"},"phase":{"description":"current phase of the job","type":"string"},"resources":{"description":"list of resources in the snapshot","type":"array","items":{"$ref":"#/components/schemas/snapshotResource"}}}}}}}},"snapshotLinksPublishJob":{"required":["links"],"properties":{"links":{"description":"API navigation links","properties":{"self":{"description":"link of the publish snapshot job api","example":"https://admin.hlx.page/job/owner/repo/main/publish/job-name","type":"string","format":"url"}}}}},"title":{"type":"string","description":"human readable title. has no influence on the configuration."},"description":{"type":"string","description":"description for clarity. has no influence on the configuration."},"user":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/user","title":"user","type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9-_=]+$"},"email":{"type":"string","format":"email"},"name":{"type":"string"},"roles":{"type":"array","items":{"type":"string","enum":["admin","author","publish","develop","basic_author","basic_publish","config","config_admin"]}}},"required":["id","email","roles"],"additionalProperties":false},"users":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/users","title":"users","type":"array","items":{"$ref":"#/components/schemas/user"}},"groups":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/groups","type":"object","title":"Groups","patternProperties":{"^[a-zA-Z0-9-_=]+$":{"type":"object","title":"Group","description":"A group of members. Can be referenced in access.admin.role.","properties":{"members":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","format":"email"},"name":{"type":"string"}},"required":["email"]}}},"additionalProperties":false,"required":["members"]}},"additionalProperties":false},"tokens":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/tokens","title":"tokens","type":"object","patternProperties":{"^[a-zA-Z0-9-_=]+$":{"type":"object","properties":{"id":{"type":"string","pattern":"^[a-zA-Z0-9-_=]+$"},"hash":{"type":"string","pattern":"^[a-zA-Z0-9-_=]+$"},"created":{"type":"string","format":"date-time"}},"additionalProperties":false}},"additionalProperties":false},"org-access":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/org/access","$schema":"https://json-schema.org/draft/2019-09/schema","title":"Org Access Config","type":"object","properties":{"admin":{"type":"object","properties":{"apiKeyId":{"description":"the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them.","type":"array","items":{"type":"string"}}},"additionalProperties":false}},"additionalProperties":false},"org":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/org","title":"Helix Org Config","type":"object","properties":{"version":{"type":"integer","enum":[1],"default":1},"title":{"$ref":"#/components/schemas/title"},"description":{"$ref":"#/components/schemas/description"},"users":{"$ref":"#/components/schemas/users"},"groups":{"$ref":"#/components/schemas/groups"},"tokens":{"$ref":"#/components/schemas/tokens"},"access":{"$ref":"#/components/schemas/org-access"}},"required":["version"],"additionalProperties":false},"orgConfigUser":{"type":"object","description":"org user","required":["email","roles"],"properties":{"email":{"description":"email of the user","type":"string"},"roles":{"description":"role of the user","type":"array","items":{"type":"string","enum":["admin","author","publish","develop","basic_author","basic_publish","config","config_admin"]}}}},"orgConfigUsers":{"type":"array","description":"org users","items":{"$ref":"#/components/schemas/orgConfigUser"}},"content-source-google":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/content-source/google","title":"Google Content Source","type":"object","properties":{"type":{"const":"google"},"url":{"type":"string","format":"uri"},"id":{"description":"Google drive ID of the root folder; updated automatically when updating the url.","type":"string"}},"required":["type","url","id"],"additionalProperties":false},"content-source-onedrive":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/content-source/onedrive","title":"Onedrive Content Source","type":"object","properties":{"type":{"const":"onedrive"},"url":{"type":"string","format":"uri"},"tenantId":{"type":"string"},"itemId":{"description":"onedrive item ID of the root folder; currently not required as we don't know how setup will work.","type":"string"}},"required":["type","url"],"additionalProperties":false},"content-source-markup":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/content-source/markup","title":"Markup Content Source","type":"object","properties":{"type":{"const":"markup"},"url":{"type":"string","format":"uri"},"suffix":{"type":"string"}},"required":["type","url"],"additionalProperties":false},"content":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/content","type":"object","title":"Content source","description":"Defines the content bus location and source.","properties":{"title":{"$ref":"#/components/schemas/title"},"description":{"$ref":"#/components/schemas/description"},"contentBusId":{"type":"string"},"source":{"oneOf":[{"$ref":"#/components/schemas/content-source-google"},{"$ref":"#/components/schemas/content-source-onedrive"},{"$ref":"#/components/schemas/content-source-markup"}]},"overlay":{"oneOf":[{"$ref":"#/components/schemas/content-source-markup"}]}},"required":["contentBusId","source"],"additionalProperties":false},"code":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/code","title":"Code source","type":"object","description":"Defines the code bus location and source.","properties":{"title":{"$ref":"#/components/schemas/title"},"description":{"$ref":"#/components/schemas/description"},"owner":{"$comment":"Note, that owner/repo are no longer part of the hostname and can therefor have more allowed characters than in helix4","type":"string","pattern":"[a-zA-Z0-9_-]+"},"repo":{"type":"string","pattern":"[a-zA-Z0-9_-]+"},"source":{"type":"object","properties":{"type":{"const":"github"},"url":{"type":"string","format":"uri"}},"required":["type","url"],"additionalProperties":false}},"required":["owner","repo","source"]},"folders":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/folders","type":"object","title":"folders","patternProperties":{"^/[a-zA-Z0-9-/.]*$":{"type":"string"}},"additionalProperties":false},"keyValuePair":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"],"additionalProperties":false},"headers":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/headers","type":"object","title":"Helix Headers Config","patternProperties":{"^[a-zA-Z0-9-/._*]+$":{"type":"array","items":{"$ref":"#/components/schemas/keyValuePair"}}},"additionalProperties":false},"cdn-prod-fastly":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/cdn/prod/fastly","$schema":"https://json-schema.org/draft/2019-09/schema","title":"Fastly CDN Config","type":"object","description":"Production CDN configuration for Fastly","properties":{"type":{"type":"string","const":"fastly"},"host":{"description":"production host","type":"string"},"route":{"description":"Routes on the CDN that are rendered with Franklin","type":"array","items":{"type":"string"}},"serviceId":{"description":"The Fastly Service ID","type":"string"},"authToken":{"description":"A Fastly token for purging","type":"string"}},"required":["type","host","serviceId","authToken"],"additionalProperties":false},"cdn-prod-cloudflare":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/cdn/prod/cloudflare","$schema":"https://json-schema.org/draft/2019-09/schema","title":"Cloudflare CDN Config","type":"object","properties":{"type":{"type":"string","const":"cloudflare"},"host":{"description":"production host","type":"string"},"route":{"description":"Routes on the CDN that are rendered with Franklin","type":"array","items":{"type":"string"}},"plan":{"type":"string"},"zoneId":{"type":"string"},"apiToken":{"type":"string"}},"required":["type","host","plan","zoneId","apiToken"],"additionalProperties":false},"cdn-prod-akamai":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/cdn/prod/akamai","$schema":"https://json-schema.org/draft/2019-09/schema","title":"Akamai CDN Config","type":"object","properties":{"type":{"type":"string","const":"akamai"},"host":{"description":"production host","type":"string"},"route":{"description":"Routes on the CDN that are rendered with Franklin","type":"array","items":{"type":"string"}},"endpoint":{"type":"string"},"clientSecret":{"type":"string"},"clientToken":{"type":"string"},"accessToken":{"type":"string"}},"required":["type","host","endpoint","clientSecret","clientToken","accessToken"],"additionalProperties":false},"cdn-prod-managed":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/cdn/prod/managed","$schema":"https://json-schema.org/draft/2019-09/schema","title":"Managed CDN Config","type":"object","properties":{"type":{"type":"string","const":"managed"},"host":{"description":"production host","type":"string"},"route":{"description":"Routes on the CDN that are rendered with Franklin","type":"array","items":{"type":"string"}}},"required":["type","host"],"additionalProperties":false},"cdn-prod-cloudfront":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/cdn/prod/cloudfront","$schema":"https://json-schema.org/draft/2019-09/schema","title":"Cloudfront CDN Config","type":"object","properties":{"type":{"type":"string","const":"cloudfront"},"host":{"description":"production host","type":"string"},"route":{"description":"Routes on the CDN that are rendered with Franklin","type":"array","items":{"type":"string"}},"distributionId":{"type":"string"},"accessKeyId":{"type":"string"},"secretAccessKey":{"type":"string"}},"required":["type","host","distributionId","accessKeyId","secretAccessKey"],"additionalProperties":false},"cdn":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/cdn","$schema":"https://json-schema.org/draft/2019-09/schema","title":"CDN Config","type":"object","properties":{"prod":{"oneOf":[{"$ref":"#/components/schemas/cdn-prod-fastly"},{"$ref":"#/components/schemas/cdn-prod-cloudflare"},{"$ref":"#/components/schemas/cdn-prod-akamai"},{"$ref":"#/components/schemas/cdn-prod-managed"},{"$ref":"#/components/schemas/cdn-prod-cloudfront"},{"type":"object","title":"EmptyConfig","properties":{"host":{"description":"production host","type":"string"}},"required":["host"],"additionalProperties":false}]},"live":{"type":"object","properties":{"host":{"description":"Sidekick config to override the default preview host. it supports parameters $owner and $repo","examples":["main--$repo--page.example.com"],"type":"string"}},"required":["host"],"additionalProperties":false},"preview":{"type":"object","properties":{"host":{"description":"Sidekick config to override the default live host. it supports parameters $owner and $repo","examples":["main--$repo--live.example.com\""],"type":"string"}},"required":["host"],"additionalProperties":false}},"additionalProperties":false},"access-admin":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/access/admin","$schema":"https://json-schema.org/draft/2019-09/schema","title":"Admin Access Config","type":"object","properties":{"role":{"title":"Role","type":"object","patternProperties":{"^[a-z-_]+$":{"description":"The email glob of the users or a group reference for the respective role.","type":"array","items":{"type":"string"}}},"additionalProperties":false},"requireAuth":{"description":"Enforce authentication if set to true. If set to 'auto' it will enforce authentication if a role mapping is defined. defaults to 'auto'.","default":"auto","oneOf":[{"type":"boolean"},{"type":"string","enum":["auto"]}]},"defaultRole":{"description":"the default roles assigned to the users. defaults to `basic_publish` for unauthenticated setups.","type":"array","items":{"type":"string","enum":["admin","author","publish","develop","basic_author","basic_publish","config","config_admin"]}},"apiKeyId":{"description":"the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them.","type":"array","items":{"type":"string"}}},"additionalProperties":false},"access-site":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/access/site","$schema":"https://json-schema.org/draft/2019-09/schema","title":"Site Access Config","type":"object","properties":{"allow":{"description":"The email glob of the users or a group reference that are allowed access","type":"array","items":{"type":"string"}},"apiKeyId":{"description":"IDs of the api keys (tokens) that are allowed.","type":"array","items":{"type":"string"}},"clientCertDN":{"description":"the DNs of the client certificates that are allowed.","type":"array","items":{"type":"string"}}},"additionalProperties":false},"access":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/access","type":"object","title":"Access","properties":{"admin":{"$ref":"#/components/schemas/access-admin"},"site":{"$ref":"#/components/schemas/access-site"},"preview":{"$ref":"#/components/schemas/access-site"},"live":{"$ref":"#/components/schemas/access-site"}},"additionalProperties":false},"sidekickPlugin":{"type":"object","properties":{"id":{"type":"string","description":"The unique plugin ID"},"title":{"type":"string","description":"The button text"},"url":{"type":"string","description":"The URL to open when the button is clicked"},"containerId":{"type":"string","description":"The ID of the container to add this plugin to"},"environments":{"type":"array","items":{"type":"string","enum":["any","dev","admin","edit","preview","live","prod"]},"description":"The environments to display this plugin in","default":"any"},"event":{"type":"string","description":"The name of a custom event to fire when the button is clicked (defaults to id)"},"excludePaths":{"type":"array","items":{"type":"string"},"description":"Exclude the plugin from these paths","examples":["/foo/**","**/:x:**"]},"includePaths":{"type":"array","items":{"type":"string"},"description":"Include the plugin on these paths (overrides excludePaths)","examples":["/foo/bar/**","**.docx**"]},"isContainer":{"type":"boolean","description":"Turns the plugin into a container for other plugins"},"isPalette":{"type":"boolean","description":"Opens the URL in a palette instead of a new tab"},"paletteRect":{"type":"string","description":"he dimensions and position of a palette box"},"titleI18n":{"type":"object","description":"The button text in other supported languages","patternProperties":{"^[a-z]{2}(-[A-Z]{2})?$":{"type":"string","description":"ISO language code (`en` or `en-US`) with translated button text"}},"minProperties":1,"additionalProperties":false},"passConfig":{"type":"boolean","description":"Append ref, repo, owner, host, and project as query params on new URL button click"},"passReferrer":{"type":"boolean","description":"Append the referrer URL as a query param on new URL button click"}},"required":["id"],"dependentRequired":{"isPalette":["url"],"paletteRect":["isPalette"]}},"sidekick":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$id":"https://ns.adobe.com/helix/config/sidekick","$schema":"https://json-schema.org/draft/2019-09/schema","definitions":{"sidekickPlugin":{"type":"object","properties":{"id":{"type":"string","description":"The unique plugin ID"},"title":{"type":"string","description":"The button text"},"url":{"type":"string","description":"The URL to open when the button is clicked"},"containerId":{"type":"string","description":"The ID of the container to add this plugin to"},"environments":{"type":"array","items":{"type":"string","enum":["any","dev","admin","edit","preview","live","prod"]},"description":"The environments to display this plugin in","default":"any"},"event":{"type":"string","description":"The name of a custom event to fire when the button is clicked (defaults to id)"},"excludePaths":{"type":"array","items":{"type":"string"},"description":"Exclude the plugin from these paths","examples":["/foo/**","**/:x:**"]},"includePaths":{"type":"array","items":{"type":"string"},"description":"Include the plugin on these paths (overrides excludePaths)","examples":["/foo/bar/**","**.docx**"]},"isContainer":{"type":"boolean","description":"Turns the plugin into a container for other plugins"},"isPalette":{"type":"boolean","description":"Opens the URL in a palette instead of a new tab"},"paletteRect":{"type":"string","description":"he dimensions and position of a palette box"},"titleI18n":{"type":"object","description":"The button text in other supported languages","patternProperties":{"^[a-z]{2}(-[A-Z]{2})?$":{"type":"string","description":"ISO language code (`en` or `en-US`) with translated button text"}},"minProperties":1,"additionalProperties":false},"passConfig":{"type":"boolean","description":"Append ref, repo, owner, host, and project as query params on new URL button click"},"passReferrer":{"type":"boolean","description":"Append the referrer URL as a query param on new URL button click"}},"required":["id"],"dependentRequired":{"isPalette":["url"],"paletteRect":["isPalette"]}}},"title":"Sidekick Config","type":"object","properties":{"plugins":{"type":"array","items":{"$ref":"#/components/schemas/sidekickPlugin"}}}},"metadata-source":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/metadata-source","type":"object","title":"metadata","properties":{"source":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"robots":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/robots","type":"object","title":"robots","properties":{"txt":{"type":"string"}},"additionalProperties":false},"public":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/public","type":"object","title":"public","description":"Public configuration"},"site":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/site","title":"Helix Site Config","type":"object","properties":{"version":{"type":"integer","enum":[1],"default":1},"name":{"type":"string","description":"Site name; part of the hostname","pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"},"title":{"$ref":"#/components/schemas/title"},"description":{"$ref":"#/components/schemas/description"},"content":{"$ref":"#/components/schemas/content"},"code":{"$ref":"#/components/schemas/code"},"folders":{"$ref":"#/components/schemas/folders"},"headers":{"$ref":"#/components/schemas/headers"},"cdn":{"$ref":"#/components/schemas/cdn"},"access":{"$ref":"#/components/schemas/access"},"tokens":{"$ref":"#/components/schemas/tokens"},"groups":{"$ref":"#/components/schemas/groups"},"sidekick":{"$ref":"#/components/schemas/sidekick"},"metadata":{"$ref":"#/components/schemas/metadata-source"},"robots":{"$ref":"#/components/schemas/robots"},"public":{"$ref":"#/components/schemas/public"},"extends":{"type":"object","properties":{"profile":{"type":"string","pattern":"^[0-9a-zA-Z-_]+$"}},"additionalProperties":false}},"required":["version","content","code"],"additionalProperties":false},"profile":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/profile","title":"Helix Profile Config","type":"object","properties":{"version":{"type":"integer","enum":[1],"default":1},"title":{"$ref":"#/components/schemas/title"},"description":{"$ref":"#/components/schemas/description"},"content":{"$ref":"#/components/schemas/content"},"code":{"$ref":"#/components/schemas/code"},"folders":{"$ref":"#/components/schemas/folders"},"headers":{"$ref":"#/components/schemas/headers"},"cdn":{"$ref":"#/components/schemas/cdn"},"access":{"$ref":"#/components/schemas/access"},"tokens":{"$ref":"#/components/schemas/tokens"},"groups":{"$ref":"#/components/schemas/groups"},"sidekick":{"$ref":"#/components/schemas/sidekick"},"metadata":{"$ref":"#/components/schemas/metadata-source"},"robots":{"$ref":"#/components/schemas/robots"},"public":{"$ref":"#/components/schemas/public"}},"required":["version"],"additionalProperties":false},"indexconfig":{"$id":"https://ns.adobe.com/helix/shared/indexconfig","$schema":"http://json-schema.org/draft-07/schema#","title":"Index Configuration","type":"object","properties":{"version":{"type":"integer","enum":[1],"default":1},"indices":{"type":"object","patternProperties":{"^[a-zA-Z0-9-_=]+$":{"title":"An individual index","type":"object","properties":{"include":{"type":"array","title":"Include","description":"Glob patterns for paths where this index is used.","items":{"type":"string"},"examples":["/blog/**","/en/publish/*/*/*/*"]},"exclude":{"type":"array","title":"Exclude","description":"Glob patterns for paths where this index must not be used.","items":{"type":"string"},"examples":["/drafts/**"]},"target":{"type":"string","format":"uri-reference","description":"The data sink to store the extracted data in. This can be an Excel workbook, a Google spreadsheet or an S3 object"},"properties":{"type":"object","title":"Properties","description":"The properties to add to the index","patternProperties":{"^[a-zA-Z0-9-_=]+$":{"type":"object","title":"Property","oneOf":[{"title":"Single-Value Property","description":"The property in an index. The value will be stored as a single cardinal value.","type":"object","properties":{"selectFirst":{"type":"string","description":"A CSS selector expression that selects the first matching node in the HTML (DOM) or Markdown (MDAST) syntax tree"},"value":{"type":"string","description":"A ES6 template literal expression that extracts the value from the matching node(s) to be stored in the index"}},"additionalProperties":false,"required":["selectFirst","value"]},{"title":"Multi-value property, concatenated to a single value","description":"The property in an index. The value will be stored as a single cardinal value.","type":"object","properties":{"select":{"type":"string","description":"A CSS selector expression that selects all matching nodes in the HTML (DOM) or Markdown (MDAST) syntax tree"},"value":{"type":"string","description":"A ES6 template literal expression that extracts the value from the matching node(s) to be stored in the index"}},"additionalProperties":false,"required":["select","value"]},{"title":"Multi-Value Property","description":"The property in an index. The value will be stored as a list of values","type":"object","properties":{"select":{"type":"string","description":"A CSS selector expression that selects all matching nodes in the HTML (DOM) or Markdown (MDAST) syntax tree"},"values":{"type":"string","description":"A ES6 template literal expression that extracts the values from the matching nodes to be stored in the index"}},"additionalProperties":false,"required":["select","values"]}]}}}},"required":["properties"]}}}}},"hreflang":{"type":"string","title":"HREF Language","description":"The HREF language to use when listing alternates according to [RFC 5988](https://datatracker.ietf.org/doc/html/rfc5988).","pattern":"^((?:(en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang))|((?:([A-Za-z]{2,3}(-(?:[A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-(?:[A-Za-z]{4}))?(-(?:[A-Za-z]{2}|[0-9]{3}))?(-(?:[A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-(?:[0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(?:x(-[A-Za-z0-9]{1,8})+))?)|(?:x(-[A-Za-z0-9]{1,8})+))$"},"sitemapconfig":{"$id":"https://ns.adobe.com/helix/shared/sitemapconfig","$schema":"http://json-schema.org/draft-07/schema#","title":"Sitemap Configuration","$defs":{"hreflang":{"type":"string","title":"HREF Language","description":"The HREF language to use when listing alternates according to [RFC 5988](https://datatracker.ietf.org/doc/html/rfc5988).","pattern":"^((?:(en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang))|((?:([A-Za-z]{2,3}(-(?:[A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-(?:[A-Za-z]{4}))?(-(?:[A-Za-z]{2}|[0-9]{3}))?(-(?:[A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-(?:[0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(?:x(-[A-Za-z0-9]{1,8})+))?)|(?:x(-[A-Za-z0-9]{1,8})+))$"}},"type":"object","properties":{"version":{"type":"integer","enum":[1],"default":1},"sitemaps":{"type":"object","patternProperties":{"^[a-zA-Z0-9-_=]+$":{"type":"object","properties":{"source":{"type":"string","title":"Source","description":"The source resource path to get records from. These records should at least contain a path property."},"origin":{"type":"string","title":"Origin","description":"The origin to prepend to paths found in the source."},"destination":{"type":"string","title":"Path","description":"The destination resource path to store sitemap to."},"lastmod":{"type":"string","title":"Lastmod","description":"The format to use for last modification of a location. If not present, no last modification is added.","examples":["YYYY-MM-DD","YYYY-MM-DD hh:mm:ss"]},"languages":{"type":"object","title":"Sitemap Languages","description":"The languages to add to the sitemap","patternProperties":{"^[a-zA-Z0-9-_=]+$":{"properties":{"source":{"type":"string","title":"Source","description":"The source resource path to get records from. These records should at least contain a path property."},"destination":{"type":"string","title":"Path","description":"The destination resource path to store sitemap to."},"hreflang":{"anyOf":[{"$ref":"#/components/schemas/hreflang"},{"type":"array","items":{"$ref":"#/components/schemas/hreflang"}}]},"alternate":{"type":"string","title":"Alternate","description":"How to compute the respective path in that language. If not present, paths do not contain a language specific part.","examples":["/{path}","/en/{path}","/german/{path}"]},"extension":{"type":"string","title":"Location extension","description":"Extension to append to every location generated for this sitemap. Default is empty","examples":[".html"]}},"required":["destination","hreflang"]}}},"extension":{"type":"string","title":"Location extension","description":"Extension to append to every location generated for this sitemap. Default is empty","examples":[".html"]}},"required":[]}}}}},"sites":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/sites","title":"Helix Sites List","type":"object","properties":{"sites":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false}}},"required":["sites"],"additionalProperties":false},"profiles":{"$comment":"https://github.com/adobe/helix-config/blob/main/LICENSE.txt","$schema":"https://json-schema.org/draft/2019-09/schema","$id":"https://ns.adobe.com/helix/config/profiles","title":"Helix Profiles List","type":"object","properties":{"profiles":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false}}},"required":["profiles"],"additionalProperties":false}},"parameters":{"ownerParam":{"name":"owner","in":"path","description":"Repository owner.","required":true,"schema":{"type":"string"}},"repoParam":{"name":"repo","in":"path","description":"Name of the repository","required":true,"schema":{"type":"string"}},"refParam":{"name":"ref","in":"path","description":"Ref (branch) of repository.","required":true,"schema":{"type":"string"}},"pathParam":{"name":"path","in":"path","description":"Relative path of the resource","required":true,"schema":{"type":"string"}},"statusEditUrlParam":{"name":"editUrl","in":"query","description":"Optional URL of the edit (authoring) document","required":false,"schema":{"oneOf":[{"type":"string","format":"url"},{"type":"string","enum":["auto"]}]}},"forceUpdateRedirectsParam":{"name":"forceUpdateRedirects","in":"query","description":"forces an update of the redirects (only applies when updating/publishing redirects.json)","required":false,"schema":{"type":"boolean"}},"disableNotificationsParam":{"name":"disableNotifications","in":"query","description":"disables notifications for affected resources","schema":{"type":"boolean"}},"word2mdVersionParam":{"name":"hlx-word2md-version","in":"query","description":"selects the version to use when invoking the word2md service.","required":false,"schema":{"type":"string"}},"gdocs2mdVersionParam":{"name":"hlx-gdocs2md-version","in":"query","description":"selects the version to use when invoking the gdocs2md service.","required":false,"schema":{"type":"string"}},"html2mdVersionParam":{"name":"hlx-html2md-version","in":"query","description":"selects the version to use when invoking the html2md service.","required":false,"schema":{"type":"string"}},"branchParam":{"name":"branch","in":"query","description":"Optional branch specifier in case the branch name contains slashes or uppercase characters.","required":false,"schema":{"oneOf":[{"type":"string","format":"url"},{"type":"string","enum":["auto"]}]}},"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"}},"sinceParam":{"name":"since","in":"query","description":"Indicates the time span to retrieve logs for, as a number and a unit in short notation (`s`, `m`, `h` or `d`). Not usable in combination with either `from` or `to`.\n","required":false,"schema":{"type":"string","example":"5m"}},"nextTokenParam":{"name":"nextToken","in":"query","description":"Token returned from a previous call to continue\n","required":false,"schema":{"type":"string"}},"snIdParam":{"name":"snapshotId","in":"path","description":"Id of the snapshot","required":true,"schema":{"type":"string"}},"snFilterParam":{"name":"filter","in":"query","description":"Filters the resources that are selected for snapshot. If set to `modified` only the resources that have a preview date newer than the live date are selected.\n","schema":{"enum":["all","modified"],"default":"all"}},"snPublishParam":{"name":"publish","in":"query","description":"Indicates that the snapshot should be published.\n","schema":{"enum":["true"]}},"snReviewParam":{"name":"review","in":"query","description":"State to move the snapshot into.\n","schema":{"enum":["request","approve","reject"]}},"snReviewMessageParam":{"name":"message","in":"query","description":"Message of the review action, included in logs and events.\n","schema":{"type":"string"}},"orgParam":{"name":"org","in":"path","description":"organisation name.","required":true,"schema":{"type":"string"}},"userIdParam":{"name":"id","in":"path","description":"user id.","required":true,"schema":{"type":"string"}},"siteParam":{"name":"site","in":"path","description":"site id.","required":true,"schema":{"type":"string"}},"migrateParam":{"name":"migrate","in":"query","description":"indicates to migrate the config.","required":false,"schema":{"type":"boolean"}},"validateParam":{"name":"validate","in":"query","description":"indicates to validate the config to be migrated. only effective when `migrate` is set to `true`.","required":false,"schema":{"type":"boolean"}},"tokenIdParam":{"name":"id","in":"path","description":"access token id.","required":true,"schema":{"type":"string"}},"profileParam":{"name":"profile","in":"path","description":"profile name.","required":true,"schema":{"type":"string"}}},"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"}}},"409":{"description":"Conflict. The requested operation is not allowed by the current state of the resource.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"429":{"description":"Rate limited by admin service. see https://www.aem.live/docs/limits#admin-api-limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"500":{"description":"Operation failed due to an internal error.","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}},"503":{"description":"Rate limit / Timeout reached from underlying content source (eg. sharepoint, google docs, BYOM). see https://www.aem.live/docs/limits","headers":{"X-Error":{"$ref":"#/components/headers/xError"}}}},"examples":{"example":{"summary":"fetch status of multiple files","value":{"select":["edit","preview","live"],"paths":["/en","/en/*","/blog/"]}},"bulk-publish-payload_example":{"summary":"publish multiple files","value":{"forceUpdate":true,"paths":["/en","/metadata.json","/blog/"],"delete":false}},"bulk-preview-payload_example":{"summary":"preview multiple files","value":{"forceUpdate":true,"paths":["/en","/en/*","/metadata.json","/blog/"],"delete":false}},"change-event-payload_example":{"summary":"Multiple files event example","value":{"type":"github","baseRef":"","installationId":995843,"changes":[{"path":"new-file.txt","time":"2021-05-04T13:40:15+09:00","type":"added","contentType":"text/plain; charset=utf-8","commit":"5edf98811d50b5b948f6f890f0c4367095490dbd"},{"path":"src/html.htl","time":"2021-05-04T13:40:15+09:00","type":"deleted","contentType":"application/octet-stream","commit":"5edf98811d50b5b948f6f890f0c4367095490dbd"},{"path":"README.md","time":"2021-05-04T13:40:15+09:00","type":"modified","contentType":"text/markdown; charset=utf-8","commit":"5edf98811d50b5b948f6f890f0c4367095490dbd"},{"path":"fail.md","time":"2021-05-04T13:40:15+09:00","type":"modified","contentType":"text/markdown; charset=utf-8","commit":"5edf98811d50b5b948f6f890f0c4367095490dbd"}]}},"multiple-paths":{"summary":"snapshot multiple files","value":{"forceUpdate":true,"paths":["/en","/blog/"]}},"wildcard":{"summary":"snapshot multiple files with wildcard","value":{"forceUpdate":false,"paths":["/en/*"]}}}},"x-tagGroups":[{"name":"Authoring and Publishing","tags":["status","publish","preview","code","cache","index","sitemap","snapshot"]},{"name":"Operations","tags":["authentication","log","job"]},{"name":"Configuration Management","tags":["orgConfig","siteConfig","profileConfig","indexConfig","sitemapConfig"]}]}},"searchIndex":{"store":["tag/status","tag/status/operation/status","tag/status/operation/bulkStatus","tag/publish","tag/publish/operation/getPublishStatus","tag/publish/operation/publishResource","tag/publish/operation/unpublishResource","tag/publish/operation/bulkPublish","tag/preview","tag/preview/operation/previewStatus","tag/preview/operation/updatePreview","tag/preview/operation/deletePreview","tag/preview/operation/bulkPreview","tag/code","tag/code/operation/codeStatus","tag/code/operation/updateCode","tag/code/operation/deleteCode","tag/code/operation/batchCode","tag/cache","tag/cache/operation/purgeCache","tag/index","tag/index/operation/getIndexStatus","tag/index/operation/indexResource","tag/index/operation/indexRemovePage","tag/sitemap","tag/sitemap/operation/generateSitemap","tag/snapshot","tag/snapshot/operation/listSnapshots","tag/snapshot/operation/getSnapshotManifest","tag/snapshot/operation/updateSnapshotManifest","tag/snapshot/operation/getSnapshot","tag/snapshot/operation/createSnapshot","tag/snapshot/operation/deleteSnapshot","tag/snapshot/operation/bulkSnapshot","tag/snapshot/operation/publishSnapshotResource","tag/snapshot/operation/publishSnapshot","tag/snapshot/operation/reviewSnapshot","tag/authentication","tag/authentication/operation/login","tag/authentication/operation/login-repo","tag/authentication/operation/logout","tag/authentication/operation/profile","tag/log","tag/log/operation/getLogs","tag/log/operation/addLogs","tag/job","tag/job/operation/getJobList","tag/job/operation/getJob","tag/job/operation/stopJob","tag/job/operation/getJobDetails","tag/orgConfig","schema/OrgConfig","schema/GroupsConfig","tag/orgConfig/operation/getConfigOrg","tag/orgConfig/operation/updateConfigOrg","tag/orgConfig/operation/createConfigOrg","tag/orgConfig/operation/deleteConfigOrg","tag/orgConfig/operation/listOrgUsers","tag/orgConfig/operation/updateOrgUser","tag/orgConfig/operation/readOrgUser","tag/orgConfig/operation/deleteOrgUser","tag/siteConfig","schema/SiteConfig","schema/SiteConfigList","schema/AdminAccessConfig","schema/SiteAccessConfig","schema/AccessConfig","schema/CDNConfig","schema/CodeConfig","schema/ContentConfig","schema/FoldersConfig","schema/HeadersConfig","schema/MetadataConfig","schema/PublicConfig","schema/GroupsConfig","schema/RobotsConfig","schema/SidekickConfig","schema/TokensConfig","tag/siteConfig/operation/getConfigSites","tag/siteConfig/operation/getConfigSite","tag/siteConfig/operation/updateConfigSite","tag/siteConfig/operation/createSiteSite","tag/siteConfig/operation/deleteConfigSite","tag/siteConfig/operation/getConfigSiteRobots","tag/siteConfig/operation/updateConfigSiteRobots","tag/siteConfig/operation/listSiteTokens","tag/siteConfig/operation/updateSiteToken","tag/siteConfig/operation/readSiteToken","tag/siteConfig/operation/deleteSiteToken","tag/siteConfig/operation/getAggregatedConfigSite","tag/profileConfig","schema/ProfileConfig","schema/ProfileConfigList","schema/AdminAccessConfig","schema/SiteAccessConfig","schema/AccessConfig","schema/CDNConfig","schema/CodeConfig","schema/ContentConfig","schema/FoldersConfig","schema/HeadersConfig","schema/MetadataConfig","schema/PublicConfig","schema/RobotsConfig","schema/SidekickConfig","schema/TokensConfig","tag/profileConfig/operation/getConfigProfiles","tag/profileConfig/operation/getConfigProfile","tag/profileConfig/operation/updateConfigProfile","tag/profileConfig/operation/createConfigProfile","tag/profileConfig/operation/deleteConfigProfile","tag/profileConfig/operation/getConfigProfileRobots","tag/profileConfig/operation/updateConfigProfileRobots","tag/profileConfig/operation/listProfileTokens","tag/profileConfig/operation/updateProfileToken","tag/profileConfig/operation/readProfileToken","tag/profileConfig/operation/deleteProfileToken","tag/indexConfig","schema/IndexConfig","tag/indexConfig/operation/getIndexConfig","tag/indexConfig/operation/updateIndexConfig","tag/indexConfig/operation/createIndexConfig","tag/indexConfig/operation/deleteIndexConfig","tag/sitemapConfig","schema/SitemapConfig","tag/sitemapConfig/operation/getSitemapConfig","tag/sitemapConfig/operation/updateSitemapConfig","tag/sitemapConfig/operation/createSitemapConfig","tag/sitemapConfig/operation/deleteSitemapConfig"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,2.355]],["description/0",[0,2.639,1,3.346]],["title/1",[0,1.89,2,3.441]],["description/1",[0,1.262,3,0.991,4,3.05,5,1.864,6,0.991,7,3.05,8,3.05,9,2.299,10,2.047,11,3.05,12,2.7,13,1.95,14,3.05,15,3.05,16,3.05,17,3.05]],["title/2",[0,1.354,18,2.466,19,1.999,20,1.513]],["description/2",[0,1.04,3,0.468,6,0.816,19,0.88,21,1.167,22,0.921,23,1.883,24,1.893,25,1.275,26,1.021,27,0.361,28,1.275,29,1.167,30,1.085,31,1.44,32,1.78,33,1.78,34,1.44,35,2.367,36,1.44,37,1.44,38,1.44,39,1.44,40,1.44,41,1.44,42,1.44,43,1.44,44,0.708,45,0.921,46,1.085,47,1.44,48,0.921,49,1.021,50,1.085,51,0.756,52,1.44,53,1.44]],["title/3",[54,2.797]],["description/3",[1,3.346,54,3.134]],["title/4",[0,1.89,54,2.244]],["description/4",[0,2.012,3,1.579,5,2.971,6,1.579,54,2.389,55,3.938]],["title/5",[6,1.483,54,2.244]],["description/5",[6,1.393,13,1.754,44,1.348,45,1.754,54,1.348,55,2.222,56,2.222,57,2.879,58,2.741,59,1.754,60,1.608,61,1.677,62,2.418,63,1.677,64,0.912]],["title/6",[6,1.483,65,4.042]],["description/6",[6,1.029,13,2.025,45,2.025,55,2.566,57,2.127,58,2.025,59,2.025,60,1.857,61,1.936,62,2.701,63,1.936,64,1.053,65,2.805,66,1.51]],["title/7",[18,2.466,19,1.999,20,1.513,54,1.608]],["description/7",[3,0.545,6,0.93,10,1.125,19,1.75,20,0.775,22,1.071,23,0.945,24,2.158,35,1.188,45,1.071,48,1.83,49,1.188,50,1.263,51,0.88,54,0.824,64,0.557,67,1.251,68,1.484,69,1.358,70,1.071,71,1.358,72,1.358,73,1.358,74,1.358,75,1.484,76,1.484,77,1.484,78,1.484,79,1.484,80,1.484,81,1.676,82,1.125,83,1.676]],["title/8",[44,2.797]],["description/8",[1,3.346,44,3.134]],["title/9",[0,1.89,44,2.244]],["description/9",[0,2.012,3,1.579,5,2.971,6,1.579,44,2.389,84,3.938]],["title/10",[44,2.244,67,1.995]],["description/10",[6,0.991,13,2.975,21,2.47,44,2.287,67,1.333,84,2.47,85,2.7,86,2.47,87,3.05,88,3.05,89,3.05,90,3.05,91,3.05,92,2.299]],["title/11",[44,2.244,66,2.176]],["description/11",[6,1.491,44,3.074,57,3.08,58,2.933,66,2.187,84,3.717]],["title/12",[18,2.466,19,1.999,20,1.513,44,1.608]],["description/12",[3,0.476,6,0.829,10,0.984,19,1.559,20,0.678,22,0.937,23,1.438,24,1.923,25,1.298,26,1.039,27,0.367,28,1.298,29,1.187,30,1.105,35,1.039,44,1.254,48,1.631,49,1.039,50,1.105,51,0.769,64,0.487,67,1.115,69,1.187,70,0.937,71,1.187,72,1.187,73,1.187,74,1.187,75,1.298,76,1.298,77,1.298,78,1.298,79,1.298,80,1.298,82,0.984,93,1.466,94,1.466,95,1.466]],["title/13",[96,3.478]],["description/13",[1,3.104,96,3.615,97,4.791]],["title/14",[0,1.578,96,2.33,97,3.087]],["description/14",[0,1.899,3,1.491,5,2.805,6,1.491,96,2.805,97,3.717,98,3.717]],["title/15",[67,1.995,96,2.79]],["description/15",[5,1.288,6,0.685,13,1.347,21,1.707,23,1.188,27,0.528,30,1.588,59,1.347,60,1.236,61,1.288,62,1.957,63,1.288,64,0.7,67,1.516,85,1.866,92,1.588,98,1.707,99,3.583,100,3.47,101,1.866,102,1.866,103,1.866,104,2.107]],["title/16",[66,2.176,96,2.79]],["description/16",[6,1.164,59,2.291,60,2.101,61,2.191,62,2.961,63,2.191,64,1.191,66,1.708,96,2.191,98,2.903,99,2.903]],["title/17",[67,1.665,96,2.33,105,3.375]],["description/17",[59,2.107,60,1.932,61,2.014,62,2.782,63,2.014,64,1.095,67,1.44,99,2.669,106,3.295,107,2.918,108,2.918,109,3.295,110,3.295]],["title/18",[111,4.609]],["description/18",[1,3.346,111,5.164]],["title/19",[45,2.436,60,2.235,111,3.087]],["description/19",[5,2.099,6,1.116,60,2.983,61,2.099,62,2.869,63,2.099,64,1.141,112,3.04,113,3.433,114,3.433,115,3.433]],["title/20",[116,2.888]],["description/20",[1,3.346,116,3.236]],["title/21",[0,1.89,116,2.317]],["description/21",[0,2.012,3,1.579,5,2.971,6,1.579,116,2.467,117,3.938]],["title/22",[6,1.483,118,4.565]],["description/22",[6,1.603,23,1.858,27,0.826,30,2.484,54,1.62,101,2.918,102,2.918,103,2.918,116,1.673,117,2.669,119,3.295,120,2.918,121,3.295]],["title/23",[6,1.238,116,1.934,122,3.375]],["description/23",[6,1.792,116,2.8,117,4.468,122,4.884]],["title/24",[123,3.209]],["description/24",[1,3.346,123,3.595]],["title/25",[2,3.441,123,2.574]],["description/25",[2,3.275,22,2.778,23,3.397,123,3.397,124,4.345,125,4.345]],["title/26",[126,2.237]],["description/26",[1,3.346,126,2.506]],["title/27",[126,1.794,127,2.481]],["description/27",[3,1.679,126,2.031,127,2.809,128,5.167,129,5.167]],["title/28",[126,1.794,130,3.441]],["description/28",[3,1.792,126,2.168,130,4.158,131,4.468]],["title/29",[67,1.665,126,1.498,130,2.873]],["description/29",[48,1.502,67,1.027,82,1.577,126,2.15,130,1.771,131,1.903,132,2.349,133,2.858,134,3.357,135,3.357,136,2.349,137,3.791,138,1.903,139,2.349,140,3.791,141,2.349]],["title/30",[0,1.89,126,1.794]],["description/30",[0,2.012,3,1.579,5,2.971,6,1.579,126,1.911,142,3.938]],["title/31",[6,1.238,126,1.498,143,2.873]],["description/31",[3,0.763,6,0.763,9,1.771,22,1.502,23,1.325,26,1.665,27,0.589,29,1.903,32,1.665,44,1.155,51,1.99,58,1.502,92,1.771,120,2.08,126,1.874,133,1.771,142,1.903,144,2.349,145,1.903,146,1.903,147,2.08]],["title/32",[66,2.176,126,1.794]],["description/32",[3,0.891,6,0.891,9,2.068,23,1.547,26,1.944,27,0.687,32,1.944,44,1.348,57,1.842,58,1.754,66,2.044,126,1.686,133,2.068,142,2.222,145,2.222,146,2.222,147,2.429]],["title/33",[18,2.466,19,1.999,20,1.513,126,1.286]],["description/33",[6,1.284,10,0.95,13,0.905,19,0.865,22,0.905,23,1.395,24,1.865,48,1.581,49,1.003,50,1.067,67,0.618,68,1.253,69,1.146,70,0.905,71,1.146,72,1.146,73,1.146,74,1.146,82,0.95,126,0.972,131,1.146,143,1.865,148,1.415,149,1.253,150,1.415,151,1.415,152,2.474,153,1.415,154,1.415,155,1.415,156,1.415,157,1.415,158,1.253,159,1.415,160,1.253,161,1.415,162,1.415,163,1.415]],["title/34",[6,1.238,54,1.873,126,1.498]],["description/34",[6,1.437,9,1.588,13,1.347,23,1.188,26,1.494,27,0.528,45,1.347,54,1.706,56,1.707,57,1.415,58,1.347,59,1.347,60,1.236,61,1.288,62,1.957,63,1.288,64,0.7,126,1.364,145,1.707,146,1.707,164,1.866,165,2.107,166,2.107]],["title/35",[54,2.244,126,1.794]],["description/35",[6,0.955,45,1.88,54,1.445,56,2.382,57,1.974,58,1.88,59,1.88,60,1.724,61,1.797,62,2.552,63,1.797,64,0.977,126,1.779,164,2.603,167,2.94]],["title/36",[107,2.897,126,1.286,168,2.897,169,3.271]],["description/36",[1,1.945,6,0.742,33,1.619,49,1.619,54,1.123,82,1.533,108,2.022,112,2.022,126,2.115,133,1.721,134,3.281,138,1.85,168,2.022,170,2.284,171,2.284,172,2.284,173,2.284,174,2.284,175,1.396,176,2.284]],["title/37",[177,5.038]],["description/37",[2,0.966,32,0.909,46,0.966,82,0.861,86,1.837,135,1.135,158,1.135,177,2.008,178,2.268,179,3.05,180,1.135,181,1.282,182,2.471,183,0.82,184,1.282,185,0.651,186,1.282,187,1.282,188,2.162,189,1.282,190,1.282,191,1.837,192,1.282,193,1.282,194,1.282,195,1.282,196,1.282,197,1.548,198,1.282,199,1.282,200,1.282,201,1.282,202,1.282,203,1.282,204,2.268,205,1.282,206,1.282,207,1.282,208,0.966,209,1.282]],["title/38",[46,3.441,188,3.236]],["description/38",[46,3.664,86,3.938,182,3.938,188,4.609,210,4.861]],["title/39",[188,3.236,211,4.565]],["description/39",[182,3.938,191,3.938,208,3.664,212,4.861,213,4.861,214,4.861]],["title/40",[215,5.038]],["description/40",[175,2.656,188,3.079,191,3.52,215,3.847,216,4.345,217,4.345,218,4.345,219,4.345]],["title/41",[35,3.236,220,2.317]],["description/41",[35,3.91,220,3.585,221,5.516]],["title/42",[175,3.478]],["description/42",[1,3.346,175,3.897]],["title/43",[3,1.483,175,2.79]],["description/43",[3,1.071,22,2.107,32,2.336,105,2.918,175,3.016,208,2.484,222,2.669,223,3.295,224,4.934,225,3.295,226,3.295,227,2.918]],["title/44",[143,3.441,175,2.79]],["description/44",[12,3.319,33,2.656,143,2.825,149,3.319,160,3.319,175,2.291,208,2.825,227,3.319,228,3.748,229,3.748,230,3.748]],["title/45",[20,2.632]],["description/45",[1,3.346,20,2.949]],["title/46",[20,2.112,127,2.481]],["description/46",[3,1.679,20,3.132,127,2.809,231,5.167]],["title/47",[0,1.89,20,2.112]],["description/47",[0,2.283,3,1.792,20,2.552,232,4.884]],["title/48",[20,2.112,233,4.042]],["description/48",[20,2.736,232,5.237,233,5.237]],["title/49",[0,1.578,20,1.763,234,3.811]],["description/49",[0,2.283,3,1.792,20,2.552,235,5.516]],["title/50",[236,3.441,237,1.589]],["description/50",[1,3.104,236,4.458,237,2.059]],["title/51",[238,5.69]],["description/51",[27,1.382,239,1.604,240,1.604,241,5.516]],["title/52",[242,5.038]],["description/52",[27,1.382,239,1.604,240,1.604,243,4.884]],["title/53",[237,1.327,244,2.071,245,2.701]],["description/53",[3,1.679,64,1.718,245,3.663,246,3.663,247,3.895]],["title/54",[67,1.665,237,1.327,245,2.701]],["description/54",[247,5.211]],["title/55",[51,2,237,1.327,245,2.701]],["description/55",[247,5.211]],["title/56",[66,1.816,237,1.327,245,2.701]],["description/56",[247,5.211]],["title/57",[127,2.481,183,2.918]],["description/57",[3,1.792,183,3.526,236,4.158,248,4.884]],["title/58",[51,1.717,70,2.091,183,2.091,236,2.466]],["description/58",[248,6.122]],["title/59",[183,2.918,244,2.481]],["description/59",[3,1.922,183,3.781,249,5.237]],["title/60",[66,2.176,183,2.918]],["description/60",[249,6.122]],["title/61",[237,1.589,250,2.317]],["description/61",[48,1.697,62,1.497,64,1.389,127,1.442,251,2.35,252,2.35,253,2.35,254,2.35,255,2.35,256,2.35,257,2.35,258,2.35,259,2.35,260,2.35,261,2.35,262,2.35,263,2.35,264,2.654,265,2.35]],["title/62",[266,5.69]],["description/62",[27,1.382,239,1.604,240,1.604,267,5.516]],["title/63",[268,5.69]],["description/63",[27,1.382,239,1.604,240,1.604,269,5.516]],["title/64",[270,5.038]],["description/64",[27,1.382,239,1.604,240,1.604,271,4.884]],["title/65",[272,5.038]],["description/65",[27,1.382,239,1.604,240,1.604,273,4.884]],["title/66",[274,5.038]],["description/66",[27,1.382,239,1.604,240,1.604,275,4.884]],["title/67",[276,5.038]],["description/67",[27,1.382,239,1.604,240,1.604,277,4.884]],["title/68",[278,5.038]],["description/68",[27,1.382,239,1.604,240,1.604,279,4.884]],["title/69",[280,5.038]],["description/69",[27,1.382,239,1.604,240,1.604,281,4.884]],["title/70",[282,5.038]],["description/70",[27,1.382,239,1.604,240,1.604,283,4.884]],["title/71",[284,5.038]],["description/71",[27,1.382,239,1.604,240,1.604,285,4.884]],["title/72",[286,5.038]],["description/72",[27,1.382,239,1.604,240,1.604,287,4.884]],["title/73",[288,5.038]],["description/73",[27,1.382,239,1.604,240,1.604,289,4.884]],["title/74",[242,5.038]],["description/74",[27,1.382,239,1.604,240,1.604,243,4.884]],["title/75",[290,5.038]],["description/75",[27,1.382,239,1.604,240,1.604,291,4.884]],["title/76",[292,5.038]],["description/76",[27,1.382,239,1.604,240,1.604,293,4.884]],["title/77",[294,5.038]],["description/77",[27,1.382,239,1.604,240,1.604,295,4.884]],["title/78",[127,2.071,237,1.327,250,1.934]],["description/78",[3,1.579,64,1.616,246,3.445,250,2.467,296,4.304,297,4.861]],["title/79",[237,1.327,244,2.071,250,1.934]],["description/79",[3,0.991,10,2.047,64,1.547,237,1.062,246,2.162,250,1.548,298,2.7,299,2.7,300,2.299,301,2.7,302,2.7,303,2.7,304,2.7,305,2.7,306,2.299]],["title/80",[67,1.665,237,1.327,250,1.934]],["description/80",[10,1.842,64,1.755,70,1.754,92,2.068,180,2.429,237,0.955,250,1.392,298,2.429,299,2.429,300,2.068,301,2.429,302,2.429,303,2.429,304,2.429,305,2.429,306,2.068,307,2.743]],["title/81",[51,2,237,1.327,250,1.934]],["description/81",[306,5.211]],["title/82",[66,1.816,237,1.327,250,1.934]],["description/82",[306,5.211]],["title/83",[237,1.139,244,1.778,250,1.66,308,2.466]],["description/83",[309,6.122]],["title/84",[67,1.429,237,1.139,250,1.66,308,2.466]],["description/84",[309,6.122]],["title/85",[127,2.071,185,1.934,197,1.934]],["description/85",[3,1.792,185,2.8,197,2.8,310,4.884]],["title/86",[51,1.717,70,2.091,185,1.66,197,1.66]],["description/86",[310,6.122]],["title/87",[185,1.934,197,1.934,244,2.071]],["description/87",[3,1.792,185,2.8,197,2.8,311,4.884]],["title/88",[66,1.816,185,1.934,197,1.934]],["description/88",[311,6.122]],["title/89",[237,1.139,244,1.778,250,1.66,300,2.466]],["description/89",[3,1.276,64,1.305,138,3.182,220,1.994,246,2.784,250,1.994,300,2.961,312,3.928,313,3.928,314,3.928]],["title/90",[220,2.317,237,1.589]],["description/90",[48,1.697,62,1.497,64,1.389,127,1.442,251,2.35,252,2.35,253,2.35,254,2.35,255,2.35,256,2.35,257,2.35,258,2.35,259,2.35,260,2.35,261,2.35,262,2.35,263,2.35,265,2.35,315,2.654]],["title/91",[316,5.69]],["description/91",[27,1.382,239,1.604,240,1.604,317,5.516]],["title/92",[318,5.69]],["description/92",[27,1.382,239,1.604,240,1.604,319,5.516]],["title/93",[270,5.038]],["description/93",[27,1.382,239,1.604,240,1.604,271,4.884]],["title/94",[272,5.038]],["description/94",[27,1.382,239,1.604,240,1.604,273,4.884]],["title/95",[274,5.038]],["description/95",[27,1.382,239,1.604,240,1.604,275,4.884]],["title/96",[276,5.038]],["description/96",[27,1.382,239,1.604,240,1.604,277,4.884]],["title/97",[278,5.038]],["description/97",[27,1.382,239,1.604,240,1.604,279,4.884]],["title/98",[280,5.038]],["description/98",[27,1.382,239,1.604,240,1.604,281,4.884]],["title/99",[282,5.038]],["description/99",[27,1.382,239,1.604,240,1.604,283,4.884]],["title/100",[284,5.038]],["description/100",[27,1.382,239,1.604,240,1.604,285,4.884]],["title/101",[286,5.038]],["description/101",[27,1.382,239,1.604,240,1.604,287,4.884]],["title/102",[288,5.038]],["description/102",[27,1.382,239,1.604,240,1.604,289,4.884]],["title/103",[290,5.038]],["description/103",[27,1.382,239,1.604,240,1.604,291,4.884]],["title/104",[292,5.038]],["description/104",[27,1.382,239,1.604,240,1.604,293,4.884]],["title/105",[294,5.038]],["description/105",[27,1.382,239,1.604,240,1.604,295,4.884]],["title/106",[127,2.071,220,1.934,237,1.327]],["description/106",[3,1.679,64,1.718,220,2.623,296,4.576,320,5.167]],["title/107",[220,1.934,237,1.327,244,2.071]],["description/107",[3,1.679,64,1.718,220,2.623,246,3.663,321,3.895]],["title/108",[67,1.665,220,1.934,237,1.327]],["description/108",[321,5.211]],["title/109",[51,2,220,1.934,237,1.327]],["description/109",[321,5.211]],["title/110",[66,1.816,220,1.934,237,1.327]],["description/110",[321,5.211]],["title/111",[220,1.66,237,1.139,244,1.778,308,2.466]],["description/111",[322,6.122]],["title/112",[67,1.429,220,1.66,237,1.139,308,2.466]],["description/112",[322,6.122]],["title/113",[127,2.071,185,1.934,197,1.934]],["description/113",[3,1.792,185,2.8,197,2.8,323,4.884]],["title/114",[51,1.717,70,2.091,185,1.66,197,1.66]],["description/114",[323,6.122]],["title/115",[185,1.934,197,1.934,244,2.071]],["description/115",[3,1.792,185,2.8,197,2.8,324,4.884]],["title/116",[66,1.816,185,1.934,197,1.934]],["description/116",[324,6.122]],["title/117",[116,2.317,237,1.589]],["description/117",[33,3.445,64,1.616,116,2.467,222,3.938,325,4.304,326,4.304]],["title/118",[327,5.69]],["description/118",[27,1.382,239,1.604,240,1.604,328,5.516]],["title/119",[64,1.267,116,1.934,244,2.071]],["description/119",[329,5.211]],["title/120",[64,1.267,67,1.665,116,1.934]],["description/120",[329,5.211]],["title/121",[51,2,64,1.267,116,1.934]],["description/121",[329,5.211]],["title/122",[64,1.267,66,1.816,116,1.934]],["description/122",[329,5.211]],["title/123",[123,2.574,237,1.589]],["description/123",[33,3.445,64,1.616,123,2.741,222,3.938,325,4.304,326,4.304]],["title/124",[330,5.69]],["description/124",[27,1.382,239,1.604,240,1.604,331,5.516]],["title/125",[64,1.267,123,2.149,244,2.071]],["description/125",[332,5.211]],["title/126",[64,1.267,67,1.665,123,2.149]],["description/126",[332,5.211]],["title/127",[51,2,64,1.267,123,2.149]],["description/127",[332,5.211]],["title/128",[64,1.267,66,1.816,123,2.149]],["description/128",[332,5.211]]],"invertedIndex":[["",{"_index":27,"title":{},"description":{"2":{},"12":{},"15":{},"22":{},"31":{},"32":{},"34":{},"51":{},"52":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"104":{},"105":{},"118":{},"124":{}}}],["200",{"_index":151,"title":{},"description":{"33":{}}}],["409",{"_index":147,"title":{},"description":{"31":{},"32":{}}}],["_byo_",{"_index":63,"title":{},"description":{"5":{},"6":{},"15":{},"16":{},"17":{},"19":{},"34":{},"35":{}}}],["_live_",{"_index":61,"title":{},"description":{"5":{},"6":{},"15":{},"16":{},"17":{},"19":{},"34":{},"35":{}}}],["access",{"_index":185,"title":{"85":{},"86":{},"87":{},"88":{},"113":{},"114":{},"115":{},"116":{}},"description":{"37":{},"85":{},"87":{},"113":{},"115":{}}}],["accessconfig",{"_index":274,"title":{"66":{},"95":{}},"description":{}}],["accordingli",{"_index":109,"title":{},"description":{"17":{}}}],["ad",{"_index":163,"title":{},"description":{"33":{}}}],["add",{"_index":143,"title":{"31":{},"44":{}},"description":{"33":{},"44":{}}}],["addition",{"_index":59,"title":{},"description":{"5":{},"6":{},"15":{},"16":{},"17":{},"34":{},"35":{}}}],["address",{"_index":255,"title":{},"description":{"61":{},"90":{}}}],["admin",{"_index":195,"title":{},"description":{"37":{}}}],["adminaccessconfig",{"_index":270,"title":{"64":{},"93":{}},"description":{}}],["administr",{"_index":184,"title":{},"description":{"37":{}}}],["aem",{"_index":207,"title":{},"description":{"37":{}}}],["aggreg",{"_index":300,"title":{"89":{}},"description":{"79":{},"80":{},"89":{}}}],["allow",{"_index":132,"title":{},"description":{"29":{}}}],["altern",{"_index":202,"title":{},"description":{"37":{}}}],["alway",{"_index":78,"title":{},"description":{"7":{},"12":{}}}],["api",{"_index":178,"title":{},"description":{"37":{}}}],["api_key",{"_index":204,"title":{},"description":{"37":{}}}],["application/json",{"_index":156,"title":{},"description":{"33":{}}}],["appropri",{"_index":155,"title":{},"description":{"33":{}}}],["approv",{"_index":170,"title":{},"description":{"36":{}}}],["array",{"_index":149,"title":{},"description":{"33":{},"44":{}}}],["assum",{"_index":28,"title":{},"description":{"2":{},"12":{}}}],["asynchron",{"_index":50,"title":{},"description":{"2":{},"7":{},"12":{},"33":{}}}],["auth",{"_index":196,"title":{},"description":{"37":{}}}],["auth_token",{"_index":199,"title":{},"description":{"37":{}}}],["authent",{"_index":177,"title":{"37":{}},"description":{"37":{}}}],["author",{"_index":203,"title":{},"description":{"37":{}}}],["auto",{"_index":211,"title":{"39":{}},"description":{}}],["avail",{"_index":210,"title":{},"description":{"38":{}}}],["back",{"_index":194,"title":{},"description":{"37":{}}}],["base",{"_index":301,"title":{},"description":{"79":{},"80":{}}}],["batch",{"_index":105,"title":{"17":{}},"description":{"43":{}}}],["be",{"_index":162,"title":{},"description":{"33":{}}}],["below",{"_index":120,"title":{},"description":{"22":{},"31":{}}}],["bodi",{"_index":160,"title":{},"description":{"33":{},"44":{}}}],["br",{"_index":259,"title":{},"description":{"61":{},"90":{}}}],["br><br",{"_index":201,"title":{},"description":{"37":{}}}],["browser",{"_index":189,"title":{},"description":{"37":{}}}],["bu",{"_index":97,"title":{"14":{}},"description":{"13":{},"14":{}}}],["bulk",{"_index":19,"title":{"2":{},"7":{},"12":{},"33":{}},"description":{"2":{},"7":{},"12":{},"33":{}}}],["byom",{"_index":91,"title":{},"description":{"10":{}}}],["cach",{"_index":111,"title":{"18":{},"19":{}},"description":{"18":{}}}],["cache/{owner}/{repo}/{ref}/{path",{"_index":115,"title":{},"description":{"19":{}}}],["call",{"_index":12,"title":{},"description":{"1":{},"44":{}}}],["cdn",{"_index":62,"title":{},"description":{"5":{},"6":{},"15":{},"16":{},"17":{},"19":{},"34":{},"35":{},"61":{},"90":{}}}],["cdnconfig",{"_index":276,"title":{"67":{},"96":{}},"description":{}}],["chang",{"_index":107,"title":{"36":{}},"description":{"17":{}}}],["clear",{"_index":171,"title":{},"description":{"36":{}}}],["code",{"_index":96,"title":{"13":{},"14":{},"15":{},"16":{},"17":{}},"description":{"13":{},"14":{},"16":{}}}],["code-bu",{"_index":99,"title":{},"description":{"15":{},"16":{},"17":{}}}],["code/{owner}/{repo}/{ref",{"_index":110,"title":{},"description":{"17":{}}}],["code/{owner}/{repo}/{ref}/{path",{"_index":98,"title":{},"description":{"14":{},"15":{},"16":{}}}],["code>/config/{org}/profiles/default-profile/cdn/prod.json</cod",{"_index":315,"title":{},"description":{"90":{}}}],["code>/config/{org}/sites/{site}/cdn/prod.json</cod",{"_index":264,"title":{},"description":{"61":{}}}],["codeconfig",{"_index":278,"title":{"68":{},"97":{}},"description":{}}],["combin",{"_index":42,"title":{},"description":{"2":{}}}],["config",{"_index":237,"title":{"50":{},"53":{},"54":{},"55":{},"56":{},"61":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"89":{},"90":{},"106":{},"107":{},"108":{},"109":{},"110":{},"111":{},"112":{},"117":{},"123":{}},"description":{"50":{},"79":{},"80":{}}}],["config/{org}.json",{"_index":247,"title":{},"description":{"53":{},"54":{},"55":{},"56":{}}}],["config/{org}/aggregated/{site}.json",{"_index":314,"title":{},"description":{"89":{}}}],["config/{org}/profiles.json",{"_index":320,"title":{},"description":{"106":{}}}],["config/{org}/profiles/{profile}.json",{"_index":321,"title":{},"description":{"107":{},"108":{},"109":{},"110":{}}}],["config/{org}/profiles/{profile}/robots.txt",{"_index":322,"title":{},"description":{"111":{},"112":{}}}],["config/{org}/profiles/{profile}/tokens.json",{"_index":323,"title":{},"description":{"113":{},"114":{}}}],["config/{org}/profiles/{profile}/tokens/${id}.json",{"_index":324,"title":{},"description":{"115":{},"116":{}}}],["config/{org}/sites.json",{"_index":297,"title":{},"description":{"78":{}}}],["config/{org}/sites/{site}.json",{"_index":306,"title":{},"description":{"79":{},"80":{},"81":{},"82":{}}}],["config/{org}/sites/{site}/content/query.yaml",{"_index":329,"title":{},"description":{"119":{},"120":{},"121":{},"122":{}}}],["config/{org}/sites/{site}/content/sitemap.yaml",{"_index":332,"title":{},"description":{"125":{},"126":{},"127":{},"128":{}}}],["config/{org}/sites/{site}/robots.txt",{"_index":309,"title":{},"description":{"83":{},"84":{}}}],["config/{org}/sites/{site}/tokens.json",{"_index":310,"title":{},"description":{"85":{},"86":{}}}],["config/{org}/sites/{site}/tokens/${id}.json",{"_index":311,"title":{},"description":{"87":{},"88":{}}}],["config/{org}/users.json",{"_index":248,"title":{},"description":{"57":{},"58":{}}}],["config/{org}/users/${id}.json",{"_index":249,"title":{},"description":{"59":{},"60":{}}}],["configur",{"_index":64,"title":{"119":{},"120":{},"121":{},"122":{},"125":{},"126":{},"127":{},"128":{}},"description":{"5":{},"6":{},"7":{},"12":{},"15":{},"16":{},"17":{},"19":{},"34":{},"35":{},"53":{},"61":{},"78":{},"79":{},"80":{},"89":{},"90":{},"106":{},"107":{},"117":{},"123":{}}}],["contain",{"_index":33,"title":{},"description":{"2":{},"36":{},"44":{},"117":{},"123":{}}}],["content",{"_index":13,"title":{},"description":{"1":{},"5":{},"6":{},"10":{},"15":{},"33":{},"34":{}}}],["content-bu",{"_index":57,"title":{},"description":{"5":{},"6":{},"11":{},"32":{},"34":{},"35":{}}}],["contentconfig",{"_index":280,"title":{"69":{},"98":{}},"description":{}}],["cooki",{"_index":198,"title":{},"description":{"37":{}}}],["copi",{"_index":56,"title":{},"description":{"5":{},"34":{},"35":{}}}],["correspond",{"_index":212,"title":{},"description":{"39":{}}}],["creat",{"_index":51,"title":{"55":{},"58":{},"81":{},"86":{},"109":{},"114":{},"121":{},"127":{}},"description":{"2":{},"7":{},"12":{},"31":{}}}],["current",{"_index":217,"title":{},"description":{"40":{}}}],["default",{"_index":69,"title":{},"description":{"7":{},"12":{},"33":{}}}],["definit",{"_index":326,"title":{},"description":{"117":{},"123":{}}}],["delet",{"_index":66,"title":{"11":{},"16":{},"32":{},"56":{},"60":{},"82":{},"88":{},"110":{},"116":{},"122":{},"128":{}},"description":{"6":{},"11":{},"16":{},"32":{}}}],["destin",{"_index":124,"title":{},"description":{"25":{}}}],["detail",{"_index":234,"title":{"49":{}},"description":{}}],["directli",{"_index":256,"title":{},"description":{"61":{},"90":{}}}],["directori",{"_index":104,"title":{},"description":{"15":{}}}],["display",{"_index":221,"title":{},"description":{"41":{}}}],["doc",{"_index":90,"title":{},"description":{"10":{}}}],["document",{"_index":258,"title":{},"description":{"61":{},"90":{}}}],["dure",{"_index":80,"title":{},"description":{"7":{},"12":{}}}],["e.g",{"_index":87,"title":{},"description":{"10":{}}}],["edit",{"_index":43,"title":{},"description":{"2":{}}}],["edit=auto",{"_index":7,"title":{},"description":{"1":{}}}],["end",{"_index":26,"title":{},"description":{"2":{},"12":{},"31":{},"32":{},"34":{}}}],["endpoint",{"_index":265,"title":{},"description":{"61":{},"90":{}}}],["entir",{"_index":145,"title":{},"description":{"31":{},"32":{},"34":{}}}],["entri",{"_index":230,"title":{},"description":{"44":{}}}],["etc",{"_index":305,"title":{},"description":{"79":{},"80":{}}}],["even",{"_index":257,"title":{},"description":{"61":{},"90":{}}}],["event",{"_index":108,"title":{},"description":{"17":{},"36":{}}}],["exampl",{"_index":260,"title":{},"description":{"61":{},"90":{}}}],["exist",{"_index":180,"title":{},"description":{"37":{},"80":{}}}],["explicit",{"_index":253,"title":{},"description":{"61":{},"90":{}}}],["fetch",{"_index":21,"title":{},"description":{"2":{},"10":{},"15":{}}}],["fewer",{"_index":150,"title":{},"description":{"33":{}}}],["file",{"_index":75,"title":{},"description":{"7":{},"12":{}}}],["filter",{"_index":40,"title":{},"description":{"2":{}}}],["flow",{"_index":186,"title":{},"description":{"37":{}}}],["folder",{"_index":29,"title":{},"description":{"2":{},"12":{},"31":{}}}],["foldersconfig",{"_index":282,"title":{"70":{},"99":{}},"description":{}}],["folliow",{"_index":34,"title":{},"description":{"2":{}}}],["forceupd",{"_index":73,"title":{},"description":{"7":{},"12":{},"33":{}}}],["format",{"_index":229,"title":{},"description":{"44":{}}}],["fstab",{"_index":303,"title":{},"description":{"79":{},"80":{}}}],["gener",{"_index":2,"title":{"1":{},"25":{}},"description":{"25":{},"37":{}}}],["github",{"_index":100,"title":{},"description":{"15":{}}}],["googl",{"_index":89,"title":{},"description":{"10":{}}}],["groupsconfig",{"_index":242,"title":{"52":{},"74":{}},"description":{}}],["header",{"_index":158,"title":{},"description":{"33":{},"37":{}}}],["headersconfig",{"_index":284,"title":{"71":{},"100":{}},"description":{}}],["helix/config",{"_index":76,"title":{},"description":{"7":{},"12":{}}}],["helix/config.xlsx",{"_index":304,"title":{},"description":{"79":{},"80":{}}}],["hook",{"_index":114,"title":{},"description":{"19":{}}}],["https://www.aem.live/docs/limits#rate-limits-number-of-preview-operations-per-tim",{"_index":16,"title":{},"description":{"1":{}}}],["id",{"_index":128,"title":{},"description":{"27":{}}}],["ident",{"_index":181,"title":{},"description":{"37":{}}}],["idp",{"_index":182,"title":{},"description":{"37":{},"38":{},"39":{}}}],["ignor",{"_index":79,"title":{},"description":{"7":{},"12":{}}}],["includ",{"_index":138,"title":{},"description":{"29":{},"36":{},"89":{}}}],["index",{"_index":116,"title":{"20":{},"21":{},"23":{},"117":{},"119":{},"120":{},"121":{},"122":{}},"description":{"20":{},"21":{},"22":{},"23":{},"117":{}}}],["index/{owner}/{repo}/{ref}/{path",{"_index":117,"title":{},"description":{"21":{},"22":{},"23":{}}}],["indexconfig",{"_index":327,"title":{"118":{}},"description":{}}],["inform",{"_index":35,"title":{"41":{}},"description":{"2":{},"7":{},"12":{},"41":{}}}],["inherit",{"_index":312,"title":{},"description":{"89":{}}}],["invok",{"_index":113,"title":{},"description":{"19":{}}}],["job",{"_index":20,"title":{"2":{},"7":{},"12":{},"33":{},"45":{},"46":{},"47":{},"48":{},"49":{}},"description":{"7":{},"12":{},"45":{},"46":{},"47":{},"48":{},"49":{}}}],["job/{owner}/{repo}/{ref}/{top",{"_index":231,"title":{},"description":{"46":{}}}],["job/{owner}/{repo}/{ref}/{topic}/{jobnam",{"_index":232,"title":{},"description":{"47":{},"48":{}}}],["job/{owner}/{repo}/{ref}/{topic}/{jobname}/detail",{"_index":235,"title":{},"description":{"49":{}}}],["job](#tag/job",{"_index":52,"title":{},"description":{"2":{}}}],["json",{"_index":228,"title":{},"description":{"44":{}}}],["last",{"_index":101,"title":{},"description":{"15":{},"22":{}}}],["latest",{"_index":85,"title":{},"description":{"10":{},"15":{}}}],["lead",{"_index":209,"title":{},"description":{"37":{}}}],["legaci",{"_index":302,"title":{},"description":{"79":{},"80":{}}}],["level",{"_index":246,"title":{},"description":{"53":{},"78":{},"79":{},"89":{},"107":{}}}],["link",{"_index":225,"title":{},"description":{"43":{}}}],["list",{"_index":127,"title":{"27":{},"46":{},"57":{},"78":{},"85":{},"106":{},"113":{}},"description":{"27":{},"46":{},"61":{},"90":{}}}],["live",{"_index":45,"title":{"19":{}},"description":{"2":{},"5":{},"6":{},"7":{},"34":{},"35":{}}}],["live/{owner}/{repo}/{ref",{"_index":83,"title":{},"description":{"7":{}}}],["live/{owner}/{repo}/{ref}/{path",{"_index":55,"title":{},"description":{"4":{},"5":{},"6":{}}}],["live:writ",{"_index":141,"title":{},"description":{"29":{}}}],["load",{"_index":226,"title":{},"description":{"43":{}}}],["locat",{"_index":164,"title":{},"description":{"34":{},"35":{}}}],["lock",{"_index":133,"title":{},"description":{"29":{},"31":{},"32":{},"36":{}}}],["log",{"_index":175,"title":{"42":{},"43":{},"44":{}},"description":{"36":{},"40":{},"42":{},"43":{},"44":{}}}],["log/{owner}/{repo}/{ref",{"_index":227,"title":{},"description":{"43":{},"44":{}}}],["login",{"_index":188,"title":{"38":{},"39":{}},"description":{"37":{},"38":{},"40":{}}}],["login/{owner}/{repo}/{ref",{"_index":214,"title":{},"description":{"39":{}}}],["logout",{"_index":215,"title":{"40":{}},"description":{"40":{}}}],["manag",{"_index":262,"title":{},"description":{"61":{},"90":{}}}],["manifest",{"_index":130,"title":{"28":{},"29":{}},"description":{"28":{},"29":{}}}],["messag",{"_index":173,"title":{},"description":{"36":{}}}],["metadataconfig",{"_index":286,"title":{"72":{},"101":{}},"description":{}}],["migrat",{"_index":298,"title":{},"description":{"79":{},"80":{}}}],["modifi",{"_index":71,"title":{},"description":{"7":{},"12":{},"33":{}}}],["more",{"_index":222,"title":{},"description":{"43":{},"117":{},"123":{}}}],["name",{"_index":296,"title":{},"description":{"78":{},"106":{}}}],["need",{"_index":137,"title":{},"description":{"29":{}}}],["new",{"_index":70,"title":{"58":{},"86":{},"114":{}},"description":{"7":{},"12":{},"33":{},"80":{}}}],["next",{"_index":224,"title":{},"description":{"43":{}}}],["note",{"_index":48,"title":{},"description":{"2":{},"7":{},"12":{},"29":{},"33":{},"61":{},"90":{}}}],["object",{"_index":252,"title":{},"description":{"61":{},"90":{}}}],["obtain",{"_index":205,"title":{},"description":{"37":{}}}],["on",{"_index":325,"title":{},"description":{"117":{},"123":{}}}],["open",{"_index":187,"title":{},"description":{"37":{}}}],["oper",{"_index":1,"title":{},"description":{"0":{},"3":{},"8":{},"13":{},"18":{},"20":{},"24":{},"26":{},"36":{},"42":{},"45":{},"50":{}}}],["option",{"_index":112,"title":{},"description":{"19":{},"36":{}}}],["order",{"_index":135,"title":{},"description":{"29":{},"37":{}}}],["org",{"_index":236,"title":{"50":{},"58":{}},"description":{"50":{},"57":{}}}],["organis",{"_index":245,"title":{"53":{},"54":{},"55":{},"56":{}},"description":{"53":{}}}],["orgconfig",{"_index":238,"title":{"51":{}},"description":{}}],["otherwise.<br",{"_index":153,"title":{},"description":{"33":{}}}],["out",{"_index":216,"title":{},"description":{"40":{}}}],["overal",{"_index":4,"title":{},"description":{"1":{}}}],["overwrit",{"_index":307,"title":{},"description":{"80":{}}}],["page",{"_index":192,"title":{},"description":{"37":{}}}],["param",{"_index":9,"title":{},"description":{"1":{},"31":{},"32":{},"34":{}}}],["paramet",{"_index":174,"title":{},"description":{"36":{}}}],["partit",{"_index":58,"title":{},"description":{"5":{},"6":{},"11":{},"31":{},"32":{},"34":{},"35":{}}}],["pass",{"_index":41,"title":{},"description":{"2":{}}}],["path",{"_index":23,"title":{},"description":{"2":{},"7":{},"12":{},"15":{},"22":{},"25":{},"31":{},"32":{},"33":{},"34":{}}}],["path'",{"_index":165,"title":{},"description":{"34":{}}}],["payload",{"_index":25,"title":{},"description":{"2":{},"12":{}}}],["payload.<br",{"_index":68,"title":{},"description":{"7":{},"33":{}}}],["payload.<br><br",{"_index":47,"title":{},"description":{"2":{}}}],["perform",{"_index":49,"title":{},"description":{"2":{},"7":{},"12":{},"33":{},"36":{}}}],["permiss",{"_index":140,"title":{},"description":{"29":{}}}],["pleas",{"_index":251,"title":{},"description":{"61":{},"90":{}}}],["possibl",{"_index":39,"title":{},"description":{"2":{}}}],["preview",{"_index":44,"title":{"8":{},"9":{},"10":{},"11":{},"12":{}},"description":{"2":{},"5":{},"8":{},"9":{},"10":{},"11":{},"12":{},"31":{},"32":{}}}],["preview.<br",{"_index":94,"title":{},"description":{"12":{}}}],["preview/{owner}/{repo}/{ref",{"_index":95,"title":{},"description":{"12":{}}}],["preview/{owner}/{repo}/{ref}/{path",{"_index":84,"title":{},"description":{"9":{},"10":{},"11":{}}}],["preview:writ",{"_index":139,"title":{},"description":{"29":{}}}],["previewed.<br",{"_index":93,"title":{},"description":{"12":{}}}],["previewlastmodifi",{"_index":37,"title":{},"description":{"2":{}}}],["process",{"_index":106,"title":{},"description":{"17":{}}}],["processed.<br><br",{"_index":31,"title":{},"description":{"2":{}}}],["product",{"_index":261,"title":{},"description":{"61":{},"90":{}}}],["profil",{"_index":220,"title":{"41":{},"90":{},"106":{},"107":{},"108":{},"109":{},"110":{},"111":{},"112":{}},"description":{"41":{},"89":{},"106":{},"107":{}}}],["profileconfig",{"_index":316,"title":{"91":{}},"description":{}}],["profileconfiglist",{"_index":318,"title":{"92":{}},"description":{}}],["project",{"_index":208,"title":{},"description":{"37":{},"39":{},"43":{},"44":{}}}],["properti",{"_index":24,"title":{},"description":{"2":{},"7":{},"12":{},"33":{}}}],["provid",{"_index":86,"title":{},"description":{"10":{},"37":{},"38":{}}}],["publicconfig",{"_index":288,"title":{"73":{},"102":{}},"description":{}}],["publish",{"_index":54,"title":{"3":{},"4":{},"5":{},"7":{},"34":{},"35":{}},"description":{"3":{},"4":{},"5":{},"7":{},"22":{},"34":{},"35":{},"36":{}}}],["publish.<br",{"_index":81,"title":{},"description":{"7":{}}}],["publishlastmodifi",{"_index":38,"title":{},"description":{"2":{}}}],["purg",{"_index":60,"title":{"19":{}},"description":{"5":{},"6":{},"15":{},"16":{},"17":{},"19":{},"34":{},"35":{}}}],["queri",{"_index":8,"title":{},"description":{"1":{}}}],["re-index",{"_index":118,"title":{"22":{}},"description":{}}],["read",{"_index":244,"title":{"53":{},"59":{},"79":{},"83":{},"87":{},"89":{},"107":{},"111":{},"115":{},"119":{},"125":{}},"description":{}}],["recurs",{"_index":30,"title":{},"description":{"2":{},"12":{},"15":{},"22":{}}}],["redirect",{"_index":191,"title":{},"description":{"37":{},"39":{},"40":{}}}],["redirects.json",{"_index":77,"title":{},"description":{"7":{},"12":{}}}],["reindex",{"_index":119,"title":{},"description":{"22":{}}}],["reject",{"_index":172,"title":{},"description":{"36":{}}}],["remov",{"_index":122,"title":{"23":{}},"description":{"23":{}}}],["request",{"_index":82,"title":{},"description":{"7":{},"12":{},"29":{},"33":{},"36":{},"37":{}}}],["requir",{"_index":11,"title":{},"description":{"1":{}}}],["resourc",{"_index":6,"title":{"5":{},"6":{},"22":{},"23":{},"31":{},"34":{}},"description":{"1":{},"2":{},"4":{},"5":{},"6":{},"7":{},"9":{},"10":{},"11":{},"12":{},"14":{},"15":{},"16":{},"19":{},"21":{},"22":{},"23":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{}}}],["respect",{"_index":5,"title":{},"description":{"1":{},"4":{},"9":{},"14":{},"15":{},"19":{},"21":{},"30":{}}}],["respons",{"_index":32,"title":{},"description":{"2":{},"31":{},"32":{},"37":{},"43":{}}}],["result",{"_index":161,"title":{},"description":{"33":{}}}],["return",{"_index":3,"title":{"43":{}},"description":{"1":{},"2":{},"4":{},"7":{},"9":{},"12":{},"14":{},"21":{},"27":{},"28":{},"30":{},"31":{},"32":{},"43":{},"46":{},"47":{},"49":{},"53":{},"57":{},"59":{},"78":{},"79":{},"85":{},"87":{},"89":{},"106":{},"107":{},"113":{},"115":{}}}],["review",{"_index":168,"title":{"36":{}},"description":{"36":{}}}],["robots.txt",{"_index":308,"title":{"83":{},"84":{},"111":{},"112":{}},"description":{}}],["robotsconfig",{"_index":290,"title":{"75":{},"103":{}},"description":{}}],["role",{"_index":136,"title":{},"description":{"29":{}}}],["schema",{"_index":254,"title":{},"description":{"61":{},"90":{}}}],["schemadefinit",{"_index":239,"title":{},"description":{"51":{},"52":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"104":{},"105":{},"118":{},"124":{}}}],["schemaref=\"#/components/schemas/accessconfig",{"_index":275,"title":{},"description":{"66":{},"95":{}}}],["schemaref=\"#/components/schemas/adminaccessconfig",{"_index":271,"title":{},"description":{"64":{},"93":{}}}],["schemaref=\"#/components/schemas/cdnconfig",{"_index":277,"title":{},"description":{"67":{},"96":{}}}],["schemaref=\"#/components/schemas/codeconfig",{"_index":279,"title":{},"description":{"68":{},"97":{}}}],["schemaref=\"#/components/schemas/contentconfig",{"_index":281,"title":{},"description":{"69":{},"98":{}}}],["schemaref=\"#/components/schemas/foldersconfig",{"_index":283,"title":{},"description":{"70":{},"99":{}}}],["schemaref=\"#/components/schemas/groupsconfig",{"_index":243,"title":{},"description":{"52":{},"74":{}}}],["schemaref=\"#/components/schemas/headersconfig",{"_index":285,"title":{},"description":{"71":{},"100":{}}}],["schemaref=\"#/components/schemas/indexconfig",{"_index":328,"title":{},"description":{"118":{}}}],["schemaref=\"#/components/schemas/metadataconfig",{"_index":287,"title":{},"description":{"72":{},"101":{}}}],["schemaref=\"#/components/schemas/orgconfig",{"_index":241,"title":{},"description":{"51":{}}}],["schemaref=\"#/components/schemas/profileconfig",{"_index":317,"title":{},"description":{"91":{}}}],["schemaref=\"#/components/schemas/profileconfiglist",{"_index":319,"title":{},"description":{"92":{}}}],["schemaref=\"#/components/schemas/publicconfig",{"_index":289,"title":{},"description":{"73":{},"102":{}}}],["schemaref=\"#/components/schemas/robotsconfig",{"_index":291,"title":{},"description":{"75":{},"103":{}}}],["schemaref=\"#/components/schemas/sidekickconfig",{"_index":293,"title":{},"description":{"76":{},"104":{}}}],["schemaref=\"#/components/schemas/siteaccessconfig",{"_index":273,"title":{},"description":{"65":{},"94":{}}}],["schemaref=\"#/components/schemas/siteconfig",{"_index":267,"title":{},"description":{"62":{}}}],["schemaref=\"#/components/schemas/siteconfiglist",{"_index":269,"title":{},"description":{"63":{}}}],["schemaref=\"#/components/schemas/sitemapconfig",{"_index":331,"title":{},"description":{"124":{}}}],["schemaref=\"#/components/schemas/tokensconfig",{"_index":295,"title":{},"description":{"77":{},"105":{}}}],["screen",{"_index":219,"title":{},"description":{"40":{}}}],["see",{"_index":15,"title":{},"description":{"1":{}}}],["segment",{"_index":102,"title":{},"description":{"15":{},"22":{}}}],["select",{"_index":46,"title":{"38":{}},"description":{"2":{},"37":{},"38":{}}}],["session",{"_index":218,"title":{},"description":{"40":{}}}],["set",{"_index":10,"title":{},"description":{"1":{},"7":{},"12":{},"33":{},"79":{},"80":{}}}],["setup",{"_index":213,"title":{},"description":{"39":{}}}],["sharepoint",{"_index":88,"title":{},"description":{"10":{}}}],["showwriteonly={tru",{"_index":240,"title":{},"description":{"51":{},"52":{},"62":{},"63":{},"64":{},"65":{},"66":{},"67":{},"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"91":{},"92":{},"93":{},"94":{},"95":{},"96":{},"97":{},"98":{},"99":{},"100":{},"101":{},"102":{},"103":{},"104":{},"105":{},"118":{},"124":{}}}],["sidekickconfig",{"_index":292,"title":{"76":{},"104":{}},"description":{}}],["site",{"_index":250,"title":{"61":{},"78":{},"79":{},"80":{},"81":{},"82":{},"83":{},"84":{},"89":{}},"description":{"78":{},"79":{},"80":{},"89":{}}}],["siteaccessconfig",{"_index":272,"title":{"65":{},"94":{}},"description":{}}],["siteconfig",{"_index":266,"title":{"62":{}},"description":{}}],["siteconfiglist",{"_index":268,"title":{"63":{}},"description":{}}],["sitemap",{"_index":123,"title":{"24":{},"25":{},"123":{},"125":{},"126":{},"127":{},"128":{}},"description":{"24":{},"25":{},"123":{}}}],["sitemap/{owner}/{repo}/{ref}/{path",{"_index":125,"title":{},"description":{"25":{}}}],["sitemapconfig",{"_index":330,"title":{"124":{}},"description":{}}],["snapshot",{"_index":126,"title":{"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{}},"description":{"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{}}}],["snapshot/snapshotid",{"_index":144,"title":{},"description":{"31":{}}}],["snapshot/{owner}/{repo}/main",{"_index":129,"title":{},"description":{"27":{}}}],["snapshot/{owner}/{repo}/main/{snapshotid",{"_index":131,"title":{},"description":{"28":{},"29":{},"33":{}}}],["snapshot/{owner}/{repo}/main/{snapshotid}/{path",{"_index":142,"title":{},"description":{"30":{},"31":{},"32":{}}}],["snapshot/{owner}/{repo}/main/{snapshotid}/{path}?publish=tru",{"_index":166,"title":{},"description":{"34":{}}}],["snapshot/{owner}/{repo}/main/{snapshotid}?publish=tru",{"_index":167,"title":{},"description":{"35":{}}}],["snapshot/{owner}/{repo}/main/{snapshotid}?review=[request,approve,reject",{"_index":176,"title":{},"description":{"36":{}}}],["sourc",{"_index":14,"title":{},"description":{"1":{}}}],["sourcelastmodifi",{"_index":36,"title":{},"description":{"2":{}}}],["specifi",{"_index":22,"title":{},"description":{"2":{},"7":{},"12":{},"25":{},"31":{},"33":{},"43":{}}}],["start",{"_index":18,"title":{"2":{},"7":{},"12":{},"33":{}},"description":{}}],["state",{"_index":169,"title":{"36":{}},"description":{}}],["statu",{"_index":0,"title":{"0":{},"1":{},"2":{},"4":{},"9":{},"14":{},"21":{},"30":{},"47":{},"49":{}},"description":{"0":{},"1":{},"2":{},"4":{},"9":{},"14":{},"21":{},"30":{},"47":{},"49":{}}}],["status/{owner}/{repo}/{ref",{"_index":53,"title":{},"description":{"2":{}}}],["status/{owner}/{repo}/{ref}/{path",{"_index":17,"title":{},"description":{"1":{}}}],["stop",{"_index":233,"title":{"48":{}},"description":{"48":{}}}],["store",{"_index":92,"title":{},"description":{"10":{},"15":{},"31":{},"80":{}}}],["sub",{"_index":121,"title":{},"description":{"22":{}}}],["subsequ",{"_index":200,"title":{},"description":{"37":{}}}],["subtre",{"_index":146,"title":{},"description":{"31":{},"32":{},"34":{}}}],["success",{"_index":193,"title":{},"description":{"37":{}}}],["synchron",{"_index":148,"title":{},"description":{"33":{}}}],["talk",{"_index":206,"title":{},"description":{"37":{}}}],["timespan",{"_index":223,"title":{},"description":{"43":{}}}],["token",{"_index":197,"title":{"85":{},"86":{},"87":{},"88":{},"113":{},"114":{},"115":{},"116":{}},"description":{"37":{},"85":{},"87":{},"113":{},"115":{}}}],["tokensconfig",{"_index":294,"title":{"77":{},"105":{}},"description":{}}],["treat",{"_index":159,"title":{},"description":{"33":{}}}],["tree",{"_index":103,"title":{},"description":{"15":{},"22":{}}}],["true",{"_index":299,"title":{},"description":{"79":{},"80":{}}}],["true`.<br",{"_index":74,"title":{},"description":{"7":{},"12":{},"33":{}}}],["type",{"_index":157,"title":{},"description":{"33":{}}}],["un-publish",{"_index":65,"title":{"6":{}},"description":{"6":{}}}],["unless",{"_index":72,"title":{},"description":{"7":{},"12":{},"33":{}}}],["unlock",{"_index":134,"title":{},"description":{"29":{},"36":{}}}],["updat",{"_index":67,"title":{"10":{},"15":{},"17":{},"29":{},"54":{},"80":{},"84":{},"108":{},"112":{},"120":{},"126":{}},"description":{"7":{},"10":{},"12":{},"15":{},"17":{},"29":{},"33":{}}}],["us",{"_index":179,"title":{},"description":{"37":{}}}],["user",{"_index":183,"title":{"57":{},"58":{},"59":{},"60":{}},"description":{"37":{},"57":{},"59":{}}}],["valu",{"_index":313,"title":{},"description":{"89":{}}}],["via",{"_index":263,"title":{},"description":{"61":{},"90":{}}}],["want",{"_index":190,"title":{},"description":{"37":{}}}],["wildcard",{"_index":152,"title":{},"description":{"33":{}}}],["without",{"_index":154,"title":{},"description":{"33":{}}}]],"pipeline":[]}},"options":{"schemasExpansionLevel":2}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);