profileSchema

type: object

a person's profile on a website

Examples

{
  "site": {
    "name": "Personal"
  },
  "url": "https://dhruvkb.dev"
}

{
  "site": {
    "id": "bluesky",
    "name": "Bluesky"
  },
  "username": "dhruvkb.dev",
  "url": "https://bsky.app/profile/dhruvkb.dev"
}

site

type: object

the website on which the profile is located

id

type: string
optional? yes

a slug for the site; In implementations, this can be used as a key to find the icon for the site.

name

type: string

the readable name of the site, as it should be displayed to users; This should follow the site's preferred punctuation and capitalization.

username

type: string
optional? yes

the username or handle of the person on the website

url

type: union

the URL to the profile of the person on the website

url/0

type: string
kind: URL

the URL endpoint; This form should be used when a label is not provided.

url/1

type: object

a combination of the URL endpoint and a label for a11y purposes; This form should be used when a label is provided.

dest

type: string
kind: URL

the URL endpoint

label

type: string

a label for the URL; This makes the URL accessible and provides more info about the destination.