@atproto/api
Version:
Client library for atproto and Bluesky
1,127 lines • 1.46 MB
TypeScript
/**
* GENERATED CODE - DO NOT MODIFY
*/
import { Lexicons, type ValidationResult } from '@atproto/lexicon';
export declare const schemaDict: {
readonly ComAtprotoAdminDefs: {
readonly lexicon: 1;
readonly id: "com.atproto.admin.defs";
readonly defs: {
readonly statusAttr: {
readonly type: "object";
readonly required: ["applied"];
readonly properties: {
readonly applied: {
readonly type: "boolean";
};
readonly ref: {
readonly type: "string";
};
};
};
readonly accountView: {
readonly type: "object";
readonly required: ["did", "handle", "indexedAt"];
readonly properties: {
readonly did: {
readonly type: "string";
readonly format: "did";
};
readonly handle: {
readonly type: "string";
readonly format: "handle";
};
readonly email: {
readonly type: "string";
};
readonly relatedRecords: {
readonly type: "array";
readonly items: {
readonly type: "unknown";
};
};
readonly indexedAt: {
readonly type: "string";
readonly format: "datetime";
};
readonly invitedBy: {
readonly type: "ref";
readonly ref: "lex:com.atproto.server.defs#inviteCode";
};
readonly invites: {
readonly type: "array";
readonly items: {
readonly type: "ref";
readonly ref: "lex:com.atproto.server.defs#inviteCode";
};
};
readonly invitesDisabled: {
readonly type: "boolean";
};
readonly emailConfirmedAt: {
readonly type: "string";
readonly format: "datetime";
};
readonly inviteNote: {
readonly type: "string";
};
readonly deactivatedAt: {
readonly type: "string";
readonly format: "datetime";
};
readonly threatSignatures: {
readonly type: "array";
readonly items: {
readonly type: "ref";
readonly ref: "lex:com.atproto.admin.defs#threatSignature";
};
};
};
};
readonly repoRef: {
readonly type: "object";
readonly required: ["did"];
readonly properties: {
readonly did: {
readonly type: "string";
readonly format: "did";
};
};
};
readonly repoBlobRef: {
readonly type: "object";
readonly required: ["did", "cid"];
readonly properties: {
readonly did: {
readonly type: "string";
readonly format: "did";
};
readonly cid: {
readonly type: "string";
readonly format: "cid";
};
readonly recordUri: {
readonly type: "string";
readonly format: "at-uri";
};
};
};
readonly threatSignature: {
readonly type: "object";
readonly required: ["property", "value"];
readonly properties: {
readonly property: {
readonly type: "string";
};
readonly value: {
readonly type: "string";
};
};
};
};
};
readonly ComAtprotoAdminDeleteAccount: {
readonly lexicon: 1;
readonly id: "com.atproto.admin.deleteAccount";
readonly defs: {
readonly main: {
readonly type: "procedure";
readonly description: "Delete a user account as an administrator.";
readonly input: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["did"];
readonly properties: {
readonly did: {
readonly type: "string";
readonly format: "did";
};
};
};
};
};
};
};
readonly ComAtprotoAdminDisableAccountInvites: {
readonly lexicon: 1;
readonly id: "com.atproto.admin.disableAccountInvites";
readonly defs: {
readonly main: {
readonly type: "procedure";
readonly description: "Disable an account from receiving new invite codes, but does not invalidate existing codes.";
readonly input: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["account"];
readonly properties: {
readonly account: {
readonly type: "string";
readonly format: "did";
};
readonly note: {
readonly type: "string";
readonly description: "Optional reason for disabled invites.";
};
};
};
};
};
};
};
readonly ComAtprotoAdminDisableInviteCodes: {
readonly lexicon: 1;
readonly id: "com.atproto.admin.disableInviteCodes";
readonly defs: {
readonly main: {
readonly type: "procedure";
readonly description: "Disable some set of codes and/or all codes associated with a set of users.";
readonly input: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly properties: {
readonly codes: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly accounts: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
};
};
};
};
};
};
readonly ComAtprotoAdminEnableAccountInvites: {
readonly lexicon: 1;
readonly id: "com.atproto.admin.enableAccountInvites";
readonly defs: {
readonly main: {
readonly type: "procedure";
readonly description: "Re-enable an account's ability to receive invite codes.";
readonly input: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["account"];
readonly properties: {
readonly account: {
readonly type: "string";
readonly format: "did";
};
readonly note: {
readonly type: "string";
readonly description: "Optional reason for enabled invites.";
};
};
};
};
};
};
};
readonly ComAtprotoAdminGetAccountInfo: {
readonly lexicon: 1;
readonly id: "com.atproto.admin.getAccountInfo";
readonly defs: {
readonly main: {
readonly type: "query";
readonly description: "Get details about an account.";
readonly parameters: {
readonly type: "params";
readonly required: ["did"];
readonly properties: {
readonly did: {
readonly type: "string";
readonly format: "did";
};
};
};
readonly output: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "ref";
readonly ref: "lex:com.atproto.admin.defs#accountView";
};
};
};
};
};
readonly ComAtprotoAdminGetAccountInfos: {
readonly lexicon: 1;
readonly id: "com.atproto.admin.getAccountInfos";
readonly defs: {
readonly main: {
readonly type: "query";
readonly description: "Get details about some accounts.";
readonly parameters: {
readonly type: "params";
readonly required: ["dids"];
readonly properties: {
readonly dids: {
readonly type: "array";
readonly items: {
readonly type: "string";
readonly format: "did";
};
};
};
};
readonly output: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["infos"];
readonly properties: {
readonly infos: {
readonly type: "array";
readonly items: {
readonly type: "ref";
readonly ref: "lex:com.atproto.admin.defs#accountView";
};
};
};
};
};
};
};
};
readonly ComAtprotoAdminGetInviteCodes: {
readonly lexicon: 1;
readonly id: "com.atproto.admin.getInviteCodes";
readonly defs: {
readonly main: {
readonly type: "query";
readonly description: "Get an admin view of invite codes.";
readonly parameters: {
readonly type: "params";
readonly properties: {
readonly sort: {
readonly type: "string";
readonly knownValues: ["recent", "usage"];
readonly default: "recent";
};
readonly limit: {
readonly type: "integer";
readonly minimum: 1;
readonly maximum: 500;
readonly default: 100;
};
readonly cursor: {
readonly type: "string";
};
};
};
readonly output: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["codes"];
readonly properties: {
readonly cursor: {
readonly type: "string";
};
readonly codes: {
readonly type: "array";
readonly items: {
readonly type: "ref";
readonly ref: "lex:com.atproto.server.defs#inviteCode";
};
};
};
};
};
};
};
};
readonly ComAtprotoAdminGetSubjectStatus: {
readonly lexicon: 1;
readonly id: "com.atproto.admin.getSubjectStatus";
readonly defs: {
readonly main: {
readonly type: "query";
readonly description: "Get the service-specific admin status of a subject (account, record, or blob).";
readonly parameters: {
readonly type: "params";
readonly properties: {
readonly did: {
readonly type: "string";
readonly format: "did";
};
readonly uri: {
readonly type: "string";
readonly format: "at-uri";
};
readonly blob: {
readonly type: "string";
readonly format: "cid";
};
};
};
readonly output: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["subject"];
readonly properties: {
readonly subject: {
readonly type: "union";
readonly refs: ["lex:com.atproto.admin.defs#repoRef", "lex:com.atproto.repo.strongRef", "lex:com.atproto.admin.defs#repoBlobRef"];
};
readonly takedown: {
readonly type: "ref";
readonly ref: "lex:com.atproto.admin.defs#statusAttr";
};
readonly deactivated: {
readonly type: "ref";
readonly ref: "lex:com.atproto.admin.defs#statusAttr";
};
};
};
};
};
};
};
readonly ComAtprotoAdminSearchAccounts: {
readonly lexicon: 1;
readonly id: "com.atproto.admin.searchAccounts";
readonly defs: {
readonly main: {
readonly type: "query";
readonly description: "Get list of accounts that matches your search query.";
readonly parameters: {
readonly type: "params";
readonly properties: {
readonly email: {
readonly type: "string";
};
readonly cursor: {
readonly type: "string";
};
readonly limit: {
readonly type: "integer";
readonly minimum: 1;
readonly maximum: 100;
readonly default: 50;
};
};
};
readonly output: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["accounts"];
readonly properties: {
readonly cursor: {
readonly type: "string";
};
readonly accounts: {
readonly type: "array";
readonly items: {
readonly type: "ref";
readonly ref: "lex:com.atproto.admin.defs#accountView";
};
};
};
};
};
};
};
};
readonly ComAtprotoAdminSendEmail: {
readonly lexicon: 1;
readonly id: "com.atproto.admin.sendEmail";
readonly defs: {
readonly main: {
readonly type: "procedure";
readonly description: "Send email to a user's account email address.";
readonly input: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["recipientDid", "content", "senderDid"];
readonly properties: {
readonly recipientDid: {
readonly type: "string";
readonly format: "did";
};
readonly content: {
readonly type: "string";
};
readonly subject: {
readonly type: "string";
};
readonly senderDid: {
readonly type: "string";
readonly format: "did";
};
readonly comment: {
readonly type: "string";
readonly description: "Additional comment by the sender that won't be used in the email itself but helpful to provide more context for moderators/reviewers";
};
};
};
};
readonly output: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["sent"];
readonly properties: {
readonly sent: {
readonly type: "boolean";
};
};
};
};
};
};
};
readonly ComAtprotoAdminUpdateAccountEmail: {
readonly lexicon: 1;
readonly id: "com.atproto.admin.updateAccountEmail";
readonly defs: {
readonly main: {
readonly type: "procedure";
readonly description: "Administrative action to update an account's email.";
readonly input: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["account", "email"];
readonly properties: {
readonly account: {
readonly type: "string";
readonly format: "at-identifier";
readonly description: "The handle or DID of the repo.";
};
readonly email: {
readonly type: "string";
};
};
};
};
};
};
};
readonly ComAtprotoAdminUpdateAccountHandle: {
readonly lexicon: 1;
readonly id: "com.atproto.admin.updateAccountHandle";
readonly defs: {
readonly main: {
readonly type: "procedure";
readonly description: "Administrative action to update an account's handle.";
readonly input: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["did", "handle"];
readonly properties: {
readonly did: {
readonly type: "string";
readonly format: "did";
};
readonly handle: {
readonly type: "string";
readonly format: "handle";
};
};
};
};
};
};
};
readonly ComAtprotoAdminUpdateAccountPassword: {
readonly lexicon: 1;
readonly id: "com.atproto.admin.updateAccountPassword";
readonly defs: {
readonly main: {
readonly type: "procedure";
readonly description: "Update the password for a user account as an administrator.";
readonly input: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["did", "password"];
readonly properties: {
readonly did: {
readonly type: "string";
readonly format: "did";
};
readonly password: {
readonly type: "string";
};
};
};
};
};
};
};
readonly ComAtprotoAdminUpdateAccountSigningKey: {
readonly lexicon: 1;
readonly id: "com.atproto.admin.updateAccountSigningKey";
readonly defs: {
readonly main: {
readonly type: "procedure";
readonly description: "Administrative action to update an account's signing key in their Did document.";
readonly input: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["did", "signingKey"];
readonly properties: {
readonly did: {
readonly type: "string";
readonly format: "did";
};
readonly signingKey: {
readonly type: "string";
readonly format: "did";
readonly description: "Did-key formatted public key";
};
};
};
};
};
};
};
readonly ComAtprotoAdminUpdateSubjectStatus: {
readonly lexicon: 1;
readonly id: "com.atproto.admin.updateSubjectStatus";
readonly defs: {
readonly main: {
readonly type: "procedure";
readonly description: "Update the service-specific admin status of a subject (account, record, or blob).";
readonly input: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["subject"];
readonly properties: {
readonly subject: {
readonly type: "union";
readonly refs: ["lex:com.atproto.admin.defs#repoRef", "lex:com.atproto.repo.strongRef", "lex:com.atproto.admin.defs#repoBlobRef"];
};
readonly takedown: {
readonly type: "ref";
readonly ref: "lex:com.atproto.admin.defs#statusAttr";
};
readonly deactivated: {
readonly type: "ref";
readonly ref: "lex:com.atproto.admin.defs#statusAttr";
};
};
};
};
readonly output: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["subject"];
readonly properties: {
readonly subject: {
readonly type: "union";
readonly refs: ["lex:com.atproto.admin.defs#repoRef", "lex:com.atproto.repo.strongRef", "lex:com.atproto.admin.defs#repoBlobRef"];
};
readonly takedown: {
readonly type: "ref";
readonly ref: "lex:com.atproto.admin.defs#statusAttr";
};
};
};
};
};
};
};
readonly ComAtprotoIdentityDefs: {
readonly lexicon: 1;
readonly id: "com.atproto.identity.defs";
readonly defs: {
readonly identityInfo: {
readonly type: "object";
readonly required: ["did", "handle", "didDoc"];
readonly properties: {
readonly did: {
readonly type: "string";
readonly format: "did";
};
readonly handle: {
readonly type: "string";
readonly format: "handle";
readonly description: "The validated handle of the account; or 'handle.invalid' if the handle did not bi-directionally match the DID document.";
};
readonly didDoc: {
readonly type: "unknown";
readonly description: "The complete DID document for the identity.";
};
};
};
};
};
readonly ComAtprotoIdentityGetRecommendedDidCredentials: {
readonly lexicon: 1;
readonly id: "com.atproto.identity.getRecommendedDidCredentials";
readonly defs: {
readonly main: {
readonly type: "query";
readonly description: "Describe the credentials that should be included in the DID doc of an account that is migrating to this service.";
readonly output: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly properties: {
readonly rotationKeys: {
readonly description: "Recommended rotation keys for PLC dids. Should be undefined (or ignored) for did:webs.";
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly alsoKnownAs: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly verificationMethods: {
readonly type: "unknown";
};
readonly services: {
readonly type: "unknown";
};
};
};
};
};
};
};
readonly ComAtprotoIdentityRefreshIdentity: {
readonly lexicon: 1;
readonly id: "com.atproto.identity.refreshIdentity";
readonly defs: {
readonly main: {
readonly type: "procedure";
readonly description: "Request that the server re-resolve an identity (DID and handle). The server may ignore this request, or require authentication, depending on the role, implementation, and policy of the server.";
readonly input: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["identifier"];
readonly properties: {
readonly identifier: {
readonly type: "string";
readonly format: "at-identifier";
};
};
};
};
readonly output: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "ref";
readonly ref: "lex:com.atproto.identity.defs#identityInfo";
};
};
readonly errors: [{
readonly name: "HandleNotFound";
readonly description: "The resolution process confirmed that the handle does not resolve to any DID.";
}, {
readonly name: "DidNotFound";
readonly description: "The DID resolution process confirmed that there is no current DID.";
}, {
readonly name: "DidDeactivated";
readonly description: "The DID previously existed, but has been deactivated.";
}];
};
};
};
readonly ComAtprotoIdentityRequestPlcOperationSignature: {
readonly lexicon: 1;
readonly id: "com.atproto.identity.requestPlcOperationSignature";
readonly defs: {
readonly main: {
readonly type: "procedure";
readonly description: "Request an email with a code to in order to request a signed PLC operation. Requires Auth.";
};
};
};
readonly ComAtprotoIdentityResolveDid: {
readonly lexicon: 1;
readonly id: "com.atproto.identity.resolveDid";
readonly defs: {
readonly main: {
readonly type: "query";
readonly description: "Resolves DID to DID document. Does not bi-directionally verify handle.";
readonly parameters: {
readonly type: "params";
readonly required: ["did"];
readonly properties: {
readonly did: {
readonly type: "string";
readonly format: "did";
readonly description: "DID to resolve.";
};
};
};
readonly output: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["didDoc"];
readonly properties: {
readonly didDoc: {
readonly type: "unknown";
readonly description: "The complete DID document for the identity.";
};
};
};
};
readonly errors: [{
readonly name: "DidNotFound";
readonly description: "The DID resolution process confirmed that there is no current DID.";
}, {
readonly name: "DidDeactivated";
readonly description: "The DID previously existed, but has been deactivated.";
}];
};
};
};
readonly ComAtprotoIdentityResolveHandle: {
readonly lexicon: 1;
readonly id: "com.atproto.identity.resolveHandle";
readonly defs: {
readonly main: {
readonly type: "query";
readonly description: "Resolves an atproto handle (hostname) to a DID. Does not necessarily bi-directionally verify against the the DID document.";
readonly parameters: {
readonly type: "params";
readonly required: ["handle"];
readonly properties: {
readonly handle: {
readonly type: "string";
readonly format: "handle";
readonly description: "The handle to resolve.";
};
};
};
readonly output: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["did"];
readonly properties: {
readonly did: {
readonly type: "string";
readonly format: "did";
};
};
};
};
readonly errors: [{
readonly name: "HandleNotFound";
readonly description: "The resolution process confirmed that the handle does not resolve to any DID.";
}];
};
};
};
readonly ComAtprotoIdentityResolveIdentity: {
readonly lexicon: 1;
readonly id: "com.atproto.identity.resolveIdentity";
readonly defs: {
readonly main: {
readonly type: "query";
readonly description: "Resolves an identity (DID or Handle) to a full identity (DID document and verified handle).";
readonly parameters: {
readonly type: "params";
readonly required: ["identifier"];
readonly properties: {
readonly identifier: {
readonly type: "string";
readonly format: "at-identifier";
readonly description: "Handle or DID to resolve.";
};
};
};
readonly output: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "ref";
readonly ref: "lex:com.atproto.identity.defs#identityInfo";
};
};
readonly errors: [{
readonly name: "HandleNotFound";
readonly description: "The resolution process confirmed that the handle does not resolve to any DID.";
}, {
readonly name: "DidNotFound";
readonly description: "The DID resolution process confirmed that there is no current DID.";
}, {
readonly name: "DidDeactivated";
readonly description: "The DID previously existed, but has been deactivated.";
}];
};
};
};
readonly ComAtprotoIdentitySignPlcOperation: {
readonly lexicon: 1;
readonly id: "com.atproto.identity.signPlcOperation";
readonly defs: {
readonly main: {
readonly type: "procedure";
readonly description: "Signs a PLC operation to update some value(s) in the requesting DID's document.";
readonly input: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly properties: {
readonly token: {
readonly description: "A token received through com.atproto.identity.requestPlcOperationSignature";
readonly type: "string";
};
readonly rotationKeys: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly alsoKnownAs: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly verificationMethods: {
readonly type: "unknown";
};
readonly services: {
readonly type: "unknown";
};
};
};
};
readonly output: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["operation"];
readonly properties: {
readonly operation: {
readonly type: "unknown";
readonly description: "A signed DID PLC operation.";
};
};
};
};
};
};
};
readonly ComAtprotoIdentitySubmitPlcOperation: {
readonly lexicon: 1;
readonly id: "com.atproto.identity.submitPlcOperation";
readonly defs: {
readonly main: {
readonly type: "procedure";
readonly description: "Validates a PLC operation to ensure that it doesn't violate a service's constraints or get the identity into a bad state, then submits it to the PLC registry";
readonly input: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["operation"];
readonly properties: {
readonly operation: {
readonly type: "unknown";
};
};
};
};
};
};
};
readonly ComAtprotoIdentityUpdateHandle: {
readonly lexicon: 1;
readonly id: "com.atproto.identity.updateHandle";
readonly defs: {
readonly main: {
readonly type: "procedure";
readonly description: "Updates the current account's handle. Verifies handle validity, and updates did:plc document if necessary. Implemented by PDS, and requires auth.";
readonly input: {
readonly encoding: "application/json";
readonly schema: {
readonly type: "object";
readonly required: ["handle"];
readonly properties: {
readonly handle: {
readonly type: "string";
readonly format: "handle";
readonly description: "The new handle.";
};
};
};
};
};
};
};
readonly ComAtprotoLabelDefs: {
readonly lexicon: 1;
readonly id: "com.atproto.label.defs";
readonly defs: {
readonly label: {
readonly type: "object";
readonly description: "Metadata tag on an atproto resource (eg, repo or record).";
readonly required: ["src", "uri", "val", "cts"];
readonly properties: {
readonly ver: {
readonly type: "integer";
readonly description: "The AT Protocol version of the label object.";
};
readonly src: {
readonly type: "string";
readonly format: "did";
readonly description: "DID of the actor who created this label.";
};
readonly uri: {
readonly type: "string";
readonly format: "uri";
readonly description: "AT URI of the record, repository (account), or other resource that this label applies to.";
};
readonly cid: {
readonly type: "string";
readonly format: "cid";
readonly description: "Optionally, CID specifying the specific version of 'uri' resource this label applies to.";
};
readonly val: {
readonly type: "string";
readonly maxLength: 128;
readonly description: "The short string name of the value or type of this label.";
};
readonly neg: {
readonly type: "boolean";
readonly description: "If true, this is a negation label, overwriting a previous label.";
};
readonly cts: {
readonly type: "string";
readonly format: "datetime";
readonly description: "Timestamp when this label was created.";
};
readonly exp: {
readonly type: "string";
readonly format: "datetime";
readonly description: "Timestamp at which this label expires (no longer applies).";
};
readonly sig: {
readonly type: "bytes";
readonly description: "Signature of dag-cbor encoded label.";
};
};
};
readonly selfLabels: {
readonly type: "object";
readonly description: "Metadata tags on an atproto record, published by the author within the record.";
readonly required: ["values"];
readonly properties: {
readonly values: {
readonly type: "array";
readonly items: {
readonly type: "ref";
readonly ref: "lex:com.atproto.label.defs#selfLabel";
};
readonly maxLength: 10;
};
};
};
readonly selfLabel: {
readonly type: "object";
readonly description: "Metadata tag on an atproto record, published by the author within the record. Note that schemas should use #selfLabels, not #selfLabel.";
readonly required: ["val"];
readonly properties: {
readonly val: {
readonly type: "string";
readonly maxLength: 128;
readonly description: "The short string name of the value or type of this label.";
};
};
};
readonly labelValueDefinition: {
readonly type: "object";
readonly description: "Declares a label value and its expected interpretations and behaviors.";
readonly required: ["identifier", "severity", "blurs", "locales"];
readonly properties: {
readonly identifier: {
readonly type: "string";
readonly description: "The value of the label being defined. Must only include lowercase ascii and the '-' character ([a-z-]+).";
readonly maxLength: 100;
readonly maxGraphemes: 100;
};
readonly severity: {
readonly type: "string";
readonly description: "How should a client visually convey this label? 'inform' means neutral and informational; 'alert' means negative and warning; 'none' means show nothing.";
readonly knownValues: ["inform", "alert", "none"];
};
readonly blurs: {
readonly type: "string";
readonly description: "What should this label hide in the UI, if applied? 'content' hides all of the target; 'media' hides the images/video/audio; 'none' hides nothing.";
readonly knownValues: ["content", "media", "none"];
};
readonly defaultSetting: {
readonly type: "string";
readonly description: "The default setting for this label.";
readonly knownValues: ["ignore", "warn", "hide"];
readonly default: "warn";
};
readonly adultOnly: {
readonly type: "boolean";
readonly description: "Does the user need to have adult content enabled in order to configure this label?";
};
readonly locales: {
readonly type: "array";
readonly items: {
readonly type: "ref";
readonly ref: "lex:com.atproto.label.defs#labelValueDefinitionStrings";
};
};
};
};
readonly labelValueDefinitionStrings: {
readonly type: "object";
readonly description: "Strings which describe the label in the UI, localized into a specific language.";
readonly required: ["lang", "name", "description"];
readonly properties: {
readonly lang: {
readonly type: "string";
readonly description: "The code of the language these strings are written in.";
readonly format: "language";
};
readonly name: {
readonly type: "string";
readonly description: "A short human-readable name for the label.";
readonly maxGraphemes: 64;
readonly maxLength: 640;
};
readonly description: {
readonly type: "string";
readonly description: "A longer description of what the label means and why it might be applied.";
readonly maxGraphemes: 10000;
readonly maxLength: 100000;
};
};
};
readonly labelValue: {
readonly type: "string";
readonly knownValues: ["!hide", "!no-promote", "!warn", "!no-unauthenticated", "dmca-violation", "doxxing", "porn", "sexual", "nudity", "nsfl", "gore"];
};
};
};
readonly ComAtprotoLabelQueryLabels: {
readonly lexicon: 1;
readonly id: "com.atproto.label.queryLabels";
readonly defs: {
readonly main: {
readonly type: "query";
readonly description: "Find labels r