Craft Daily Notes icon

Craft Daily Notes

Interact with Craft Daily Notes API - manage blocks, tasks, collections, and search

Actions17

Collection → Get Schema

AI-generated

Summary

Retrieve the schema of a specified collection from Craft Daily Notes in either JSON Schema format for validating items or as a schema structure detailing names, properties, and types.

Inputs

  • Collection Name or ID (required) — Select a collection from your daily notes by choosing from the list or specifying its ID with an expression.
  • Schema Format — Choose the format of the schema response: either JSON Schema (for validation) or the schema structure (name, properties, types).

Output shape

a JSON object representing the collection schema as either JSON Schema for validation or as structured schema details

The returned data is a schema describing the collection's items, formatted based on the selected 'Schema Format'. Errors may occur if the collection ID is invalid.

Examples

Example 1: Get JSON Schema for a collection

Select the collection by name or ID, choose 'JSON Schema (for Validation)' as format, then execute to receive a JSON Schema defining valid items.

Example 2: Get schema structure of a collection

Select the collection and choose 'Schema Structure' to receive detailed information about the collection's fields and their data types.

Links

Discussion