ReadmeTemplate.md

The purpose of this document is to provide a template to consistently describe all Open Integration Hub Master Data Models.

For a template conform example please look at the Master Data Model Addresses.

---

Table of Contents

• Introduction
• Basic Ideas
  • Basic Idea 1
  • Basic Idea 2
• Considered Standards
  • Standard 1
  • Standard 2
• Operations
• Content
  • UML Diagram
  • JSON Schema
  • Description Table
• Additional Content

Introduction

In the following the master data model for the domain {your domain} is explained in detail. As for every Open Integration Hub Master Data Model, an UML class diagram, a JSON schema as well as a descrption table exists.

Basic Ideas

Please describe the basic logic and ideas of the Master Data Model

Basic Idea 1

...

Basic Idea 2

...

Considered Standards

Please describe all other standards that were created during the creation process

Standard 1

...

Standard 2

...

Operations

Which functionalities can be performed on the model? Standard: CRUD

Content

UML Diagram

Please provide the UML class diagram of the model.

JSON Schema

Please provide link(s) to the JSON schemas of the model.

Description Table

Please provide a link to the description table of the model.

Additional Content

If existing, please provide additional content.