at.happyproto.plugin.profile

happyproto.at

Documentation

A HappyView plugin package, in its publisher's repo. The record key is the package slug, so the slug is immutable: changing it means a different package.

main record

A HappyView plugin package, in its publisher's repo. The record key is the package slug, so the slug is immutable: changing it means a different package.

Record Key any Any valid record key

Properties

authors array of ref #author Required

No description available.

minLength: 1 items
description string Optional

One line, 140 graphemes or fewer recommended.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
keywords array of string Optional

Five or fewer recommended.

maxLength: 20 items
lastUpdated string datetime Optional

An RFC 3339 formatted timestamp.

license string Required

An SPDX expression, or the literal 'proprietary'.

maxLength: 256 bytes
name string Optional

Display name. The slug is used when absent.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
sections ref #sections Optional

No description available.

security array of ref #contact Required

Where to report a vulnerability. At least one, because a plugin runs as native code in an operator's process.

minLength: 1 items
type string Required

Names the ecosystem. A client that does not understand the value refuses the package rather than guessing.

View raw schema 
{
  "description": "A HappyView plugin package, in its publisher's repo. The record key is the package slug, so the slug is immutable: changing it means a different package.",
  "key": "any",
  "record": {
    "properties": {
      "authors": {
        "items": {
          "ref": "#author",
          "type": "ref"
        },
        "minLength": 1,
        "type": "array"
      },
      "description": {
        "description": "One line, 140 graphemes or fewer recommended.",
        "maxGraphemes": 300,
        "maxLength": 3000,
        "type": "string"
      },
      "keywords": {
        "description": "Five or fewer recommended.",
        "items": {
          "maxGraphemes": 32,
          "maxLength": 320,
          "type": "string"
        },
        "maxLength": 20,
        "type": "array"
      },
      "lastUpdated": {
        "format": "datetime",
        "type": "string"
      },
      "license": {
        "description": "An SPDX expression, or the literal 'proprietary'.",
        "maxLength": 256,
        "type": "string"
      },
      "name": {
        "description": "Display name. The slug is used when absent.",
        "maxGraphemes": 64,
        "maxLength": 640,
        "type": "string"
      },
      "sections": {
        "ref": "#sections",
        "type": "ref"
      },
      "security": {
        "description": "Where to report a vulnerability. At least one, because a plugin runs as native code in an operator's process.",
        "items": {
          "ref": "#contact",
          "type": "ref"
        },
        "minLength": 1,
        "type": "array"
      },
      "type": {
        "const": "happyview-plugin",
        "description": "Names the ecosystem. A client that does not understand the value refuses the package rather than guessing.",
        "type": "string"
      }
    },
    "required": [
      "type",
      "license",
      "authors",
      "security"
    ],
    "type": "object"
  },
  "type": "record"
}
author object

No description available.

Properties

email string Optional

No description available.

maxLength: 320 bytes
name string Required

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
url string uri Optional

A valid URI.

View raw schema 
{
  "properties": {
    "email": {
      "maxLength": 320,
      "type": "string"
    },
    "name": {
      "maxGraphemes": 64,
      "maxLength": 640,
      "type": "string"
    },
    "url": {
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}
contact object

A security contact. Either field satisfies it, but an entry with neither says nothing.

Properties

email string Optional

No description available.

maxLength: 320 bytes
url string uri Optional

A valid URI.

View raw schema 
{
  "description": "A security contact. Either field satisfies it, but an entry with neither says nothing.",
  "properties": {
    "email": {
      "maxLength": 320,
      "type": "string"
    },
    "url": {
      "format": "uri",
      "type": "string"
    }
  },
  "type": "object"
}
sections object

Long-form CommonMark, rendered as untrusted input with raw HTML stripped.

Properties

changelog string Optional

No description available.

maxLength: 20000 bytesmaxGraphemes: 2000 graphemes
description string Optional

No description available.

maxLength: 20000 bytesmaxGraphemes: 2000 graphemes
installation string Optional

No description available.

maxLength: 20000 bytesmaxGraphemes: 2000 graphemes
security string Optional

No description available.

maxLength: 20000 bytesmaxGraphemes: 2000 graphemes
View raw schema 
{
  "description": "Long-form CommonMark, rendered as untrusted input with raw HTML stripped.",
  "properties": {
    "changelog": {
      "maxGraphemes": 2000,
      "maxLength": 20000,
      "type": "string"
    },
    "description": {
      "maxGraphemes": 2000,
      "maxLength": 20000,
      "type": "string"
    },
    "installation": {
      "maxGraphemes": 2000,
      "maxLength": 20000,
      "type": "string"
    },
    "security": {
      "maxGraphemes": 2000,
      "maxLength": 20000,
      "type": "string"
    }
  },
  "type": "object"
}

Lexicon Garden

@