Manifest

Definition

The Manifest is a container for metadata describing the content and origin of an archive.

Object Structure

Manifest objects are JSON objects.
Manifest objects MUST be provided with every delivery in an isolated file named "manifest.json"
Manifest objects MUST have a "version" member with an VERSION value
Manifest objects MUST have a "created" member with a DATE-TIME value
Manifest objects MUST have a "language" member with a LANGUAGE value

Property Keys

Property	Type	Description
`version`	`VERSION`	Version number of IMDF that the dataset content was produced in compliance with
`created`	`DATE-TIME`	Date and time of archive creation
`generated_by`	`null` or `STRING`	Unique identifier of the application or system responsible for generating an IMDF archive, including release number. Treated as an opaque data type and intended solely for use in auditing scenarios or to aid in troubleshooting
`language`	`LANGUAGE-TAG`	Tag identifying the default language used in the Venue data
`extensions`	`null` or `EXTENSIONS`	Lists formalized IMDF extensions used in the IMDF Archive

Example

{
  "version": "1.0.0",
  "created": "2020-09-09T12:34:56",
  "generated_by": "FME 2019.0 b19238",
  "language": "en-US",
  "extensions": [ "imdf:extension:big-company:internal#1.0.0" ]
}

Guidance

VERSION

NOTE: At this time, the ONLY permissible value for this member is "1.0.0"

MUST be the semantic version number associated with IMDF that the venue data was constructed in compliance with

CREATED

MUST be a valid DATE-TIME value reflecting the time at which the archive was generated and packaged for delivery
SHOULD be generated at the time of archive packaging

GENERATED BY

Metadata intended to be managed, maintained and tracked by the Venue or Map Making Organization

LANGUAGE

MUST be a valid LANGUAGE tag identifying the default language used in the Venue data