DocumentationAPI reference

Rust · 0.1.0

LinkMetadata

Application protocol schema. Field names and inherited descriptions are kept in their original language.

Where this schema is used

These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.

Referenced by these component schemas:

Shape and fields

object

FieldType / requirementDescription
urlstringThe original link URL.
titlestringThe link title.
descriptionstringThe link description.
imagestringThe link image URL.

Complete schema

Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "The original link URL."
    },
    "title": {
      "type": "string",
      "description": "The link title."
    },
    "description": {
      "type": "string",
      "description": "The link description."
    },
    "image": {
      "type": "string",
      "description": "The link image URL."
    }
  }
}