Plugin Version
0.6.0
Proposed functionality
Every Custom Object Type (COT) should provide an optional metadata field that can store arbitrary structured additional information.
The metadata field belongs to the Custom Object Type itself—not to the individual objects created from that COT. It is intended to store information that describes or extends the COT definition rather than the data of its instances.
The field should serve as a standardized extension point for information that is not part of the Portable Schema itself but should still be stored, exported, and imported together with the COT.
The metadata should:
- be stored as JSON,
- be available through the REST API,
- be included in the Portable Schema,
- be preserved during import and export,
- be persisted and returned by the core plugin without being interpreted.
This provides a well-defined location for implementations to store additional information without extending the Portable Schema or introducing custom top-level attributes.
Use case
Many implementations require additional information to describe a Custom Object Type that is outside the scope of the Portable Schema.
Examples include:
- UI hints
- Documentation references
- Integration settings
- Implementation-specific configuration
Today, this information must either be managed outside the Portable Schema or added through custom schema extensions.
A standardized metadata field provides a well-defined extension point, improves schema portability, and enables different applications to store additional information without affecting the compatibility of the Portable Schema.
External dependencies
None.
Plugin Version
0.6.0
Proposed functionality
Every Custom Object Type (COT) should provide an optional
metadatafield that can store arbitrary structured additional information.The
metadatafield belongs to the Custom Object Type itself—not to the individual objects created from that COT. It is intended to store information that describes or extends the COT definition rather than the data of its instances.The field should serve as a standardized extension point for information that is not part of the Portable Schema itself but should still be stored, exported, and imported together with the COT.
The metadata should:
This provides a well-defined location for implementations to store additional information without extending the Portable Schema or introducing custom top-level attributes.
Use case
Many implementations require additional information to describe a Custom Object Type that is outside the scope of the Portable Schema.
Examples include:
Today, this information must either be managed outside the Portable Schema or added through custom schema extensions.
A standardized
metadatafield provides a well-defined extension point, improves schema portability, and enables different applications to store additional information without affecting the compatibility of the Portable Schema.External dependencies
None.