LogoVersia Protocol Dev

Instance Metadata

Contains metadata about a Versia instance, such as capabilities and endpoints.

Entity Definition

  • Name
    id
    Type
    null
    Description

    This entity does not have an ID.

  • Name
    name
    Required
    Required
    Type
    string
    Description

    Friendly name of the instance, for humans.

  • Name
    software
    Required
    Required
    Type
    Software
    Description

    Information about the software running the instance.

    type Software = {
    name: string;
    version: string;
}
    • name: Name of the software.
    • version: Version of the software. Should use SemVer.
  • Name
    compatibility
    Required
    Required
    Type
    Compatibility
    Description

    Information about the compatibility of the instance.

    type Compatibility = {
    versions: string[];
    extensions: string[];
}
    • versions: Supported Versia Protocol versions.
      • Versions marked as "Working Draft X" are represented as 0.X.
    • extensions: Supported extensions.
  • Name
    description
    Type
    string
    Description

    Long description of the instance, for humans. Should be around 100-200 words.

  • Name
    domain
    Required
    Required
    Type
    Domain
    Description

    Domain of the instance, used for federation.

  • Name
    public_key
    Required
    Required
    Type
    PublicKey
    Description

    Public key of the instance.

    type PublicKey = {
    algorithm: string;
    key: string;
}
    • algorithm: Algorithm used for the public key. Can only be ed25519 for now.
    • key: Instance public key, in SPKI-encoded base64.
  • Name
    banner
    Type
    ContentFormat
    Description

    Banner of the instance. Must be an image format (image/*).

InstanceMetadata

{
    "type": "InstanceMetadata",
    "name": "Jim's Jolly Jimjams",
    "software": {
        "name": "Versia Server",
        "version": "1.2.0-beta.3"
    },
    "compatibility": {
        "versions": [
            "0.3.0",
            "0.4.0",
            "0.5.0"
        ],
        "extensions": [
            "pub.versia:reactions",
            "pub.versia:polls",
            "pub.versia:reports"
        ]
    },
    "description": "Server for Jim's Jolly Jimjams, a social network for fans of Jimjams.",
    "domain": "social.jimjams.com",
    "logo": {
        "image/png": {
            "content": "https://social.jimjams.com/files/logo.png"
        },
        "image/webp": {
            "content": "https://social.jimjams.com/files/logo.webp"
        }
    },
    "public_key": {
        "algorithm": "ed25519",
        "key": "MCowBQYDK2VwAyEA9zhEMtQZetRl4QrLcz99i7jOa6ZVjX7aLfRUsMuKByI="
    },
    "banner": null,
    "created_at": "2021-07-01T00:00:00Z",
    "extensions": {
        "example.extension:monthly_active_users": 1000
    }
}

Collections

The following Collections are available:

These can be fetched using the Federation API