Account migration schemas #2170
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@atproto/api': minor | ||
| --- | ||
|
|
||
| Add lexicons and methods for account migration |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| { | ||
| "lexicon": 1, | ||
| "id": "com.atproto.identity.getRecommendedDidCredentials", | ||
| "defs": { | ||
| "main": { | ||
| "type": "query", | ||
| "description": "Describe the credentials that should be included in the DID doc of an account that is migrating to this service.", | ||
| "output": { | ||
| "encoding": "application/json", | ||
| "schema": { | ||
| "type": "object", | ||
| "properties": { | ||
| "rotationKeys": { | ||
| "description": "Recommended rotation keys for PLC dids. Should be undefined (or ignored) for did:webs.", | ||
| "type": "array", | ||
| "items": { "type": "string" } | ||
| }, | ||
| "alsoKnownAs": { | ||
| "type": "array", | ||
| "items": { "type": "string" } | ||
| }, | ||
| "verificationMethods": { "type": "unknown" }, | ||
| "services": { "type": "unknown" } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| { | ||
| "lexicon": 1, | ||
| "id": "com.atproto.identity.requestPlcOperationSignature", | ||
| "defs": { | ||
| "main": { | ||
| "type": "procedure", | ||
| "description": "Request an email with a code to in order to request a signed PLC operation. Requires Auth." | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| { | ||
| "lexicon": 1, | ||
| "id": "com.atproto.identity.signPlcOperation", | ||
| "defs": { | ||
| "main": { | ||
| "type": "procedure", | ||
| "description": "Signs a PLC operation to update some value(s) in the requesting DID's document.", | ||
| "input": { | ||
| "encoding": "application/json", | ||
| "schema": { | ||
| "type": "object", | ||
| "properties": { | ||
| "token": { | ||
| "description": "A token received through com.atproto.identity.requestPlcOperationSignature", | ||
| "type": "string" | ||
| }, | ||
| "rotationKeys": { | ||
| "type": "array", | ||
| "items": { "type": "string" } | ||
| }, | ||
| "alsoKnownAs": { | ||
| "type": "array", | ||
| "items": { "type": "string" } | ||
| }, | ||
| "verificationMethods": { "type": "unknown" }, | ||
| "services": { "type": "unknown" } | ||
| } | ||
| } | ||
| }, | ||
| "output": { | ||
| "encoding": "application/json", | ||
| "schema": { | ||
| "type": "object", | ||
| "required": ["operation"], | ||
| "properties": { | ||
| "operation": { | ||
| "type": "unknown", | ||
| "description": "A signed DID PLC operation." | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| { | ||
| "lexicon": 1, | ||
| "id": "com.atproto.identity.submitPlcOperation", | ||
| "defs": { | ||
| "main": { | ||
| "type": "procedure", | ||
| "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", | ||
| "input": { | ||
| "encoding": "application/json", | ||
| "schema": { | ||
| "type": "object", | ||
| "required": ["operation"], | ||
| "properties": { | ||
| "operation": { "type": "unknown" } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| { | ||
| "lexicon": 1, | ||
| "id": "com.atproto.repo.importRepo", | ||
| "defs": { | ||
| "main": { | ||
| "type": "procedure", | ||
| "description": "Import a repo in the form of a CAR file. Requires Content-Length HTTP header to be set.", | ||
| "input": { | ||
| "encoding": "application/vnd.ipld.car" | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| { | ||
| "lexicon": 1, | ||
| "id": "com.atproto.repo.listMissingBlobs", | ||
| "defs": { | ||
| "main": { | ||
| "type": "query", | ||
| "description": "Returns a list of missing blobs for the requesting account. Intended to be used in the account migration flow.", | ||
| "parameters": { | ||
| "type": "params", | ||
| "properties": { | ||
| "limit": { | ||
| "type": "integer", | ||
| "minimum": 1, | ||
| "maximum": 1000, | ||
| "default": 500 | ||
| }, | ||
| "cursor": { "type": "string" } | ||
| } | ||
| }, | ||
| "output": { | ||
| "encoding": "application/json", | ||
| "schema": { | ||
| "type": "object", | ||
| "required": ["blobs"], | ||
| "properties": { | ||
| "cursor": { "type": "string" }, | ||
| "blobs": { | ||
| "type": "array", | ||
| "items": { "type": "ref", "ref": "#recordBlob" } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "recordBlob": { | ||
| "type": "object", | ||
| "required": ["cid", "recordUri"], | ||
| "properties": { | ||
| "cid": { "type": "string", "format": "cid" }, | ||
| "recordUri": { "type": "string", "format": "at-uri" } | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| { | ||
| "lexicon": 1, | ||
| "id": "com.atproto.server.activateAccount", | ||
| "defs": { | ||
| "main": { | ||
| "type": "procedure", | ||
| "description": "Activates a currently deactivated account. Used to finalize account migration after the account's repo is imported and identity is setup." | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| { | ||
| "lexicon": 1, | ||
| "id": "com.atproto.server.checkAccountStatus", | ||
| "defs": { | ||
| "main": { | ||
| "type": "query", | ||
| "description": "Returns the status of an account, especially as pertaining to import or recovery. Can be called many times over the course of an account migration. Requires auth and can only be called pertaining to oneself.", | ||
| "output": { | ||
| "encoding": "application/json", | ||
| "schema": { | ||
| "type": "object", | ||
| "required": [ | ||
| "activated", | ||
| "validDid", | ||
| "repoCommit", | ||
| "repoRev", | ||
| "repoBlocks", | ||
| "indexedRecords", | ||
| "privateStateValues", | ||
| "expectedBlobs", | ||
| "importedBlobs" | ||
| ], | ||
| "properties": { | ||
| "activated": { "type": "boolean" }, | ||
| "validDid": { "type": "boolean" }, | ||
| "repoCommit": { "type": "string", "format": "cid" }, | ||
| "repoRev": { "type": "string" }, | ||
| "repoBlocks": { "type": "integer" }, | ||
| "indexedRecords": { "type": "integer" }, | ||
| "privateStateValues": { "type": "integer" }, | ||
| "expectedBlobs": { "type": "integer" }, | ||
| "importedBlobs": { "type": "integer" } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| { | ||
| "lexicon": 1, | ||
| "id": "com.atproto.server.deactivateAccount", | ||
| "defs": { | ||
| "main": { | ||
| "type": "procedure", | ||
| "description": "Deactivates a currently active account. Stops serving of repo, and future writes to repo until reactivated. Used to finalize account migration with the old host after the account has been activated on the new host.", | ||
| "input": { | ||
| "encoding": "application/json", | ||
| "schema": { | ||
| "type": "object", | ||
| "properties": { | ||
| "deleteAfter": { | ||
| "type": "string", | ||
| "format": "datetime", | ||
| "description": "A recommendation to server as to how long they should hold onto the deactivated account before deleting." | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| { | ||
| "lexicon": 1, | ||
| "id": "com.atproto.server.getServiceAuth", | ||
| "defs": { | ||
| "main": { | ||
| "type": "query", | ||
| "description": "Get a signed token on behalf of the requesting DID for the requested service.", | ||
| "parameters": { | ||
| "type": "params", | ||
| "required": ["aud"], | ||
| "properties": { | ||
|
There was a problem hiding this comment. what about expiration ( There was a problem hiding this comment. Makes me a bit uneasy honestly - I don't think we want to offer long versions of these tokens. If you request one, you should really only be using it once There was a problem hiding this comment. I definitely think the returned token should have some There was a problem hiding this comment. Oh to clarify - the returned token does have an We just don't provide optionality around requesting a longer one |
||
| "aud": { | ||
| "type": "string", | ||
| "format": "did", | ||
|
There was a problem hiding this comment. if we make this There was a problem hiding this comment. I like just leaving it DID for now until we see the need for that. I think we can upgrade into |
||
| "description": "The DID of the service that the token will be used to authenticate with" | ||
| } | ||
| } | ||
| }, | ||
| "output": { | ||
| "encoding": "application/json", | ||
| "schema": { | ||
| "type": "object", | ||
| "required": ["token"], | ||
| "properties": { | ||
| "token": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it is a tiny bit weird having
rotationKeyshere. it matches the PLC operation syntax/fields, but the other fields here match DID document fields but this one doesn't. I guess it's fine?plcRotationKeysis tempting but probably not worth breaking consistency.a
descriptionon this field (in the Lexicon schema) would be good.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I agree :/ But I think it makes most sense to return them here & keep it consistent with the other routes.
One thing we can do that may make it go down a bit easier is not return
rotationKeyswhen this route is requested by adid:web. If we add some additional method that requires another field, we can add another property to the response this would be undefined for plc & web didsThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice! that is a good way to handle it.