Manifest File

About

manifest files are yaml file that describes a tabulify resource.

Syntax

A manifest file follows the following syntax:

kind: 'kind'
spec:
  attributeName: attributeValue
  ....: ....

where

• kind is a single name resource identifier for a media type.
• attributes is map of attribute

Type

There is 2 type of manifest

• tabulify manifest
• resource manifest

Tabulify

Tabulify manifests are files that:

• stores Tabulify objects.
• have their own specific schema

List:

• tabul
• generator
• pipeline

Resource

Resource manifests are manifest that:

• defines a resource
• with the following 3 attributes:
  • data uri
  • media type
  • and data definition

Example:

• sql-fetch
• csv
• ..

kind: csv
spec:
  data-def:
    logical-name: favorite_books
    header-row-id: 1
    delimiter-character: ','
    columns:
      - name: asin
        type: varchar
        precision: 20
      - name: description
        type: varchar
      - name: price
        type: double
      - name: group
        type: varchar

Naming

The name of a metadata file follows the following convention:

logical-Name--kind.yml

where:

• logical-name is an arbitrary name
• --kind is a prefix with the kind of resource

For example for a generator that generates time data

time--generator.yml

Media Type

The media type follows the the Vendor tree media types (vnd) convention:

text/vnd.tabulify.kind+yaml

For instance, a generator has the following media type

text/vnd.tabulify.generator+yaml

Note

Data URI

In a manifest, the data uri can use the the md connection where md is the directory of the manifest.