technology.agave.marketplace.putUses

catalogue.agave.technology

Documentation

Replace one instance's use counts with the ones given. Authenticated with a service token of any of the instance's members (aud: the marketplace's DID, lxm: this method); the marketplace keeps the counts under the instance id and never the member.

main procedure

Replace one instance's use counts with the ones given. Authenticated with a service token of any of the instance's members (aud: the marketplace's DID, lxm: this method); the marketplace keeps the counts under the instance id and never the member.

Input

Encodingapplication/json
instance string Required

An opaque id the instance draws once from at least 16 random bytes and keeps: letters, digits, dash and underscore. A report replaces the previous one under the same id.

maxLength: 64 bytesminLength: 16 bytes
uses array Required

No description available.

maxLength: 1000 items

Output

Encodingapplication/json
accepted integer Required

How many entries name a slug the marketplace indexed; the others are dropped.

Errors

AuthenticationRequired The call carries no service token.
InvalidToken The token is expired, not signed by the key its issuer's DID document names, or not addressed to the marketplace and this method.
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 
{
  "description": "Replace one instance's use counts with the ones given. Authenticated with a service token of any of the instance's members (aud: the marketplace's DID, lxm: this method); the marketplace keeps the counts under the instance id and never the member.",
  "errors": [
    {
      "description": "The call carries no service token.",
      "name": "AuthenticationRequired"
    },
    {
      "description": "The token is expired, not signed by the key its issuer's DID document names, or not addressed to the marketplace and this method.",
      "name": "InvalidToken"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "instance": {
          "description": "An opaque id the instance draws once from at least 16 random bytes and keeps: letters, digits, dash and underscore. A report replaces the previous one under the same id.",
          "maxLength": 64,
          "minLength": 16,
          "type": "string"
        },
        "uses": {
          "items": {
            "ref": "#use",
            "type": "ref"
          },
          "maxLength": 1000,
          "type": "array"
        }
      },
      "required": [
        "instance",
        "uses"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "accepted": {
          "description": "How many entries name a slug the marketplace indexed; the others are dropped.",
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "accepted"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}
use object

No description available.

Properties

author string did Required

A decentralized identifier (DID).

count integer Required

Copies of the slug, any version, across the instance's fleets.

minimum: 1maximum: 10000
slug string Required

No description available.

maxLength: 40 bytes
View raw schema 
{
  "properties": {
    "author": {
      "format": "did",
      "type": "string"
    },
    "count": {
      "description": "Copies of the slug, any version, across the instance's fleets.",
      "maximum": 10000,
      "minimum": 1,
      "type": "integer"
    },
    "slug": {
      "maxLength": 40,
      "type": "string"
    }
  },
  "required": [
    "author",
    "slug",
    "count"
  ],
  "type": "object"
}

Lexicon Garden

@