ActorSkillListing actor.skill-listing@1
Generated at from
openvibe-contracts v0.419.0 and
openvibe-sdk v0.161.0.
actor.skill-listing@2.- Version
- 1.0.0
- Owner
- actor
- Visibility
- public
- Status
- active
- Compatibility
- backward
- Decision
- ADR-058
- Schema
https://openvibe.network/contracts/actor/skill-listing.v1.json
actor.skill-listing@1: a skill in the registry, the record every site shows on its card (ADR-058). It carries the document as published (actor.skill@1), the PUBLISHER from the registry's own record (vouched: unlike the document's author, this is who published it), the SCAN (its state and findings travel with the listing), and the CURATOR's state. Install rules every site keeps: a passed skill installs in one tap; a flagged one only after the person reads the findings and confirms; a failed one never; a stale or archived one is not offered. Installing copies the document into the person's agent; it grants nothing (the skill's requires is a declaration).
Fields
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
listing | const | yes |
| |
id | string | yes | The listing's id. |
|
skill | actor.skill@1 | yes | The document as published. | |
publisher | object | yes | Who published it, from the registry's own record. |
|
publisher.kind | enum | yes | OpenVibe's own skills, or a person's. |
|
publisher.subject | string | The person who published it (kind person). |
| |
publisher.name | string |
| ||
scan | object | yes | What the registry's scan found. It travels with the listing. |
|
scan.state | enum | yes |
| |
scan.scanner | string | The scanner and its version. |
| |
scan.scanned_at | string |
| ||
scan.findings | array of object |
| ||
scan.findings[].rule | string | yes | Which rule, such as asks.undeclared_kind or text.secret_request. |
|
scan.findings[].severity | enum | yes |
| |
scan.findings[].where | string | instructions, description, or a resource path. |
| |
scan.findings[].note | string | yes | What it found, in plain words. |
|
curator | object | yes | The curator ships with the catalogue: what is used stays, what is not goes stale. |
|
curator.state | enum | yes |
| |
curator.last_used_at | string |
| ||
curator.near_duplicate_of | string | A listing that does the same job. |
| |
installs | integer |
| ||
listed_at | string | yes |
| |
retired_at | string |
|
Examples
From the contract's own test fixtures: valid ones validate, rejected ones must fail.
The fixtures that ship with the package are the current major's.
Validate
const contracts = require('openvibe-contracts');
contracts.validate('actor.skill-listing@1', value); // { valid, errors: [{ path, message }] }