social.nstar.provider.declaration

nstar.social

Documentation

A declaration of an Atmosphere service provider.

main record

A declaration of an Atmosphere service provider.

Record Key tid Timestamp-based ID

Properties

contact ref #contact Required

Provider's contact information

description string Required

Description of the services distinguish and are offered by provider.

maxLength: 256 bytesmaxGraphemes: 2560 graphemes
did string uri Required

Provider's DID document containing 1 or more of following services: #atproto_pds, #appview_bsky, #appview_notif

displayName string Required

Abbreviated name for displaying in limited UI space presentations (e.g. button label).

maxLength: 15 bytesmaxGraphemes: 150 graphemes
legalName string Required

Provider's full legal name

maxLength: 64 bytesmaxGraphemes: 640 graphemes
theme ref #theme Required

URLs of the providers website and service policy documents.

View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "did",
      "legalName",
      "displayName",
      "description",
      "services",
      "theme",
      "links",
      "contact"
    ],
    "properties": {
      "did": {
        "type": "string",
        "format": "uri",
        "description": "Provider's DID document containing 1 or more of following services: #atproto_pds, #appview_bsky, #appview_notif"
      },
      "links": {
        "ref": "#links",
        "type": "ref",
        "description": "URLs of the providers website and service policy documents."
      },
      "theme": {
        "ref": "#theme",
        "type": "ref",
        "description": "URLs of the providers website and service policy documents."
      },
      "contact": {
        "ref": "#contact",
        "type": "ref",
        "description": "Provider's contact information"
      },
      "services": {
        "type": "array",
        "items": {
          "ref": "lex:social.nstar.actor.declaration#service",
          "type": "ref"
        },
        "maxLength": 100,
        "minLength": 1,
        "description": "The services offered by the provider as listed in the provider's DID document."
      },
      "legalName": {
        "type": "string",
        "maxLength": 64,
        "description": "Provider's full legal name",
        "maxGraphemes": 640
      },
      "description": {
        "type": "string",
        "maxLength": 256,
        "description": "Description of the services distinguish and are offered by provider.",
        "maxGraphemes": 2560
      },
      "displayName": {
        "type": "string",
        "maxLength": 15,
        "description": "Abbreviated name for displaying in limited UI space presentations (e.g. button label).",
        "maxGraphemes": 150
      }
    }
  },
  "description": "A declaration of an Atmosphere service provider."
}
contact object

No description available.

Properties

email string Required

Provider's support email address.

phone string Optional

Provider's support phone number.

View raw schema 
{
  "type": "object",
  "required": [
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "description": "Provider's support email address."
    },
    "phone": {
      "type": "string",
      "description": "Provider's support phone number."
    }
  }
}
links object

No description available.

Properties

privacyPolicy string uri Required

Link reference to the provider's privacy policy.

termsOfService string uri Required

Link reference to the provider's terms of service.

website string uri Required

Provider's website reference.

View raw schema 
{
  "type": "object",
  "required": [
    "website",
    "privacyPolicy",
    "termsOfService"
  ],
  "properties": {
    "website": {
      "type": "string",
      "format": "uri",
      "description": "Provider's website reference."
    },
    "privacyPolicy": {
      "type": "string",
      "format": "uri",
      "description": "Link reference to the provider's privacy policy."
    },
    "termsOfService": {
      "type": "string",
      "format": "uri",
      "description": "Link reference to the provider's terms of service."
    }
  }
}
service object

No description available.

Properties

id string Required

A service identifier (eg atproto_pds, bsky_appview, bsky_notif, plc_dir)

maxLength: 64 bytesmaxGraphemes: 640 graphemes
uri string uri Required

Service identifier's URI

View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "uri"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 64,
      "description": "A service identifier (eg atproto_pds, bsky_appview, bsky_notif, plc_dir)",
      "maxGraphemes": 640
    },
    "uri": {
      "type": "string",
      "format": "uri",
      "description": "Service identifier's URI"
    }
  }
}
theme object

No description available.

Properties

colorDark string Optional

HEX color code to use in dark mode presentations. Optional.

maxLength: 7 bytesmaxGraphemes: 70 graphemes
colorLight string Optional

HEX color code to use in light mode presentations. Optional.

maxLength: 7 bytesmaxGraphemes: 70 graphemes
logoPNG string Optional

Providers branded logo in PNG format (base64 encoded). Optional.

maxLength: 4096 bytesmaxGraphemes: 40960 graphemes
logoSVG string Optional

Providers branded template logo in SVG format. Optional.

maxLength: 4096 bytesmaxGraphemes: 40960 graphemes
View raw schema 
{
  "type": "object",
  "properties": {
    "logoPNG": {
      "type": "string",
      "maxLength": 4096,
      "description": "Providers branded logo in PNG format (base64 encoded). Optional.",
      "maxGraphemes": 40960
    },
    "logoSVG": {
      "type": "string",
      "maxLength": 4096,
      "description": "Providers branded template logo in SVG format. Optional.",
      "maxGraphemes": 40960
    },
    "colorDark": {
      "type": "string",
      "maxLength": 7,
      "description": "HEX color code to use in dark mode presentations. Optional.",
      "maxGraphemes": 70
    },
    "colorLight": {
      "type": "string",
      "maxLength": 7,
      "description": "HEX color code to use in light mode presentations. Optional.",
      "maxGraphemes": 70
    }
  }
}

Lexicon Garden

@