nyc.noirot.cad.source

franknoirot.co

Documentation

Source file content or content references for a CAD project or release.

main record

Source file content or content references for a CAD project or release.

Record Key any Any valid record key

Properties

cid string cid Optional

CID for this source file, if content-addressed.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

externalUri string uri Optional

External content URL, such as a Zoo project file or archive download URL.

format string Optional

CAD source or artifact format.

maxLength: 128 bytes
Known values: kcl, solidworks-part, solidworks-assembly, step, stl, parasolid, obj, gltf, archive, unknown
lineCount integer Optional

Line count for text-native source files.

minimum: 0
mimeType string Optional

No description available.

maxLength: 256 bytes
path string Required

Path within the project archive or source tree.

maxLength: 2048 bytes
role string Optional

Role this source file plays in the project.

maxLength: 64 bytes
Known values: entrypoint, source, import, asset, library, derived
sha256 string Required

Lowercase hex SHA-256 digest of the source file bytes.

maxLength: 64 bytesminLength: 64 bytes
sizeBytes integer Optional

Size of this source file in bytes.

minimum: 0
sourceBlob blob Optional

Blob reference for source bytes, especially large text files and binary CAD artifacts.

maxSize: 10.0 MB
sourceText string Optional

Inline UTF-8 source text for compact text-native CAD files such as KCL.

maxLength: 200000 bytes
textEncoding string Optional

Text encoding for sourceText, when present.

maxLength: 64 bytes
Known values: utf-8
updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

View raw schema
{
  "key": "any",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "subject",
      "path",
      "sha256",
      "createdAt"
    ],
    "properties": {
      "cid": {
        "type": "string",
        "format": "cid",
        "description": "CID for this source file, if content-addressed."
      },
      "path": {
        "type": "string",
        "maxLength": 2048,
        "description": "Path within the project archive or source tree."
      },
      "role": {
        "type": "string",
        "maxLength": 64,
        "description": "Role this source file plays in the project.",
        "knownValues": [
          "entrypoint",
          "source",
          "import",
          "asset",
          "library",
          "derived"
        ]
      },
      "format": {
        "type": "string",
        "maxLength": 128,
        "description": "CAD source or artifact format.",
        "knownValues": [
          "kcl",
          "solidworks-part",
          "solidworks-assembly",
          "step",
          "stl",
          "parasolid",
          "obj",
          "gltf",
          "archive",
          "unknown"
        ]
      },
      "sha256": {
        "type": "string",
        "maxLength": 64,
        "minLength": 64,
        "description": "Lowercase hex SHA-256 digest of the source file bytes."
      },
      "subject": {
        "ref": "nyc.noirot.cad.defs#projectRef",
        "type": "ref",
        "description": "Project or release record this source file belongs to."
      },
      "mimeType": {
        "type": "string",
        "maxLength": 256
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "lineCount": {
        "type": "integer",
        "minimum": 0,
        "description": "Line count for text-native source files."
      },
      "sizeBytes": {
        "type": "integer",
        "minimum": 0,
        "description": "Size of this source file in bytes."
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime"
      },
      "sourceBlob": {
        "type": "blob",
        "accept": [
          "text/*",
          "model/*",
          "application/octet-stream",
          "application/zip"
        ],
        "maxSize": 10000000,
        "description": "Blob reference for source bytes, especially large text files and binary CAD artifacts."
      },
      "sourceText": {
        "type": "string",
        "maxLength": 200000,
        "description": "Inline UTF-8 source text for compact text-native CAD files such as KCL."
      },
      "externalUri": {
        "type": "string",
        "format": "uri",
        "description": "External content URL, such as a Zoo project file or archive download URL."
      },
      "textEncoding": {
        "type": "string",
        "maxLength": 64,
        "description": "Text encoding for sourceText, when present.",
        "knownValues": [
          "utf-8"
        ]
      }
    }
  },
  "description": "Source file content or content references for a CAD project or release."
}

Lexicon Garden

@