Home

Directory

This is a type used in Stencila Schema for directories in a file system.

It exists to represent directories as lightweight filesystem entities that can be inspected, listed, and linked from workflows and documents. Unlike more metadata-rich work types, it extends Entity rather than Collection to avoid carrying unnecessary creative-work overhead when working with large directory listings.

Key properties focus on filesystem identity and structure rather than publishable content.

Properties

The Directory type has these properties:

NameDescriptionTypeInherited from
nameThe name of the directory.String-
pathThe path (absolute or relative) of the file on the file system.String-
partsThe files and other directories within this directory.(File | Directory)*-
idThe identifier for this item.StringEntity

Related

The Directory type is related to these types:

Bindings

The Directory type is represented in:


This documentation was generated from Directory.yaml by docs_types.rs.

© 2026 Stencila