docs: clarify api perspective change

sanity-io · Feb 12, 2025 · adeb946 · adeb946
1 parent 7485afd
commit adeb946
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -9,7 +9,11 @@ const exp = defineCreateClientExports<SanityClient, ClientConfig>(envMiddleware,
 /** @public */
 export const requester = exp.requester
 
-/** @public */
+/**
+ * @remarks
+ * As of API version `v2025-02-19`, the default perspective used by the client has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/TODO|Changelog}
+ * @public
+ */
 export const createClient = exp.createClient
 
 /**

diff --git a/src/types.ts b/src/types.ts
@@ -60,9 +60,19 @@ export interface ClientConfig {
   /** @defaultValue true */
   useCdn?: boolean
   token?: string
-  /** @defaultValue 'published' if API version >= v2025-02-19, 'raw' if apiVersion < v2025-02-19 */
+
+  /**
+   * @remarks
+   * As of API version `v2025-02-19`, the default perspective has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/TODO|Changelog}
+   * @defaultValue 'published'
+   */
   perspective?: ClientPerspective
   apiHost?: string
+
+  /**
+   @remarks
+   * As of API version `v2025-02-19`, the default perspective has changed from `raw` to `published`. {@link https://www.sanity.io/changelog/TODO|Changelog}
+   */
   apiVersion?: string
   proxy?: string