pub.chive.endorsement.getUserEndorsement

chive.pub

Documentation

Get a user's endorsement for a specific eprint

main query

Get a user's endorsement for a specific eprint

Parameters

eprintUri string at-uri Required

AT-URI of the eprint

userDid string did Required

DID of the user

Output

Encodingapplication/json

Schema#endorsementView

Errors

NotFound

Try It

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

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

eprintUri * AT-URI of the eprint

userDid * DID of the user

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "NotFound"
    }
  ],
  "output": {
    "schema": {
      "ref": "#endorsementView",
      "type": "ref"
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "eprintUri",
      "userDid"
    ],
    "properties": {
      "userDid": {
        "type": "string",
        "format": "did",
        "description": "DID of the user"
      },
      "eprintUri": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the eprint"
      }
    }
  },
  "description": "Get a user's endorsement for a specific eprint"
}

authorRef object

No description available.

Properties

avatar string uri Optional

A valid URI.

did string did Required

A decentralized identifier (DID).

displayName string Optional

No description available.

handle string Optional

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    },
    "avatar": {
      "type": "string",
      "format": "uri"
    },
    "handle": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    }
  }
}

endorsementView object

View of an endorsement

Properties

cid string Required

Content identifier

comment string Optional

Optional comment

maxLength: 1000 bytes

contributions array of string Required

Contribution types being endorsed

minLength: 1 items

createdAt string datetime Required

Creation timestamp

endorser ref #authorRef Required

No description available.

eprintUri string at-uri Required

Endorsed eprint AT-URI

updatedAt string datetime Optional

Last update timestamp

uri string at-uri Required

Endorsement AT-URI

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "cid",
    "eprintUri",
    "endorser",
    "contributions",
    "createdAt"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "description": "Content identifier"
    },
    "uri": {
      "type": "string",
      "format": "at-uri",
      "description": "Endorsement AT-URI"
    },
    "comment": {
      "type": "string",
      "maxLength": 1000,
      "description": "Optional comment"
    },
    "endorser": {
      "ref": "#authorRef",
      "type": "ref"
    },
    "createdAt": {
      "type": "string",
      "format": "datetime",
      "description": "Creation timestamp"
    },
    "eprintUri": {
      "type": "string",
      "format": "at-uri",
      "description": "Endorsed eprint AT-URI"
    },
    "updatedAt": {
      "type": "string",
      "format": "datetime",
      "description": "Last update timestamp"
    },
    "contributions": {
      "type": "array",
      "items": {
        "type": "string",
        "knownValues": [
          "methodological",
          "analytical",
          "theoretical",
          "empirical",
          "conceptual",
          "technical",
          "data",
          "replication",
          "reproducibility",
          "synthesis",
          "interdisciplinary",
          "pedagogical",
          "visualization",
          "societal-impact",
          "clinical"
        ]
      },
      "minLength": 1,
      "description": "Contribution types being endorsed"
    }
  },
  "description": "View of an endorsement"
}