social.craftsky.business.defs

craftsky.social

Documentation

action object

The declaration's primary external action.

Properties

destination string uri Required

External web or email destination selected by the author.

type string Required

Open action type; clients apply behavior only to values they recognize.

maxLength: 64 bytes
Known values: shop, browse-patterns, request-custom-order, book-class, book-appointment, view-event-calendar, email, visit-website, wholesale-enquiries
View raw schema 
{
  "description": "The declaration's primary external action.",
  "properties": {
    "destination": {
      "description": "External web or email destination selected by the author.",
      "format": "uri",
      "type": "string"
    },
    "type": {
      "description": "Open action type; clients apply behavior only to values they recognize.",
      "knownValues": [
        "shop",
        "browse-patterns",
        "request-custom-order",
        "book-class",
        "book-appointment",
        "view-event-calendar",
        "email",
        "visit-website",
        "wholesale-enquiries"
      ],
      "maxLength": 64,
      "type": "string"
    }
  },
  "required": [
    "type",
    "destination"
  ],
  "type": "object"
}
aspectRatio object

Image aspect ratio metadata used for layout hints.

Properties

height integer Required

No description available.

minimum: 1
width integer Required

No description available.

minimum: 1
View raw schema 
{
  "description": "Image aspect ratio metadata used for layout hints.",
  "properties": {
    "height": {
      "minimum": 1,
      "type": "integer"
    },
    "width": {
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "width",
    "height"
  ],
  "type": "object"
}
image object

A business product or event image with optional accessibility and layout metadata.

Properties

alt string Optional

Optional alt text describing the image.

maxLength: 1000 bytesmaxGraphemes: 1000 graphemes
aspectRatio ref #aspectRatio Optional

Optional aspect ratio metadata for rendering.

image blob Required

No description available.

maxSize: 2.0 MB
View raw schema 
{
  "description": "A business product or event image with optional accessibility and layout metadata.",
  "properties": {
    "alt": {
      "description": "Optional alt text describing the image.",
      "maxGraphemes": 1000,
      "maxLength": 1000,
      "type": "string"
    },
    "aspectRatio": {
      "description": "Optional aspect ratio metadata for rendering.",
      "ref": "#aspectRatio",
      "type": "ref"
    },
    "image": {
      "accept": [
        "image/jpeg",
        "image/png",
        "image/webp"
      ],
      "maxSize": 2000000,
      "type": "blob"
    }
  },
  "required": [
    "image"
  ],
  "type": "object"
}
price object

Seller-authored display price amount and ISO 4217 currency code.

Properties

amount string Required

Nonnegative decimal amount interpreted according to the currency minor-unit scale.

maxLength: 17 bytes
currency string Required

Uppercase ISO 4217 alphabetic currency code.

maxLength: 3 bytesminLength: 3 bytes
View raw schema 
{
  "description": "Seller-authored display price amount and ISO 4217 currency code.",
  "properties": {
    "amount": {
      "description": "Nonnegative decimal amount interpreted according to the currency minor-unit scale.",
      "maxLength": 17,
      "type": "string"
    },
    "currency": {
      "description": "Uppercase ISO 4217 alphabetic currency code.",
      "maxLength": 3,
      "minLength": 3,
      "type": "string"
    }
  },
  "required": [
    "amount",
    "currency"
  ],
  "type": "object"
}
product object

An external product card in authored display order.

Properties

image ref #image Optional

Optional product image for interoperable records; Craftsky writes require it.

price ref #price Optional

Optional seller-authored display price.

title string Required

Seller-authored product title.

maxLength: 1500 bytesmaxGraphemes: 150 graphemes
uri string uri Required

External product destination.

View raw schema 
{
  "description": "An external product card in authored display order.",
  "properties": {
    "image": {
      "description": "Optional product image for interoperable records; Craftsky writes require it.",
      "ref": "#image",
      "type": "ref"
    },
    "price": {
      "description": "Optional seller-authored display price.",
      "ref": "#price",
      "type": "ref"
    },
    "title": {
      "description": "Seller-authored product title.",
      "maxGraphemes": 150,
      "maxLength": 1500,
      "type": "string"
    },
    "uri": {
      "description": "External product destination.",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "title",
    "uri"
  ],
  "type": "object"
}

Lexicon Garden

@