TR254 Dynamic API Technical Recommendation R15.5.1
- Maturity level: Level 4 - Forum Approved
Created By: API Project
This initial technical recommendation looks specifically at the topic of metadata. Future versions will introduce the additional topics of policy and behavior in support of dynamic APIs.
The proposal introduces an approach for defining a dynamic interface that supports returning a definition for a particular entity as well as rules on how to interpret, validate and manage that entity. Which entities this approach is applied to is up to the implementer, but certain SID entities will benefit more than others.
This document aims at introducing a pattern by which the principles of the SID can be used to facilitate a physical implementation (by way of an API). The examples shown employ the use of external schemas (such as JSON schema) to define data primitives; however, more work is needed in order to extend the design pattern to include more complex data types. This is planned to be addressed in a future contribution.