lol.mlf.package

mlf.lol

Documentation

main record

No description available.

Record Key tid Timestamp-based ID

Properties

published array of ref #PublishedItem Required

Every lexicon record the publish wrote to the PDS in this event, sorted lexicographically by NSID.

publishedAt string datetime Required

ISO 8601 timestamp of when the publish completed.

resolvedDependencies array of ref #ResolvedDependency Optional

Every external lexicon the workspace resolved against at publish time, pinned to the remote CID observed during the publish. Empty list when the package has no external dependencies.

tool string Required

Version string of the MLF tool that produced the publish (e.g. `"mlf@0.1.0"`).

View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "publishedAt",
      "tool",
      "published"
    ],
    "properties": {
      "tool": {
        "type": "string",
        "description": "Version string of the MLF tool that produced the publish\n(e.g. `\"mlf@0.1.0\"`)."
      },
      "published": {
        "type": "array",
        "items": {
          "ref": "#PublishedItem",
          "type": "ref"
        },
        "description": "Every lexicon record the publish wrote to the PDS in this event,\nsorted lexicographically by NSID."
      },
      "publishedAt": {
        "type": "string",
        "format": "datetime",
        "description": "ISO 8601 timestamp of when the publish completed."
      },
      "resolvedDependencies": {
        "type": "array",
        "items": {
          "ref": "#ResolvedDependency",
          "type": "ref"
        },
        "description": "Every external lexicon the workspace resolved against at publish\ntime, pinned to the remote CID observed during the publish.\nEmpty list when the package has no external dependencies."
      }
    }
  }
}
PublishedItem object

One lexicon record included in a publish.

Properties

cid string cid Required

CID of the record as stored on the PDS.

nsid string nsid Required

NSID of the published lexicon.

View raw schema 
{
  "type": "object",
  "required": [
    "nsid",
    "cid"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid",
      "description": "CID of the record as stored on the PDS."
    },
    "nsid": {
      "type": "string",
      "format": "nsid",
      "description": "NSID of the published lexicon."
    }
  },
  "description": "One lexicon record included in a publish."
}
ResolvedDependency object

One external dependency pinned at publish time.

Properties

cid string cid Required

CID of the record at the moment of the publish.

nsid string nsid Required

NSID of the external lexicon the package linked against.

View raw schema 
{
  "type": "object",
  "required": [
    "nsid",
    "cid"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid",
      "description": "CID of the record at the moment of the publish."
    },
    "nsid": {
      "type": "string",
      "format": "nsid",
      "description": "NSID of the external lexicon the package linked against."
    }
  },
  "description": "One external dependency pinned at publish time."
}

Lexicon Garden

@