Fix sitemap api docs

Shopify · Oct 22, 2024 · 85b8e1b · 85b8e1b
1 parent 664af1d
commit 85b8e1b
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/packages/hydrogen/src/sitemap/getSitemap.doc.ts b/packages/hydrogen/src/sitemap/getSitemap.doc.ts
@@ -11,7 +11,7 @@ const data: ReferenceEntityTemplateSchema = {
       url: '/api/hydrogen/utilities/getSitemapIndex',
     },
   ],
-  description: `> Caution:\n> This component is in an unstable pre-release state and may have breaking changes in a future release.\n\nGenerate a sitemap for a specific resource type. Returns a standard Response object.`,
+  description: `Generate a sitemap for a specific resource type. Returns a standard Response object.`,
   type: 'utility',
   defaultExample: {
     description: 'I am the default example',

diff --git a/packages/hydrogen/src/sitemap/getSitemap.example.jsx b/packages/hydrogen/src/sitemap/getSitemap.example.jsx
@@ -1,4 +1,4 @@
-import {unstable__getSitemap as getSitemap} from '@shopify/hydrogen';
+import {getSitemap} from '@shopify/hydrogen';
 
 export async function loader({request, params, context: {storefront}}) {
   const response = await getSitemap({

diff --git a/packages/hydrogen/src/sitemap/getSitemapIndex.doc.ts b/packages/hydrogen/src/sitemap/getSitemapIndex.doc.ts
@@ -11,7 +11,7 @@ const data: ReferenceEntityTemplateSchema = {
       url: '/api/hydrogen/utilities/getSitemap',
     },
   ],
-  description: `> Caution:\n> This component is in an unstable pre-release state and may have breaking changes in a future release.\n\nGenerate a sitemap index that links to separate child sitemaps for different resource types. Returns a standard Response object.`,
+  description: `Generate a sitemap index that links to separate child sitemaps for different resource types. Returns a standard Response object.`,
   type: 'utility',
   defaultExample: {
     description: 'I am the default example',

diff --git a/packages/hydrogen/src/sitemap/getSitemapIndex.example.jsx b/packages/hydrogen/src/sitemap/getSitemapIndex.example.jsx
@@ -1,4 +1,4 @@
-import {unstable__getSitemapIndex as getSitemapIndex} from '@shopify/hydrogen';
+import {getSitemapIndex} from '@shopify/hydrogen';
 
 export async function loader({request, context: {storefront}}) {
   const response = await getSitemapIndex({