OFoffice-of-national-statistics

POST /manifest

Changed on

Request

  • The document declares no server URL.
  • Auth
    none declared

Request body

metadata_filestring required

The name of the associated metadata file. The metadata file is assumed to be in the zip alongside the manifest file. Currently only JSON format is accepted.

The file name must have a .json extension and can only contain letters, numbers, underscores (_) and hyphens (-).

Keeping the metadata file separate allows for better decoupling between the manifest and metadata file.

This could be beneficial as we iterate towards the "Common Interchange Format", where the metadata file would be a standard across the organisation for sharing statistical outputs between systems and may therefore not have the additional pipeline specific files the manifest currently provides. An alternative approach could be to combine the two files.

Example request

{
  "metadata_file": "metadata.json",
  "submission_contacts": [
    {
      "email": "jane.doe@ons.gov.uk"
    }
  ]
}

Changes

  • aec576172a51Revision changes
    • breaking

      added the pattern @(ext\.)?ons\.gov\.uk$ to the request property //

  • f7b5a3b0605cRevision changes
    • breaking

      added the new required request property

    • breaking

      added the pattern ^[0-9a-zA-Z_-]+.json$ to the request property

    • warning

      removed the request property