Use annotations to add descriptions to types and links:

Copy
type Label {
    annotation description :=
        'Special label to stick on reviews';
    required property comments -> str;
    link review -> Review {
        annotation description :=
            'This review needs some attention';
    };
}

Retrieving the annotations can be done via an introspection query:

Copy
db> 
... 
... 
... 
... 
... 
... 
WITH MODULE schema
SELECT ObjectType {
    name,
    annotations: {name, @value},
    links: {name, annotations: {name, @value}}
}
FILTER .name = 'default::Label';
{
    Object {
        name: 'default::Label',
        annotations: {
            Object {
                name: 'std::description',
                @value: 'Special label to stick on reviews'
            }
        },
        links: {
            Object {
                name: 'review',
                annotations: {
                    Object {
                        name: 'std::description',
                        @value: 'Special label to stick on reviews'
                    }
                }
            },
            Object { name: '__type__', annotations: {} }
        }
    }
}

Alternatively, the annotations can be viewed by the following REPL command:

Copy
db> 
\d+ Label
type default::Label {
    annotation std::description := 'Special label to stick on reviews';
    required single link __type__ -> schema::Type {
        readonly := true;
    };
    single link review -> default::Review {
        annotation std::description := 'Special label to stick on reviews';
    };
    required single property comments -> std::str;
    required single property id -> std::uuid {
        readonly := true;
        constraint std::exclusive;
    };
};
Light
Dark
System