pub.chive.actor.profileConfig

lexicons.governance.chive.pub View official

Documentation

How an author's profile page is arranged: which sections appear, in what order, and which collection is featured. Written by the account holder to their own repository.

main record

How an author's profile page is arranged: which sections appear, in what order, and which collection is featured. Written by the account holder to their own repository.

Record Key literal:self Fixed literal value

Properties

createdAt string datetime Required

When this configuration was first created.

featuredCollectionUri string at-uri Optional

Collection node pinned to the top of the profile.

profileType string Optional

Broad kind of profile, used to pick sensible default sections. Open-ended: an unknown value is preserved and falls back to the default layout.

maxLength: 64 bytes
Known values: researcher, group, institution, project
sections array of ref #section Optional

Ordered display sections. Order in this array is the display order.

maxLength: 32 items
updatedAt string datetime Optional

When this configuration was last changed.

View raw schema 
{
  "key": "literal:self",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "createdAt"
    ],
    "properties": {
      "sections": {
        "type": "array",
        "items": {
          "ref": "#section",
          "type": "ref"
        },
        "maxLength": 32,
        "description": "Ordered display sections. Order in this array is the display order."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "When this configuration was first created."
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime",
        "description": "When this configuration was last changed."
      },
      "profileType": {
        "type": "string",
        "maxLength": 64,
        "description": "Broad kind of profile, used to pick sensible default sections. Open-ended: an unknown value is preserved and falls back to the default layout.",
        "knownValues": [
          "researcher",
          "group",
          "institution",
          "project"
        ]
      },
      "featuredCollectionUri": {
        "type": "string",
        "format": "at-uri",
        "description": "Collection node pinned to the top of the profile."
      }
    }
  },
  "description": "How an author's profile page is arranged: which sections appear, in what order, and which collection is featured. Written by the account holder to their own repository."
}
section object

One section of the profile layout.

Properties

collectionUri string at-uri Optional

Collection this section draws from, where the kind supports it.

kind string Required

What the section shows. Open-ended so a section type can be added without invalidating existing records.

maxLength: 64 bytes
Known values: eprints, collections, reviews, endorsements, fields, affiliations, collaborators
label string Optional

Heading shown for the section. Defaults to a label derived from `kind` when absent.

maxLength: 128 bytes
limit integer Optional

Maximum items to display in this section.

minimum: 1maximum: 100
visible boolean Optional

Whether the section is rendered. A hidden section keeps its configuration.

View raw schema 
{
  "type": "object",
  "required": [
    "kind"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "maxLength": 64,
      "description": "What the section shows. Open-ended so a section type can be added without invalidating existing records.",
      "knownValues": [
        "eprints",
        "collections",
        "reviews",
        "endorsements",
        "fields",
        "affiliations",
        "collaborators"
      ]
    },
    "label": {
      "type": "string",
      "maxLength": 128,
      "description": "Heading shown for the section. Defaults to a label derived from `kind` when absent."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Maximum items to display in this section."
    },
    "visible": {
      "type": "boolean",
      "default": true,
      "description": "Whether the section is rendered. A hidden section keeps its configuration."
    },
    "collectionUri": {
      "type": "string",
      "format": "at-uri",
      "description": "Collection this section draws from, where the kind supports it."
    }
  },
  "description": "One section of the profile layout."
}

Lexicon Garden

@