pub.chive.claiming.requestCoauthorship

chive.pub

Documentation

Request co-authorship on an existing eprint in another user's PDS

main procedure

Request co-authorship on an existing eprint in another user's PDS

Input

Encodingapplication/json
authorIndex integer Required

Index of the author entry being claimed (0-based)

minimum: 0
authorName string Required

Name of the author entry being claimed

maxLength: 200 bytesminLength: 1 bytes
claimantName string Required

Display name for the request

maxLength: 200 bytesminLength: 1 bytes
eprintOwnerDid stringdid Required

DID of the PDS owner

eprintUri stringat-uri Required

AT-URI of the eprint record

message string Optional

Optional message to PDS owner

maxLength: 1000 bytes

Output

Encodingapplication/json

Errors

AuthenticationRequired
NotFound
InvalidRequest
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "eprintUri",
        "eprintOwnerDid",
        "claimantName",
        "authorIndex",
        "authorName"
      ],
      "properties": {
        "message": {
          "type": "string",
          "maxLength": 1000,
          "description": "Optional message to PDS owner"
        },
        "eprintUri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the eprint record"
        },
        "authorName": {
          "type": "string",
          "maxLength": 200,
          "minLength": 1,
          "description": "Name of the author entry being claimed"
        },
        "authorIndex": {
          "type": "integer",
          "minimum": 0,
          "description": "Index of the author entry being claimed (0-based)"
        },
        "claimantName": {
          "type": "string",
          "maxLength": 200,
          "minLength": 1,
          "description": "Display name for the request"
        },
        "eprintOwnerDid": {
          "type": "string",
          "format": "did",
          "description": "DID of the PDS owner"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "NotFound"
    },
    {
      "name": "InvalidRequest"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "request"
      ],
      "properties": {
        "request": {
          "ref": "#coauthorRequest",
          "type": "ref"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Request co-authorship on an existing eprint in another user's PDS"
}
coauthorRequest object

No description available.

Properties

authorIndex integer Required

Index of the author entry being claimed (0-based)

authorName string Required

Name of the author entry being claimed

claimantDid string did Required

DID of the claimant

claimantName string Required

Display name at time of request

createdAt string datetime Required

When the request was created

eprintOwnerDid string did Required

DID of the PDS owner

eprintUri string at-uri Required

AT-URI of the eprint record

id integer Required

Request ID

message string Optional

Message from claimant

rejectionReason string Optional

Rejection reason if rejected

reviewedAt string datetime Optional

When the request was reviewed

status string Required

Request status

Known values: pending, approved, rejected
View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "eprintUri",
    "eprintOwnerDid",
    "claimantDid",
    "claimantName",
    "authorIndex",
    "authorName",
    "status",
    "createdAt"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "description": "Request ID"
    },
    "status": {
      "type": "string",
      "description": "Request status",
      "knownValues": [
        "pending",
        "approved",
        "rejected"
      ]
    },
    "message": {
      "type": "string",
      "description": "Message from claimant"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the request was created"
    },
    "eprintUri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the eprint record"
    },
    "authorName": {
      "type": "string",
      "description": "Name of the author entry being claimed"
    },
    "reviewedAt": {
      "type": "string",
      "format": "datetime",
      "description": "When the request was reviewed"
    },
    "authorIndex": {
      "type": "integer",
      "description": "Index of the author entry being claimed (0-based)"
    },
    "claimantDid": {
      "type": "string",
      "format": "did",
      "description": "DID of the claimant"
    },
    "claimantName": {
      "type": "string",
      "description": "Display name at time of request"
    },
    "eprintOwnerDid": {
      "type": "string",
      "format": "did",
      "description": "DID of the PDS owner"
    },
    "rejectionReason": {
      "type": "string",
      "description": "Rejection reason if rejected"
    }
  }
}

Lexicon Garden

@