lex: deprecate getRecord commit param (bluesky-social#2349)

* lexicons: mark getRecord commit param as deprecated * codgen lex description tweak
anapalmeida · Mar 20, 2024 · f8dffa2 · f8dffa2
1 parent c8a5fb4
commit f8dffa2
Show file tree

Hide file tree

Showing 7 changed files with 10 additions and 7 deletions.
diff --git a/lexicons/com/atproto/sync/getRecord.json b/lexicons/com/atproto/sync/getRecord.json
@@ -19,7 +19,7 @@
           "commit": {
             "type": "string",
             "format": "cid",
-            "description": "An optional past commit CID."
+            "description": "DEPRECATED: referenced a repo commit by CID, and retrieved record as of that commit"
           }
         }
       },

diff --git a/packages/bsky/src/lexicon/lexicons.ts b/packages/bsky/src/lexicon/lexicons.ts
@@ -3052,7 +3052,8 @@ export const schemaDict = {
             commit: {
               type: 'string',
               format: 'cid',
-              description: 'An optional past commit CID.',
+              description:
+                'DEPRECATED: referenced a repo commit by CID, and retrieved record as of that commit',
             },
           },
         },

diff --git a/packages/bsky/src/lexicon/types/com/atproto/sync/getRecord.ts b/packages/bsky/src/lexicon/types/com/atproto/sync/getRecord.ts
@@ -15,7 +15,7 @@ export interface QueryParams {
   collection: string
   /** Record Key */
   rkey: string
-  /** An optional past commit CID. */
+  /** DEPRECATED: referenced a repo commit by CID, and retrieved record as of that commit */
   commit?: string
 }
 

diff --git a/packages/ozone/src/lexicon/lexicons.ts b/packages/ozone/src/lexicon/lexicons.ts
@@ -3052,7 +3052,8 @@ export const schemaDict = {
             commit: {
               type: 'string',
               format: 'cid',
-              description: 'An optional past commit CID.',
+              description:
+                'DEPRECATED: referenced a repo commit by CID, and retrieved record as of that commit',
             },
           },
         },

diff --git a/packages/ozone/src/lexicon/types/com/atproto/sync/getRecord.ts b/packages/ozone/src/lexicon/types/com/atproto/sync/getRecord.ts
@@ -15,7 +15,7 @@ export interface QueryParams {
   collection: string
   /** Record Key */
   rkey: string
-  /** An optional past commit CID. */
+  /** DEPRECATED: referenced a repo commit by CID, and retrieved record as of that commit */
   commit?: string
 }
 

diff --git a/packages/pds/src/lexicon/lexicons.ts b/packages/pds/src/lexicon/lexicons.ts
@@ -3052,7 +3052,8 @@ export const schemaDict = {
             commit: {
               type: 'string',
               format: 'cid',
-              description: 'An optional past commit CID.',
+              description:
+                'DEPRECATED: referenced a repo commit by CID, and retrieved record as of that commit',
             },
           },
         },

diff --git a/packages/pds/src/lexicon/types/com/atproto/sync/getRecord.ts b/packages/pds/src/lexicon/types/com/atproto/sync/getRecord.ts
@@ -15,7 +15,7 @@ export interface QueryParams {
   collection: string
   /** Record Key */
   rkey: string
-  /** An optional past commit CID. */
+  /** DEPRECATED: referenced a repo commit by CID, and retrieved record as of that commit */
   commit?: string
 }