https://docs.github.com/_next/static/chunks/9846-b9a9a20d9c487478.js

1(self.webpackChunk_N_E=self.webpackChunk_N_E||[]).push([[9846],{7270:(e,t,s)=>{"use strict";s.d(t,{h:()=>m});var l=s(37876),r=s(14232),a=s(25541),i=s(15039),n=s.n(i),o=s(52956),d=s(13603),c=s(73636),u=s.n(c);let m=(0,r.memo)(function({children:e,hast:t,as:s="div",className:r,...i}){let c=t?{children:(0,a.H)(t,{Fragment:l.Fragment,jsx:l.jsx,jsxs:l.jsxs,components:o.A})}:"string"==typeof e?{children:(0,d.x)(e,o.A)}:{children:e};return(0,l.jsx)(s,{...i,className:n()(u().markdownBody,"markdown-body",r),...c})})},15206:e=>{e.exports={container:"Lead_container__m3L5f",muted:"Lead_muted__ZJh5K"}},20686:(e,t,s)=>{"use strict";s(65813)},33269:(e,t,s)=>{"use strict";s.d(t,{C0:()=>a,vC:()=>r});var l=s(14232);s(20686);let r=(0,l.createContext)(null),a=()=>{let e=(0,l.useContext)(r);if(!e)throw Error('"useTocLandingContext" may only be used inside "TocLandingContext.Provider"');return e}},39081:(e,t,s)=>{"use strict";s.d(t,{g:()=>d});var l=s(37876),r=s(14232),a=s(18847),i=s.n(a),n=s(89099);let o=i()(()=>s.e(6824).then(s.bind(s,46824)),{loadableGenerated:{webpack:()=>[46824]},ssr:!1});function d(){let{asPath:e}=(0,n.useRouter)(),[t,s]=(0,r.useState)(!1);return((0,r.useEffect)(()=>{let{hash:t}=window.location;t&&e.startsWith("/rest")&&s(!0)},[]),t)?(0,l.jsx)(o,{}):null}},39846:(e,t,s)=>{"use strict";s.d(t,{i:()=>A});var l=s(37876),r=s(89099),a=s(33269),i=s(65793),n=s(36738),o=s(90039),d=s(91775),c=s(69241),u=s(43256),m=s.n(u);let x=e=>{let{items:t,variant:s="expanded"}=e;return(0,l.jsxs)("div",{"data-testid":"table-of-contents",children:["expanded"===s&&t.map(e=>{let{fullPath:t,title:s,intro:r}=e;return(0,l.jsxs)("div",{"data-testid":"expanded-item",className:"pt-4 pb-3 f4 d-list-item width-full list-style-none border-bottom",children:[(0,l.jsx)("h2",{className:"py-1 h4",children:(0,l.jsx)(o.N,{href:t,className:m().linkAccent,children:s})}),r&&(0,l.jsx)(d.T,{as:"div",className:(0,c.$)("f4",m().textMuted),html:r})]},t)}),"compact"===s&&(0,l.jsx)("ul",{role:"list",className:"list-style-none f4",children:t.map((e,s)=>{let{fullPath:r,title:a,childTocItems:i}=e,n=(i||[]).filter(Boolean);return(0,l.jsxs)("li",{role:"listitem",className:"mb-2",children:[(0,l.jsxs)(o.N,{href:r,className:"text-underline mb-2 d-block",children:[a,(0,l.jsxs)("span",{className:"visually-hidden",children:[", ",s+1," of ",t.length]})]}),n.length>0&&(0,l.jsx)("ul",{role:"list",className:"pl-4 list-style-none",children:n.map((e,t)=>(0,l.jsx)("li",{role:"listitem",className:"mb-2",children:(0,l.jsxs)(o.N,{href:e.fullPath,className:"text-underline",children:[e.title,(0,l.jsxs)("span",{className:"visually-hidden",children:[", ",t+1," of ",n.length]})]})},e.fullPath))})]},r)})})]})};var h=s(43306),p=s(7270),f=s(57596),j=s(91709),b=s(56557),v=s.n(b),_=s(55755),N=s.n(_);let g=({title:e,viewAllHref:t,viewAllTitleText:s,articles:r})=>{let{t:a}=(0,i.B)("product_landing");return(0,l.jsxs)(l.Fragment,{children:[e&&(0,l.jsxs)("div",{className:"mb-4 d-flex flex-items-baseline",children:[(0,l.jsx)("h2",{className:(0,c.$)("f4","text-semibold"),children:e}),t&&(0,l.jsxs)(o.N,{href:t,className:"ml-4",...s?{"aria-label":a("all_content").replace("{{ title }}",s)}:{},children:[a("view")," ",(0,l.jsx)(f.flY,{size:14,className:"v-align-middle"})]})]}),(0,l.jsx)(j.l,{"data-testid":"article-list",variant:"full",children:r.map(e=>(0,l.jsx)(j.l.LinkItem,{as:"a",href:e.href,"data-testid":"bump-link",className:(0,c.$)(N().linkItem,"width-full","border-top","py-3"),children:(0,l.jsxs)("div",{children:[e.intro?(0,l.jsx)("h3",{className:"f4","data-testid":"link-with-intro-title",children:(0,l.jsx)("span",{children:e.fullTitle?e.fullTitle:e.title})}):(0,l.jsx)("span",{className:"f4 text-bold d-block","data-testid":"link-with-intro-title",children:e.fullTitle?e.fullTitle:e.title}),e.intro&&(0,l.jsx)("p",{className:(0,c.$)(N().textMuted,"mb-0","mt-1"),"data-testid":"link-with-intro-intro",children:e.intro}),e.date&&(0,l.jsx)("time",{className:(0,c.$)("tooltipped","tooltipped-n",N().textMuted,"text-mono","mt-1"),"aria-label":v()(e.date).format("MMMM DD"),children:v()(e.date).format("MMMM DD")})]})},e.href))})]})};var y=s(45338),w=s(96037),C=s(50265),k=s(39081),L=s(43152),P=s(78537);let A=()=>{let e=(0,r.useRouter)(),{title:t,intro:s,tocItems:o,productCallout:d,variant:c,featuredLinks:u,renderedPage:m,renderedPageHast:f,permissions:j}=(0,a.C0)(),{t:b}=(0,i.B)("toc");return(0,l.jsxs)(n.i,{children:[(0,l.jsx)(P.$,{}

1),"/[versionId]/rest/[category]"===e.route&&(0,l.jsx)(L.p,{}),(0,l.jsx)(k.g,{}),(0,l.jsx)("div",{className:"container-xl px-3 px-md-6 my-4",children:(0,l.jsxs)(y.l,{children:[(0,l.jsx)(h.B,{children:t}),s&&(0,l.jsx)(C.h,{"data-search":"lead",children:s}),(0,l.jsx)(w.e,{product:d,permissions:j}),(0,l.jsx)("div",{className:"border-bottom border-xl-0 pb-4 mb-5 pb-xl-2 mb-xl-2"}),(0,l.jsxs)("div",{className:"expanded"===c?"mt-5":"mt-2",children:[u?.gettingStarted&&u?.popular&&(0,l.jsx)("div",{className:"pb-8 container-xl",children:(0,l.jsxs)("div",{className:"gutter gutter-xl-spacious clearfix",children:[(0,l.jsx)("div",{className:"col-12 col-lg-6 mb-md-4 mb-lg-0 float-left",children:(0,l.jsx)(g,{title:b("getting_started"),articles:u.gettingStarted})}),(0,l.jsx)("div",{className:"col-12 col-lg-6 float-left",children:(0,l.jsx)(g,{title:b("popular"),articles:u.popular})})]})}),(m||f)&&(0,l.jsx)("div",{id:"article-contents","data-article-body":!0,className:"mb-5",children:(0,l.jsx)(p.h,{hast:f??void 0,children:m})}),(0,l.jsx)(x,{items:o,variant:c})]})]})})]})}},43152:(e,t,s)=>{"use strict";s.d(t,{p:()=>d});var l=s(14232),r=s(89099),a=s(65894),i=s(91078),n=s(25729),o=s(40287);function d(){let e=(0,r.useRouter)(),{currentVersion:t}=(0,i.M)(),{allVersions:s}=(0,n.O4)(),d=s[t].apiVersions,c=s[t].apiVersions.length>0,u=s[t].latestApiVersion,m=e.query.apiVersion;return(0,l.useEffect)(()=>{if(c&&(!m||!d.includes(m))){let t=a.A.get(o.$e),s=t&&d.includes(t)?t:u,l=e.asPath.split("#")[1],[r,i=""]=e.asPath.split("#")[0].split("?"),n=new URLSearchParams(i);n.set("apiVersion",s);let c=`/${e.locale}${r}?${n}${l?`#${l}`:""}`;e.replace(c)}},[e.asPath,t]),null}},43256:e=>{e.exports={linkAccent:"TableOfContents_linkAccent__LTR0O",textMuted:"TableOfContents_textMuted__TCPDr"}},43306:(e,t,s)=>{"use strict";s.d(t,{B:()=>o});var l=s(37876);s(14232);var r=s(15039),a=s.n(r),i=s(76607),n=s.n(i);let o=({children:e})=>(0,l.jsx)("div",{className:"d-flex flex-items-baseline flex-justify-between","data-container":"title",children:(0,l.jsx)("h1",{id:"title-h1",className:a()("border-bottom-0",n().title),children:e})})},45338:(e,t,s)=>{"use strict";s.d(t,{l:()=>c});var l=s(37876);s(14232);var r=s(15039),a=s.n(r),i=s(68158),n=s(28638),o=s(48823),d=s.n(o);let c=({intro:e,topper:t,toc:s,children:r,className:o,supportPortalVaIframeProps:c,fullWidth:u,tocBreakpoint:m="lg"})=>{let{collapsed:x}=(0,n.h)(),h="xxl"===m&&x,p=u?"":a()(d().containerBox,"xxl"===m&&(h?d().containerBoxXxlCollapsed:d().containerBoxXxl));return(0,l.jsxs)("div",{className:a()(p,o),children:[t&&(0,l.jsx)("div",{style:{gridArea:"topper"}

1,className:a()("xxl"===m&&d().heroTopper),children:t}),e&&(0,l.jsx)("div",{id:"article-intro",style:{gridArea:"intro"},className:a()("f4 pb-4","xxl"===m&&d().heroIntro),children:e}),s&&(0,l.jsx)("div",{"data-container":"toc",style:{gridArea:"sidebar"},className:a()(d().sidebarColumn,"xxl"===m?h?d().sidebarColumnXxlCollapsed:d().sidebarColumnXxl:"pb-4 mb-5 pb-xl-0 mb-xl-0"),children:(0,l.jsx)("div",{className:d().sidebarBox,children:s})}),(0,l.jsxs)("div",{"data-container":"article",style:{gridArea:"content"},"data-search":"article-body",children:[c&&c.supportPortalUrl&&c.vaFlowUrlParameter&&(0,l.jsx)(i.v,{supportPortalVaIframeProps:c}),r]})]})}},48823:e=>{e.exports={containerBox:"ArticleGridLayout_containerBox__lLLio",containerBoxXxl:"ArticleGridLayout_containerBoxXxl__SphGC",heroTopper:"ArticleGridLayout_heroTopper__bCpVj",heroIntro:"ArticleGridLayout_heroIntro__IvIoX",containerBoxXxlCollapsed:"ArticleGridLayout_containerBoxXxlCollapsed__03m13",sidebarColumn:"ArticleGridLayout_sidebarColumn__FkGT8",sidebarColumnXxl:"ArticleGridLayout_sidebarColumnXxl__lGIPh",sidebarColumnXxlCollapsed:"ArticleGridLayout_sidebarColumnXxlCollapsed__y_WRF",sidebarBox:"ArticleGridLayout_sidebarBox__Cj_03"}},50265:(e,t,s)=>{"use strict";s.d(t,{h:()=>d});var l=s(37876),r=s(15039),a=s.n(r),i=s(15206),n=s.n(i),o=s(67309);function d({children:e,className:t,as:s="div",variant:r="default",...i}){let c={className:a()("mb-3","hero"===r?n().container:a()("f2",n().muted),t),"data-container":"lead",...i};return"string"==typeof e?(0,l.jsx)(o.T,{as:s,...c,html:e}):(0,l.jsx)(s,{...c,children:e})}},55755:e=>{e.exports={linkItem:"ArticleList_linkItem__9__Qg",textMuted:"ArticleList_textMuted__tReme"}},57016:e=>{e.exports={permissionsBox:"PermissionsStatement_permissionsBox__rgzhT"}},65813:(e,t,s)=>{"use strict";s.d(t,{TV:()=>a});var l=s(57596);let r={bug:l.Q5O,lightbulb:l.XLj,code:l.loI,gear:l.L64,rocket:l.Abk,beaker:l.cuA,copilot:l.MiJ,hubot:l.qdJ,log:l.wvR,terminal:l.k3y,book:l.vP6,"shield-lock":l.m5V,lock:l.XAi};function a(e){return e&&null!==e&&e in r&&r[e]||l.MiJ}Object.keys(r)},68158:(e,t,s)=>{"use strict";s.d(t,{v:()=>o});var l=s(37876),r=s(89099),a=s(14232),i=s(86535),n=s.n(i);function o({supportPortalVaIframeProps:e}){let t="true"===(0,r.useRouter)().query.autoStartVa,[s,i]=(0,a.useState)(!1),d=(0,a.useRef)(null);if((0,a.useEffect)(()=>{function s(s){if(s.origin===e.supportPortalUrl)switch(s.data.type){case"open":d.current&&(d.current.style.display="inline",d.current.style.height=t?"750px":"95px");break;case"start":d.current&&(d.current.style.height="750px");break;case"stop":i(!1)}}return window.addEventListener("message",s),i(!0),()=>{window.removeEventListener("message",s)}},[]),!s)return null;let c=new URLSearchParams({flow:e.vaFlowUrlParameter});c.set("flow",e.vaFlowUrlParameter),t&&c.set("autoStartVa","true");let u=`${e.supportPortalUrl}/iframe/docs_va?${c}`;return(0,l.jsx)("iframe",{className:n().supportPortalIframe,ref:d,title:"support-portal-va",id:"support-portal-iframe",src:u})}},76607:e=>{e.exports={title:"ArticleTitle_title__wOdiS"}},78537:(e,t,s)=>{"use strict";s.d(t,{$:()=>a});var l=s(14232),r=s(89099);let a=()=>{let e=(0,r.useRouter)();return(0,l.useEffect)(()=>{let t=(()=>{let e=new URLSearchParams(window.location.search),t=new URLSearchParams;for(let[s,l]of e)s.startsWith("utm_")&&t.set(s,l);return t})();if(""===t.toString())return;let s=e=>{let t=e.toLowerCase(),s=t.startsWith("https://")||t.startsWith("http://"),l=t.includes("github.com"),r=t.includes("docs.github.com");return s&&l&&!r},l=(e,t)=>{try{let s=new URL(e);for(let[e,l]of t)s.searchParams.set(e,l);return s.toString()}catch{return e}},r=()=>{for(let e of document.querySelectorAll("a[href]"))e.href&&s(e.href)&&(e.href=l(e.href,t))},a=e=>{let r=e.target?.closest("a");r&&r.href&&s(r.href)&&(r.href=l(r.href,t))};r(),document.addEventListener("click",a,!0);let i=()=>{setTimeout(r,100)};return e.events.on("routeChangeComplete",i),()=>{document.removeEventListener("click",a,!0),e.events.off("routeChangeComplete",i)}},[e.asPath,e.events]),null}},86535:e=>{e.exports={supportPortalIframe:"SupportPortalVaIframe_supportPortalIframe__ay0ez"}},96037:(e,t,s)=>{"use strict";s.d(t,{e:()=>d});var l=s(37876),r=s(57596),a=s(65793),i=s(57016),n=s.n(i),o=s(67309);function d({product:e,permissions:t}){let{t:s}=(0,a.B)("pages");return t||e?(0,l.jsx)("div",{className:n().permissionsBox,children:(0,l.jsxs)("div",{"data-search":"hide","data-testid":"permissions-callout",children:[(0,l.jsx)("div",{className:"mb-3 d-inline-block",children:(0,l.jsx)("h2",{className:"f4",children:s("permissions_callout_title")})}),t&&(0,l.jsxs)("div",{className:"d-flex permissions-statement","data-testid":"permissions-statement",children:[(0,l.jsx)(r.nXn,{className:"mt-1"}),(0,l.jsx)(o.T,{as:"div",className:"pl-2",html:t})]}),e&&(0,l.jsxs)("div",{className:"d-flex product-statement","data-testid":"product-statement",children:[(0,l.jsx)(r._dQ,{className:"mt-1"}),(0,l.jsx)(o.T,{as:"div",className:"pl-2",html:e})]})]})}):null}}}]);