pub.chive.claiming.requestCoauthorship
Request co-authorship on an existing eprint in another user's PDS
Repository
@lexicons.governance.chive.pub did:plc:egjghlwgts2hlcer2txilxeh
not from the namespace authority
Details · procedure
| Kind | procedure |
|---|---|
| Authority | claiming.chive.pub |
| Indexed |
Checks
Validunlimited-stringdefs.coauthorRequest.properties.authorNameNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.coauthorRequest.properties.claimantNameNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.coauthorRequest.properties.messageNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.coauthorRequest.properties.rejectionReasonNo maxLength, maxGraphemes or format limits this string.unlimited-stringdefs.coauthorRequest.properties.statusNo maxLength, maxGraphemes or format limits this string.
{
"$type": "com.atproto.lexicon.schema",
"defs": {
"coauthorRequest": {
"properties": {
"authorIndex": {
"description": "Index of the author entry being claimed (0-based)",
"type": "integer"
},
"authorName": {
"description": "Name of the author entry being claimed",
"type": "string"
},
"claimantDid": {
"description": "DID of the claimant",
"format": "did",
"type": "string"
},
"claimantName": {
"description": "Display name at time of request",
"type": "string"
},
"createdAt": {
"description": "When the request was created",
"format": "datetime",
"type": "string"
},
"eprintOwnerDid": {
"description": "DID of the PDS owner",
"format": "did",
"type": "string"
},
"eprintUri": {
"description": "AT-URI of the eprint record",
"format": "at-uri",
"type": "string"
},
"id": {
"description": "Request ID",
"type": "integer"
},
"message": {
"description": "Message from claimant",
"type": "string"
},
"rejectionReason": {
"description": "Rejection reason if rejected",
"type": "string"
},
"reviewedAt": {
"description": "When the request was reviewed",
"format": "datetime",
"type": "string"
},
"status": {
"description": "Request status",
"knownValues": [
"pending",
"approved",
"rejected"
],
"type": "string"
}
},
"required": [
"id",
"eprintUri",
"eprintOwnerDid",
"claimantDid",
"claimantName",
"authorIndex",
"authorName",
"status",
"createdAt"
],
"type": "object"
},
"main": {
"description": "Request co-authorship on an existing eprint in another user's PDS",
"errors": [
{
"name": "AuthenticationRequired"
},
{
"name": "NotFound"
},
{
"name": "InvalidRequest"
}
],
"input": {
"encoding": "application/json",
"schema": {
"properties": {
"authorIndex": {
"description": "Index of the author entry being claimed (0-based)",
"minimum": 0,
"type": "integer"
},
"authorName": {
"description": "Name of the author entry being claimed",
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"claimantName": {
"description": "Display name for the request",
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"eprintOwnerDid": {
"description": "DID of the PDS owner",
"format": "did",
"type": "string"
},
"eprintUri": {
"description": "AT-URI of the eprint record",
"format": "at-uri",
"type": "string"
},
"message": {
"description": "Optional message to PDS owner",
"maxLength": 1000,
"type": "string"
}
},
"required": [
"eprintUri",
"eprintOwnerDid",
"claimantName",
"authorIndex",
"authorName"
],
"type": "object"
}
},
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"request": {
"ref": "#coauthorRequest",
"type": "ref"
}
},
"required": [
"request"
],
"type": "object"
}
},
"type": "procedure"
}
},
"id": "pub.chive.claiming.requestCoauthorship",
"lexicon": 1,
"revision": 1
}