adiwg-mdtranslator 0.12.1 → 1.0.0rc1

data/test/schemas/v1_0/schema/schema/contact.json

@@ -0,0 +1,255 @@
+{
+  "id": "contact.json#",
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "An array of contacts to be referenced throughout the metadata. Any contact used in the metadata record must be stored within this array and referenced by contactId. Items in array may be used 0-n times throughout the record.",
+  "translation": {
+    "ISO 19115-2": ["Contact > CI_ResponsibleParty"],
+    "FGDC CSDGM": ["[single member of array] = cntinfo"]
+  },
+  "example": "../../examples/full_example.json#/contact",
+  "type": "array",
+  "minItems": 1,
+  "uniqueItems": true,
+  "items": {
+    "anyOf": [
+      {
+        "$ref": "#/definitions/individual"
+      }, {
+        "$ref": "#/definitions/organization"
+      }
+    ]
+  },
+  "definitions": {
+    "phone": {
+      "type": "object",
+      "example": "../../examples/full_example.json#/contact/1/phoneBook",
+      "required": ["phoneNumber"],
+      "properties": {
+        "phoneName": {
+          "type": "string",
+          "description": "Descriptive name of the phone number."
+        },
+        "phoneNumber": {
+          "type": "string",
+          "description": "Telephone number. Recommended format is to use 'x' or 'ext' to denote extensions.",
+          "translation": {
+            "ISO 19115-2": ["CI_Telephone > voice | facsimile"],
+            "FGDC CSDGM": ["cntinfo > cntvoice"]
+          },
+          "pattern": "^[0-9+()#. \/ext-]+$"
+        },
+        "service": {
+          "type": "array",
+          "description": "Type(s) of phone number, e.g. voice, sms."
+          ,
+          "items": {
+            "type": "string"
+          },
+          "uniqueItems": true
+        }
+      },
+      "additionalProperties": false
+    },
+    "address": {
+      "type": "object",
+      "example": "../../examples/full_example.json#/contact/1/address",
+      "description": "Physical and email address at which the organization or individual may be contacted.",
+      "translation": {
+        "ISO 19115-2": ["CI_ResponsibleParty > contactInfo > CI_Contact > address > CI_Address"],
+        "FGDC CSDGM": ["cntinfo > cntaddr"]
+      },
+      "properties": {
+        "deliveryPoint": {
+          "type": "array",
+          "description": "Address line for the location.",
+          "translation": {
+            "ISO 19115-2": ["CI_Address > deliveryPoint"],
+            "FGDC CSDGM": ["cntinfo > cntaddr > address"]
+          },
+          "items": {
+            "type": "string"
+          },
+          "uniqueItems": true
+        },
+        "city": {
+          "type": "string",
+          "description": "City of the location.",
+          "translation": {
+            "ISO 19115-2": ["CI_Address > city"],
+            "FGDC CSDGM": ["cntinfo > cntaddr > city"]
+          }
+        },
+        "administrativeArea": {
+          "type": "string",
+          "description": "State, province of the location.",
+          "translation": {
+            "ISO 19115-2": ["CI_Address > administrativeArea"],
+            "FGDC CSDGM": ["cntinfo > cntaddr > state"]
+          }
+        },
+        "postalCode": {
+          "type": "string",
+          "description": "ZIP or other postal code.",
+          "translation": {
+            "ISO 19115-2": ["CI_Address > postalCode"],
+            "FGDC CSDGM": ["cntinfo > cntaddr > postal"]
+          }
+        },
+        "country": {
+          "type": "string",
+          "description": "ZIP or other postal code.",
+          "translation": {
+            "ISO 19115-2": ["CI_Address > postalCode"],
+            "FGDC CSDGM": ["cntinfo > cntaddr > postal"]
+          }
+        },
+        "electronicMailAddress": {
+          "type": "array",
+          "description": "E-mail or electronic mailbox address.",
+          "translation": {
+            "ISO 19115-2": ["CI_Address > electronicMailAddress"],
+            "FGDC CSDGM": ["cntinfo > cntemail"]
+          },
+          "items": {
+            "type": "string",
+            "pattern": "^.+@.+\\..+$"
+          },
+          "uniqueItems": true
+        }
+      },
+      "additionalProperties": false
+    },
+    "baseContact": {
+      "type": "object",
+      "title": "base contact",
+      "description": "Basic information for a contact.",
+      "required": ["contactId"],
+      "additionalProperties": true,
+      "properties": {
+        "contactId": {
+          "type": "string",
+          "example": "../../examples/full_example.json#/contact/1"
+        },
+        "positionName": {
+          "type": "string",
+          "example": "../../examples/full_example.json#/contact/1",
+          "description": "Role or position of the person, usually within a given organization.",
+          "translation": {
+            "ISO 19115-2": ["CI_ResponsibleParty > positionName"],
+            "FGDC CSDGM": ["cntinfo > cntpos"]
+          }
+        },
+        "address": {
+          "$ref": "#/definitions/address"
+        },
+        "onlineResource": {
+          "type": "array",
+          "description": "Information about accessing on-line resources and services. This may be a website, profile page, GitHub page, etc. related to the contact.",
+          "example": "../../examples/full_example.json#/contact/1",
+          "translation": {
+            "ISO 19115-2": ["CI_ResponsibleParty > contactInfo > CI_Contact > onlineResource > CI_OnlineResource"]
+          },
+          "items": {
+            "$ref": "onlineResource.json#"
+          },
+          "uniqueItems": true
+        },
+        "contactInstructions": {
+          "type": "string",
+          "description": "Supplemental instructions on how or when to contact the individual or organization.",
+          "example": "../../examples/full_example.json#/contact/1",
+          "translation": {
+            "ISO 19115-2": ["CI_Contact > contactInstructions"],
+            "FGDC CSDGM": ["cntinfo > cntinst"]
+          }
+        },
+        "phoneBook": {
+          "type": "array",
+          "description": "Supplemental instructions on how or when to contact the individual or organization.",
+          "example": "../../examples/full_example.json#/contact/1",
+          "translation": {
+            "ISO 19115-2": ["CI_Contact > contactInstructions"],
+            "FGDC CSDGM": ["cntinfo > cntinst"]
+          },
+          "items": {
+            "$ref": "#/definitions/phone"
+          }
+        }
+      }
+    },
+    "individual": {
+      "type": "object",
+      "title": "individual",
+      "example": "../../examples/full_example.json#/contact/1",
+      "description": "Contact information for a person.",
+      "translation": {
+        "ISO 19115-2": ["Contact > CI_ResponsibleParty"],
+        "FGDC CSDGM": ["cntinfo > cntperp"]
+      },
+      "required": ["individualName"],
+      "additionalProperties": true,
+      "properties": {
+        "individualName": {
+          "type": "string",
+          "description": "Name of the person - surname, given name, title separated by a delimiter.",
+          "example": "../../examples/full_example.json#/contact/1",
+          "translation": {
+            "ISO 19115-2": ["CI_ResponsibleParty > individualName"],
+            "FGDC CSDGM": ["cntinfo > cntperp > cntper"]
+          }
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "#/definitions/baseContact"
+        }
+      ]
+    },
+    "organization": {
+      "type": "object",
+      "title": "organization",
+      "example": "../../examples/full_example.json#/contact/0",
+      "translation": {
+        "ISO 19115-2": ["Contact > CI_ResponsibleParty"],
+        "FGDC CSDGM": ["cntinfo > cntorgp"]
+      },
+      "required": ["organizationName"],
+      "additionalProperties": true,
+      "properties": {
+        "organizationName": {
+          "type": "string",
+          "description": "Name of the organization.",
+          "translation": {
+            "ISO 19115-2": ["CI_ResponsibleParty > organisationName"],
+            "FGDC CSDGM": ["cntinfo > cntperp > cntorg"]
+          }
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "#/definitions/baseContact"
+        }
+      ]
+    },
+    "contactRef": {
+      "type": "object",
+      "example": "../../examples/full_example.json#/metadata/resourceInfo/citation/responsibleParty",
+      "additionalProperties": true,
+      "required": ["contactId", "role"],
+      "properties": {
+        "contactId": {
+          "type": "string",
+          "description": "Identifier matching a contactId in the main contact array."
+        },
+        "role": {
+          "type": "string",
+          "description": "Function performed by the contact in the current context.",
+          "translation": {
+            "ISO 19115-2": ["MI_Metadata > Contact > CI_Contact > role [CI_RoleCode]"],
+            "FGDC CSDGM": ["metainfo > cntinfo > cntpos"]
+          }
+        }
+      }
+    }
+  }
+}

data/test/schemas/v1_0/schema/schema/dataDictionary.json

@@ -0,0 +1,209 @@
+{
+  "id": "dataDictionary.json#",
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "description": "A catalogue containing definitions and descriptions of the resource types, resource attributes, and resource associations.",
+  "example": "../../examples/full_example.json#/dataDictionary/0",
+  "required": ["dictionaryInfo"],
+  "additionalProperties": false,
+  "properties": {
+    "dictionaryInfo": {
+      "type": "object",
+      "description": "Information describing the dictionary and its source.",
+      "example": "../../examples/full_example.json#/dataDictionary/0/dictionaryInfo",
+      "required": ["resourceType", "citation", "description"],
+      "additionalProperties": false,
+      "properties": {
+        "citation": {
+          "description": "Citation for the dictionary.",
+          "example": "../../examples/full_example.json#/dataDictionary/0/dictionaryInfo",
+          "$ref": "citation.json#/definitions/dictionary"
+        },
+        "resourceType": {
+          "type": "string",
+          "description": "The type of resource described by the dictionary."
+        },
+        "description": {
+          "type": "string",
+          "description": "Description of the dictionary."
+        },
+        "language": {
+          "type": "string",
+          "description": "Language used within the dictionary. Should be a valid ISO 639-3 code."
+        }
+      }
+    },
+    "domain": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "description": "Information describing an enumerated list of values.",
+        "example": "../../examples/full_example.json#/dataDictionary/0/domain/0",
+        "required": ["domainId", "codeName", "description", "member"],
+        "additionalProperties": false,
+        "properties": {
+          "domainId": {
+            "type": "string"
+          },
+          "commonName": {
+            "type": "string"
+          },
+          "codeName": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          },
+          "member": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "example": "../../examples/full_example.json#/dataDictionary/0/domain/0/member",
+              "required": ["name", "value", "definition"],
+              "additionalProperties": false,
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "value": {
+                  "type": "string"
+                },
+                "definition": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "entity": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "example": "../../examples/full_example.json#/dataDictionary/0/entity/1",
+        "required": ["entityId", "codeName", "definition"],
+        "additionalProperties": false,
+        "properties": {
+          "entityId": {
+            "type": "string"
+          },
+          "commonName": {
+            "type": "string"
+          },
+          "codeName": {
+            "type": "string"
+          },
+          "alias": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "definition": {
+            "type": "string"
+          },
+          "primaryKeyAttributeCodeName": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "index": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "example": "../../examples/full_example.json#/dataDictionary/0/entity/1/index",
+              "required": ["codeName", "allowDuplicates", "attributeCodeName"],
+              "additionalProperties": false,
+              "properties": {
+                "codeName": {
+                  "type": "string"
+                },
+                "allowDuplicates": {
+                  "type": "boolean"
+                },
+                "attributeCodeName": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          },
+          "attribute": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "example": "../../examples/full_example.json#/dataDictionary/0/entity/1/attribute",
+              "required": ["codeName", "dataType", "definition", "allowNull"],
+              "additionalProperties": false,
+              "properties": {
+                "commonName": {
+                  "type": "string"
+                },
+                "codeName": {
+                  "type": "string"
+                },
+                "alias": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                "definition": {
+                  "type": "string"
+                },
+                "dataType": {
+                  "type": "string"
+                },
+                "allowNull": {
+                  "type": "boolean"
+                },
+                "units": {
+                  "type": "string"
+                },
+                "domainId": {
+                  "type": "string"
+                },
+                "minValue": {
+                  "type": "string"
+                },
+                "maxValue": {
+                  "type": "string"
+                }
+              }
+            }
+          },
+          "foreignKey": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "example": "../../examples/full_example.json#/dataDictionary/0/entity/1/foreignKey",
+              "required": ["localAttributeCodeName", "referencedEntityCodeName", "referencedAttributeCodeName"],
+              "additionalProperties": false,
+              "properties": {
+                "localAttributeCodeName": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                "referencedEntityCodeName": {
+                  "type": "string"
+                },
+                "referencedAttributeCodeName": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

data/test/schemas/v1_0/schema/schema/dataQuality.json

@@ -0,0 +1,159 @@
+{
+  "id": "dataQuality.json#",
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "description": "Information about the quality of the resource.",
+  "example": "../../examples/full_example.json#/metadata/resourceInfo/dataQualityInfo",
+  "translation": {
+    "ISO 19115-2": ["DQ_DataQuality"],
+    "FGDC CSDGM": ["dataqual"]
+  },
+  "required": ["scope"],
+  "additionalProperties": false,
+  "properties": {
+    "scope": {
+      "type": "string",
+      "description": "The scope to which the data quality information is applied, for instance; dataset, attribute, feature, series, etc.",
+      "translation": {
+        "ISO 19115-2": ["DQ_DataQuality > scope > DQ_Scope > level > MD_ScopeCode"]
+      }
+    },
+    "lineage": {
+      "translation": {
+        "ISO 19115-2": ["DQ_DataQuality > lineage > LI_Lineage"],
+        "FGDC CSDGM": ["dataqual > lineage"]
+      },
+      "$ref": "#/definitions/lineage"
+    }
+  },
+  "definitions": {
+    "lineage": {
+      "type": "object",
+      "description": "Non-quantitative quality information about the lineage of the resource as specified by the scope.",
+      "example": "../../examples/full_example.json#/metadata/resourceInfo/dataQualityInfo/0/lineage",
+      "translation": {
+        "ISO 19115-2": ["LI_Lineage"]
+      },
+      "additionalProperties": false,
+      "properties": {
+        "statement": {
+          "type": "string",
+          "description": "General explanation of the data producer's knowledge about the lineage of a dataset.",
+          "translation": {
+            "ISO 19115-2": ["LI_Lineage > statement"]
+          }
+        },
+        "processStep": {
+          "type": "array",
+          "description": "Process or methodology steps applied to development of the resource.",
+          "translation": {
+            "ISO 19115-2": ["LI_Lineage > processStep > LI_ProcessStep"]
+          },
+          "items": {
+            "$ref": "#/definitions/processStep"
+          }
+        },
+        "source": {
+          "type": "array",
+          "description": "Information about the source of the resource relative to the data quality scope.",
+          "translation": {
+            "ISO 19115-2": ["LI_Lineage > source > LI_Source"],
+            "FGDC CSDGM": ["dataqual > lineage > srcinfo"]
+          },
+          "items": {
+            "$ref": "#/definitions/source"
+          }
+        }
+      }
+    },
+    "processStep": {
+      "type": "object",
+      "description": "Process or methodology steps applied to development of the resource.",
+      "example": "../../examples/full_example.json#/metadata/resourceInfo/dataQualityInfo/0/lineage/processStep",
+      "translation": {
+        "ISO 19115-2": ["LI_ProcessStep"]
+      },
+      "required": ["description"],
+      "additionalProperties": false,
+      "properties": {
+        "stepId": {
+          "type": "string",
+          "description": "Serial identifier used to order the sequence of steps used.",
+          "translation": {
+            "ISO 19115-2": ["LI_ProcessStep @ id"]
+          }
+        },
+        "description": {
+          "type": "string",
+          "description": "Description of the process or methodology step.",
+          "translation": {
+            "ISO 19115-2": ["LI_ProcessStep > description"],
+            "FGDC CSDGM": ["dataqual > lineage > procstep > procdesc"]
+          }
+        },
+        "rationale": {
+          "type": "string",
+          "description": "Requirement or purpose for the process or methodology step.",
+          "translation": {
+            "ISO 19115-2": ["LI_ProcessStep > rationale"]
+          }
+        },
+        "dateTime": {
+          "description": "Date and time or date at which the process or methodology step occurred.",
+          "translation": {
+            "ISO 19115-2": ["LI_ProcessStep > dateTime"],
+            "FGDC CSDGM": ["dataqual > lineage > procstep > procdate"]
+          },
+          "$ref": "../schema.json#/definitions/date"
+        },
+        "processor": {
+          "type": "array",
+          "description": "Identification of, and means of communication with, person(s) and organization(s) associated with the process or methodology step.",
+          "translation": {
+            "ISO 19115-2": ["LI_ProcessStep > processor > CI_ResponsibleParty"],
+            "FGDC CSDGM": ["dataqual > lineage > procstep > proccont > cntinfo"]
+          },
+          "items": {
+            "$ref": "contact.json#/definitions/contactRef"
+          }
+        }
+      }
+    },
+    "source": {
+      "type": "object",
+      "description": "Information about the source of the resource relative to the data lineage.",
+      "example": "../../examples/full_example.json#/metadata/resourceInfo/dataQualityInfo/0/lineage/source",
+      "translation": {
+        "ISO 19115-2": ["LI_Source"]
+      },
+      "additionalProperties": false,
+      "properties": {
+        "description": {
+          "type": "string",
+          "description": "Description of the source for the resource.",
+          "translation": {
+            "ISO 19115-2": ["LI_Source > description"]
+          }
+        },
+        "citation": {
+          "description": "Citation for the source.",
+          "translation": {
+            "ISO 19115-2": ["LI_Source > sourceCitation > CI_Citation"],
+            "FGDC CSDGM": ["dataqual > lineage > srcinfo > srccite > citeinfo"]
+          },
+          "$ref": "citation.json#"
+        },
+        "processStep": {
+          "type": "array",
+          "description": "Process or methodology steps applied to the development of the source.",
+          "translation": {
+            "ISO 19115-2": ["LI_Source > sourceStep > LI_ProcessStep"]
+          },
+          "items": {
+            "$ref": "#/definitions/processStep"
+          }
+        }
+      }
+    }
+  }
+}