Data Contract

muellimperium-exchange-format

Info

Information about the data contract

Title
Muellimperium Exchange Format
Version
0.0.1
Description
The Muellimperium Exchange Format is a data contract for exchanging data between the Muellimperium and its partners.
Owner
Emperor of the Muellimperium
contract
{'name': 'The Emperor', 'email': '[email protected]'}

Servers

Servers of the data contract

  • Server
    exchange
    Type
    local
    Path
    data.csv
    Format
    csv

Data Model

The logical data model

garbage_collection table
None
location
text
The location where the garbage is collected.
required
garbage_type
text
The type of garbage that is collected.
required
collection_date
date
The date when the garbage is collected.
required

Examples

Examples for models in the data contract

garbage_collection json
None
 
[{'location': 'Musterstadt', 'garbage_type': 'paper', 'collection_date': '2022-01-01'}, {'location': 'Musterstadt', 'garbage_type': 'plastic', 'collection_date': '2022-01-02'}, {'location': 'Musterstadt', 'garbage_type': 'residual_waste', 'collection_date': '2022-01-03'}]
Created at 27 Jun 2024 14:50:12 UTC with Data Contract CLI v0.10.8

Data Contract YAML

dataContractSpecification: 0.9.3
id: muellimperium-exchange-format
info:
  title: Muellimperium Exchange Format
  version: 0.0.1
  description: 'The Muellimperium Exchange Format is a data contract for exchanging
    data between the Muellimperium and its partners.

    '
  owner: Emperor of the Muellimperium
  contract:
    name: The Emperor
    email: [email protected]
servers:
  exchange:
    type: local
    format: csv
    path: data.csv
models:
  garbage_collection:
    type: table
    fields:
      location:
        type: text
        required: true
        primary: false
        unique: false
        description: The location where the garbage is collected.
      garbage_type:
        type: text
        required: true
        primary: false
        unique: false
        description: The type of garbage that is collected.
        enum:
        - paper
        - plastic
        - residual_waste
        - bio_waste
        - bulky_waste
        - hazardous_waste
      collection_date:
        type: date
        required: true
        primary: false
        unique: false
        description: The date when the garbage is collected.
examples:
- type: json
  model: garbage_collection
  data:
  - location: Musterstadt
    garbage_type: paper
    collection_date: '2022-01-01'
  - location: Musterstadt
    garbage_type: plastic
    collection_date: '2022-01-02'
  - location: Musterstadt
    garbage_type: residual_waste
    collection_date: '2022-01-03'