0504 Implementation Snippets¶

Developers can be aided in their work by having snippets of schema implementation that follow approved structures and naming conventions that they can include in their APIs and data structures.

ImplementationSnippet entity¶

The ImplementationSnippet entity is for the storage of an implementation snippet, along with details of its language and version. It inherits from Referenceable which means it can have a link to an external reference which could be, say, a physical schema implementation in a source code repository).

The additional attributes of an implementation snippet are:

• snippet - the implementation code.
• implementationLanguage - the programming/encoding language used for the snippet. For example, JSON, XML, Java, ...
• versionIdentifier - identifier for this version of the data field that this snippet represents.
• usage - how should this snippet be used.

AssociatedSnippet relationship¶

The AssociatedSnippet relationship links a Referenceable entity such as a SchemaType or data class to an implementation snippet to guide developers or code generators on how to implement the schema type.

SchemaTypeImplementation relationship¶

This relationship links a concrete implementation to a schema type. This is for identifying the code for managing data values that are derived (calculated).

Raise an issue or comment below