Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

lexicons: remove deprecated endpoints and fields #2376

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions lexicons/app/bsky/actor/searchActors.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@
"parameters": {
"type": "params",
"properties": {
"term": {
"type": "string",
"description": "DEPRECATED: use 'q' instead."
},
"q": {
"type": "string",
"description": "Search query string. Syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended."
Expand Down
4 changes: 0 additions & 4 deletions lexicons/app/bsky/actor/searchActorsTypeahead.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@
"parameters": {
"type": "params",
"properties": {
"term": {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like these never got switched over in the client 🙃

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh daaaarn. means we can't roll this out very confidently (don't want to break older clients).

I think the next step is probably to do a little PR that updates all that client API usage, and update this PR to not remove the deprecated term quite yet (maybe in a couple months).

"type": "string",
"description": "DEPRECATED: use 'q' instead."
},
"q": {
"type": "string",
"description": "Search query prefix; not a full query string."
Expand Down
8 changes: 0 additions & 8 deletions lexicons/com/atproto/repo/listRecords.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,6 @@
"description": "The number of records to return."
},
"cursor": { "type": "string" },
"rkeyStart": {
"type": "string",
"description": "DEPRECATED: The lowest sort-ordered rkey to start from (exclusive)"
},
"rkeyEnd": {
"type": "string",
"description": "DEPRECATED: The highest sort-ordered rkey to stop at (exclusive)"
},
"reverse": {
"type": "boolean",
"description": "Flag to reverse the order of the returned records."
Expand Down
24 changes: 0 additions & 24 deletions lexicons/com/atproto/sync/getCheckout.json

This file was deleted.

32 changes: 0 additions & 32 deletions lexicons/com/atproto/sync/getHead.json

This file was deleted.

7 changes: 1 addition & 6 deletions lexicons/com/atproto/sync/getRecord.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,7 @@
"description": "The DID of the repo."
},
"collection": { "type": "string", "format": "nsid" },
"rkey": { "type": "string", "description": "Record Key" },
"commit": {
"type": "string",
"format": "cid",
"description": "DEPRECATED: referenced a repo commit by CID, and retrieved record as of that commit"
}
"rkey": { "type": "string", "description": "Record Key" }
}
},
"output": {
Expand Down
4 changes: 0 additions & 4 deletions lexicons/com/atproto/sync/subscribeRepos.json
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,6 @@
"type": "cid-link",
"description": "Repo commit object CID."
},
"prev": {
"type": "cid-link",
"description": "DEPRECATED -- unused. WARNING -- nullable and optional; stick with optional to ensure golang interoperability."
},
"rev": {
"type": "string",
"description": "The rev of the emitted commit. Note that this information is also in the commit object included in blocks, unless this is a tooBig event."
Expand Down
4 changes: 0 additions & 4 deletions lexicons/tools/ozone/moderation/searchRepos.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@
"parameters": {
"type": "params",
"properties": {
"term": {
"type": "string",
"description": "DEPRECATED: use 'q' instead"
},
"q": { "type": "string" },
"limit": {
"type": "integer",
Expand Down
26 changes: 0 additions & 26 deletions packages/api/src/client/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,6 @@ import * as ComAtprotoServerRevokeAppPassword from './types/com/atproto/server/r
import * as ComAtprotoServerUpdateEmail from './types/com/atproto/server/updateEmail'
import * as ComAtprotoSyncGetBlob from './types/com/atproto/sync/getBlob'
import * as ComAtprotoSyncGetBlocks from './types/com/atproto/sync/getBlocks'
import * as ComAtprotoSyncGetCheckout from './types/com/atproto/sync/getCheckout'
import * as ComAtprotoSyncGetHead from './types/com/atproto/sync/getHead'
import * as ComAtprotoSyncGetLatestCommit from './types/com/atproto/sync/getLatestCommit'
import * as ComAtprotoSyncGetRecord from './types/com/atproto/sync/getRecord'
import * as ComAtprotoSyncGetRepo from './types/com/atproto/sync/getRepo'
Expand Down Expand Up @@ -230,8 +228,6 @@ export * as ComAtprotoServerRevokeAppPassword from './types/com/atproto/server/r
export * as ComAtprotoServerUpdateEmail from './types/com/atproto/server/updateEmail'
export * as ComAtprotoSyncGetBlob from './types/com/atproto/sync/getBlob'
export * as ComAtprotoSyncGetBlocks from './types/com/atproto/sync/getBlocks'
export * as ComAtprotoSyncGetCheckout from './types/com/atproto/sync/getCheckout'
export * as ComAtprotoSyncGetHead from './types/com/atproto/sync/getHead'
export * as ComAtprotoSyncGetLatestCommit from './types/com/atproto/sync/getLatestCommit'
export * as ComAtprotoSyncGetRecord from './types/com/atproto/sync/getRecord'
export * as ComAtprotoSyncGetRepo from './types/com/atproto/sync/getRepo'
Expand Down Expand Up @@ -1114,28 +1110,6 @@ export class ComAtprotoSyncNS {
})
}

getCheckout(
params?: ComAtprotoSyncGetCheckout.QueryParams,
opts?: ComAtprotoSyncGetCheckout.CallOptions,
): Promise<ComAtprotoSyncGetCheckout.Response> {
return this._service.xrpc
.call('com.atproto.sync.getCheckout', params, undefined, opts)
.catch((e) => {
throw ComAtprotoSyncGetCheckout.toKnownErr(e)
})
}

getHead(
params?: ComAtprotoSyncGetHead.QueryParams,
opts?: ComAtprotoSyncGetHead.CallOptions,
): Promise<ComAtprotoSyncGetHead.Response> {
return this._service.xrpc
.call('com.atproto.sync.getHead', params, undefined, opts)
.catch((e) => {
throw ComAtprotoSyncGetHead.toKnownErr(e)
})
}

getLatestCommit(
params?: ComAtprotoSyncGetLatestCommit.QueryParams,
opts?: ComAtprotoSyncGetLatestCommit.CallOptions,
Expand Down
99 changes: 0 additions & 99 deletions packages/api/src/client/lexicons.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1632,16 +1632,6 @@ export const schemaDict = {
cursor: {
type: 'string',
},
rkeyStart: {
type: 'string',
description:
'DEPRECATED: The lowest sort-ordered rkey to start from (exclusive)',
},
rkeyEnd: {
type: 'string',
description:
'DEPRECATED: The highest sort-ordered rkey to stop at (exclusive)',
},
reverse: {
type: 'boolean',
description: 'Flag to reverse the order of the returned records.',
Expand Down Expand Up @@ -2921,70 +2911,6 @@ export const schemaDict = {
},
},
},
ComAtprotoSyncGetCheckout: {
lexicon: 1,
id: 'com.atproto.sync.getCheckout',
defs: {
main: {
type: 'query',
description: 'DEPRECATED - please use com.atproto.sync.getRepo instead',
parameters: {
type: 'params',
required: ['did'],
properties: {
did: {
type: 'string',
format: 'did',
description: 'The DID of the repo.',
},
},
},
output: {
encoding: 'application/vnd.ipld.car',
},
},
},
},
ComAtprotoSyncGetHead: {
lexicon: 1,
id: 'com.atproto.sync.getHead',
defs: {
main: {
type: 'query',
description:
'DEPRECATED - please use com.atproto.sync.getLatestCommit instead',
parameters: {
type: 'params',
required: ['did'],
properties: {
did: {
type: 'string',
format: 'did',
description: 'The DID of the repo.',
},
},
},
output: {
encoding: 'application/json',
schema: {
type: 'object',
required: ['root'],
properties: {
root: {
type: 'string',
format: 'cid',
},
},
},
},
errors: [
{
name: 'HeadNotFound',
},
],
},
},
},
ComAtprotoSyncGetLatestCommit: {
lexicon: 1,
id: 'com.atproto.sync.getLatestCommit',
Expand Down Expand Up @@ -3053,12 +2979,6 @@ export const schemaDict = {
type: 'string',
description: 'Record Key',
},
commit: {
type: 'string',
format: 'cid',
description:
'DEPRECATED: referenced a repo commit by CID, and retrieved record as of that commit',
},
},
},
output: {
Expand Down Expand Up @@ -3345,11 +3265,6 @@ export const schemaDict = {
type: 'cid-link',
description: 'Repo commit object CID.',
},
prev: {
type: 'cid-link',
description:
'DEPRECATED -- unused. WARNING -- nullable and optional; stick with optional to ensure golang interoperability.',
},
rev: {
type: 'string',
description:
Expand Down Expand Up @@ -4246,10 +4161,6 @@ export const schemaDict = {
parameters: {
type: 'params',
properties: {
term: {
type: 'string',
description: "DEPRECATED: use 'q' instead.",
},
q: {
type: 'string',
description:
Expand Down Expand Up @@ -4299,10 +4210,6 @@ export const schemaDict = {
parameters: {
type: 'params',
properties: {
term: {
type: 'string',
description: "DEPRECATED: use 'q' instead.",
},
q: {
type: 'string',
description: 'Search query prefix; not a full query string.',
Expand Down Expand Up @@ -9153,10 +9060,6 @@ export const schemaDict = {
parameters: {
type: 'params',
properties: {
term: {
type: 'string',
description: "DEPRECATED: use 'q' instead",
},
q: {
type: 'string',
},
Expand Down Expand Up @@ -9270,8 +9173,6 @@ export const ids = {
ComAtprotoServerUpdateEmail: 'com.atproto.server.updateEmail',
ComAtprotoSyncGetBlob: 'com.atproto.sync.getBlob',
ComAtprotoSyncGetBlocks: 'com.atproto.sync.getBlocks',
ComAtprotoSyncGetCheckout: 'com.atproto.sync.getCheckout',
ComAtprotoSyncGetHead: 'com.atproto.sync.getHead',
ComAtprotoSyncGetLatestCommit: 'com.atproto.sync.getLatestCommit',
ComAtprotoSyncGetRecord: 'com.atproto.sync.getRecord',
ComAtprotoSyncGetRepo: 'com.atproto.sync.getRepo',
Expand Down
2 changes: 0 additions & 2 deletions packages/api/src/client/types/app/bsky/actor/searchActors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ import { CID } from 'multiformats/cid'
import * as AppBskyActorDefs from './defs'

export interface QueryParams {
/** DEPRECATED: use 'q' instead. */
term?: string
/** Search query string. Syntax, phrase, boolean, and faceting is unspecified, but Lucene query syntax is recommended. */
q?: string
limit?: number
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ import { CID } from 'multiformats/cid'
import * as AppBskyActorDefs from './defs'

export interface QueryParams {
/** DEPRECATED: use 'q' instead. */
term?: string
/** Search query prefix; not a full query string. */
q?: string
limit?: number
Expand Down
4 changes: 0 additions & 4 deletions packages/api/src/client/types/com/atproto/repo/listRecords.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,6 @@ export interface QueryParams {
/** The number of records to return. */
limit?: number
cursor?: string
/** DEPRECATED: The lowest sort-ordered rkey to start from (exclusive) */
rkeyStart?: string
/** DEPRECATED: The highest sort-ordered rkey to stop at (exclusive) */
rkeyEnd?: string
/** Flag to reverse the order of the returned records. */
reverse?: boolean
}
Expand Down
31 changes: 0 additions & 31 deletions packages/api/src/client/types/com/atproto/sync/getCheckout.ts

This file was deleted.

Loading
Loading