User invite codes #757
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,26 @@ | ||
| { | ||
| "lexicon": 1, | ||
| "id": "com.atproto.admin.disableInviteCodes", | ||
| "defs": { | ||
| "main": { | ||
| "type": "procedure", | ||
| "description": "Disable some set of codes and/or all codes associated with a set of users", | ||
| "input": { | ||
| "encoding": "application/json", | ||
| "schema": { | ||
| "type": "object", | ||
| "properties": { | ||
| "codes": { | ||
| "type": "array", | ||
| "items": {"type": "string"} | ||
| }, | ||
| "accounts": { | ||
| "type": "array", | ||
| "items": {"type": "string"} | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
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,32 @@ | ||
| { | ||
| "lexicon": 1, | ||
| "id": "com.atproto.admin.getInviteCodeUsage", | ||
| "defs": { | ||
| "main": { | ||
| "type": "query", | ||
| "description": "High level stats about invite code usage", | ||
| "output": { | ||
| "encoding": "application/json", | ||
| "schema": { | ||
| "type": "object", | ||
| "required": ["total", "user", "admin"], | ||
| "properties": { | ||
| "total": { "type": "ref", "ref": "#codesDetail" }, | ||
| "user": { "type": "ref", "ref": "#codesDetail" }, | ||
| "admin": { "type": "ref", "ref": "#codesDetail" } | ||
|
There was a problem hiding this comment. I think it's on the horizon to switch-up how admin auth works, and certain user accounts may be marked as admins. Just tossing that out there for a gut check that this API will still match-up with that nicely, given that there could be overlap between "user" and "admin". I think it still could work— "user" would just have to be specifically for non-admin accounts. Or another way to think about it is whether the invite code is generated from |
||
| } | ||
| } | ||
| } | ||
| }, | ||
| "codesDetail": { | ||
| "type": "object", | ||
| "required": ["count", "available", "used", "disabled"], | ||
| "properties": { | ||
| "count": {"type": "integer"}, | ||
| "available": {"type": "integer"}, | ||
| "used": {"type": "integer"}, | ||
| "disabled": {"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,63 @@ | ||
| { | ||
| "lexicon": 1, | ||
| "id": "com.atproto.admin.getInviteCodes", | ||
| "defs": { | ||
| "main": { | ||
| "type": "query", | ||
| "description": "Admin view of invite codes", | ||
| "parameters": { | ||
| "type": "params", | ||
| "properties": { | ||
| "sort": { | ||
| "type": "string", | ||
| "knownValues": [ | ||
| "recent", | ||
| "usage" | ||
| ], | ||
| "default": "recent" | ||
| }, | ||
| "limit": {"type": "integer", "minimum": 1, "maximum": 500, "default": 100}, | ||
| "cursor": {"type": "string"} | ||
| } | ||
| }, | ||
| "output": { | ||
| "encoding": "application/json", | ||
| "schema": { | ||
| "type": "object", | ||
| "required": ["codes"], | ||
| "properties": { | ||
| "cursor": {"type": "string"}, | ||
| "codes": { | ||
| "type": "array", | ||
| "items": {"type": "ref", "ref": "#codeDetail"} | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "codeDetail": { | ||
| "type": "object", | ||
| "required": ["code", "available", "disabled", "forAccount", "createdBy", "createdAt", "uses"], | ||
| "properties": { | ||
| "code": {"type": "string"}, | ||
| "available": {"type": "integer"}, | ||
| "disabled": {"type": "boolean"}, | ||
| "forAccount": {"type": "string"}, | ||
| "createdBy": {"type": "string", "format": "datetime"}, | ||
| "createdAt": {"type": "string", "format": "datetime"}, | ||
| "uses": { | ||
| "type": "array", | ||
| "items": {"type": "ref", "ref": "#codeUse"} | ||
| } | ||
| } | ||
| }, | ||
| "codeUse": { | ||
| "type": "object", | ||
| "required": ["usedBy", "usedAt"], | ||
| "properties": { | ||
| "usedBy": {"type": "string", "format": "did"}, | ||
| "usedAt": {"type": "string", "format": "datetime"} | ||
| } | ||
| } | ||
| } | ||
| } |
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,46 @@ | ||
| { | ||
| "lexicon": 1, | ||
| "id": "com.atproto.server.getAccountInviteCodes", | ||
| "defs": { | ||
| "main": { | ||
| "type": "query", | ||
| "description": "Get all invite codes for a given account", | ||
| "parameters": { | ||
| "type": "params", | ||
| "properties": { | ||
| "includeUsed": { "type": "boolean", "default": true }, | ||
| "createAvailable": { "type": "boolean", "default": true } | ||
| } | ||
| }, | ||
| "output": { | ||
| "encoding": "application/json", | ||
| "schema": { | ||
| "type": "object", | ||
| "required": ["codes"], | ||
| "properties": { | ||
| "codes": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "ref", | ||
| "ref": "#invite" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "errors": [ | ||
| {"name": "DuplicateCreate"} | ||
| ] | ||
| }, | ||
| "invite": { | ||
| "type": "object", | ||
| "required": ["code", "available", "uses", "disabled"], | ||
| "properties": { | ||
| "code": { "type": "string" }, | ||
| "available": { "type": "integer" }, | ||
| "uses": { "type": "integer" }, | ||
| "disabled": { "type": "boolean" } | ||
| } | ||
| } | ||
| } | ||
| } |
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
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 might be useful to add timespan parameters to this query, if that's not too difficult. Then in the dashboard we could give (last week, last month, all time) on these stats