Info

Information about the data contract

Title

{{ datacontract.info.title }}

Version

{{ datacontract.info.version }}

{% if datacontract.info.description %}

Description

{{ datacontract.info.description }}

{% endif %} {% if datacontract.info.owner %}

Owner

{{ datacontract.info.owner }}

{% endif %} {% if datacontract.info.contact %}

Contact

{% if datacontract.info.contact.name %} {{ datacontract.info.contact.name }} {% endif %} {% if datacontract.info.contact.email %} {{ datacontract.info.contact.email }} {% endif %} {% if datacontract.info.contact.url %}

{{ datacontract.info.contact.url }}

{% endif %}

{% endif %}

{% if datacontract.servers %}

Servers

Servers of the data contract

{% for server_name, server in datacontract.servers.items() %}
• Server

  {{server_name}}
  {% if server.type %}
  Type

  {{server.type}}
  {% endif %} {% if server.project %}
  Project

  {{server.project}}
  {% endif %} {% if server.dataset %}
  Dataset

  {{server.dataset}}
  {% endif %} {% if server.location %}
  Location

  {{server.location}}
  {% endif %} {% if server.endpointUrl %}
  Endpoint URL

  {{server.endpointUrl}}
  {% endif %} {% if server.account %}
  Account

  {{server.account}}
  {% endif %} {% if server.host %}
  Host

  {{server.host}}
  {% endif %} {% if server.port %}
  Port

  {{server.port}}
  {% endif %} {% if server.catalog %}
  Catalog

  {{server.catalog}}
  {% endif %} {% if server.database %}
  Database

  {{server.database}}
  {% endif %} {% if server.schema_ %}
  Schema

  {{server.schema_}}
  {% endif %} {% if server.topic %}
  Topic

  {{server.topic}}
  {% endif %} {% if server.path %}
  Path

  {{server.path}}
  {% endif %} {% if server.format %}
  Format

  {{server.format}}
  {% endif %} {% if server.delimiter %}
  Delimiter

  {{server.delimiter}}
  {% endif %}
{% endfor %}

{% endif %} {% if datacontract.terms %}

Terms

Terms and conditions of the data contract

Usage

{{ datacontract.terms.usage }}

Limitations

{{ datacontract.terms.limitations }}

{% if datacontract.terms.billing %}

Billing

{{ datacontract.terms.billing }}

{% endif %} {% if datacontract.terms.noticePeriod %}

Notice Period

{{ datacontract.terms.noticePeriod }}

{% endif %}

{% endif %}

Data Model

The logical data model

{% for model_name, model in datacontract.models.items() %}

{% for field_name, field in model.fields.items() %} {% endfor %}

{{ model_name }} {{ model.type }} {{ model.description }}
{{ field_name }} {# TODO nested fields #}	{% if field.required %} R {% endif %} {% if field.unique %} U {% endif %}	{% if field.type %} {{ field.type }} {% endif %}	{{ field.description or "No description" }} {# TODO add format information #}

{% endfor %}

{# TODO add definitions #} {# TODO add service levels #} {% if quality_specification %}

Quality

{{ datacontract.quality.type }}

{{ quality_specification }}

{% endif %}