adiwg-mdjson_schemas 1.0.0rc1

data/schema/schema/citation.json

@@ -0,0 +1,186 @@
+{
+  "id": "citation.json#",
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "schema for citation",
+  "translation": {
+    "ISO 19115-2": ["CI_Citation"]
+  },
+  "type": "object",
+  "required": ["title", "date"],
+  "allOf": [
+    {
+      "$ref": "#/definitions/citationFull"
+    }
+  ],
+  "definitions": {
+    "citationBase": {
+      "title": "base citation",
+      "description": "A minimal citation object supporting only basic attributes.",
+      "example": "../../examples/full_example.json#/metadata/resourceInfo/citation/identifier/0/authority",
+      "translation": {
+        "FGDC CSDGM": ["idinfo > citation > citeinfo"]
+      },
+      "type": "object",
+      "required": ["title"],
+      "properties": {
+        "title": {
+          "type": "string",
+          "description": "Name by which the cited resource is known.",
+          "translation": {
+            "ISO 19115-2": ["CI_Citation > title"],
+            "FGDC CSDGM": ["idinfo > citation > citeinfo > title"]
+          }
+        },
+        "date": {
+          "type": "array",
+          "description": "Date referenced to the cited resource.",
+          "translation": {
+            "ISO 19115-2": ["CI_Citation > date > CI_Date"]
+          },
+          "minItems": 1,
+          "items": {
+            "type": "object",
+            "example": "../../examples/full_example.json#/metadata/resourceInfo/citation/date",
+            "required": ["date", "dateType"],
+            "properties": {
+              "date": {
+                "translation": {
+                  "ISO 19115-2": ["CI_Date > date"],
+                  "FGDC CSDGM": ["idinfo > citation > citeinfo > pubdate"]
+                },
+                "$ref": "../schema.json#/definitions/date"
+              },
+              "dateType": {
+                "type": "string",
+                "description": "The type of date in the context of the citation.",
+                "translation": {
+                  "ISO 19115-2": ["CI_Date > dateType [CI_DateTypeCode]"]
+                }
+              }
+            }
+          }
+        },
+        "responsibleParty": {
+          "type": "array",
+          "description": "Identification of, and means of communication with, person(s) and organization(s) associated with the cited resource.",
+          "translation": {
+            "ISO 19115-2": ["CI_Citation > citedResponsibleParty > CI_ResponsibleParty"],
+            "FGDC CSDGM": ["idinfo > ptcontac > cntinfo"]
+          },
+          "minItems": 1,
+          "items": {
+            "$ref": "contact.json#/definitions/contactRef"
+          }
+        },
+        "onlineResource": {
+          "type": "array",
+          "description": "On-line information related to the citation.",
+          "translation": {
+            "ISO 19115-2": ["CI_Citation > citedResponsibleParty > CI_ResponsibleParty > contact > CI_Contact > onlineResource > CI_OnlineResource"]
+          },
+          "items": {
+            "$ref": "onlineResource.json#"
+          }
+        }
+      }
+    },
+    "citationFull": {
+      "type": "object",
+      "title": "full citation",
+      "description": "A full citation object, all attributes are supported.",
+      "example": "../../examples/full_example.json#/metadata/resourceInfo/citation",
+      "properties": {
+        "edition": {
+          "type": "string",
+          "description": "Version identifier for the resource.",
+          "translation": {
+            "ISO 19115-2": ["CI_Citation > edition"],
+            "FGDC CSDGM": ["idinfo > citation > edition"]
+          }
+        },
+        "presentationForm": {
+          "type": "array",
+          "description": "The form that the resource is presented, such as: digital map, digital document, etc.",
+          "translation": {
+            "ISO 19115-2": ["CI_Citation > presentationForm [CI_PresentationFormCode]"],
+            "FGDC CSDGM": ["idinfo > citation > geoform"]
+          },
+          "items": {
+            "type": "string"
+          }
+        },
+        "identifier": {
+          "type": "array",
+          "description": "Identifier for the resource in the context of the citation.",
+          "translation": {
+            "ISO 19115-2": ["CI_Citation > identifier"]
+          },
+          "items": {
+            "$ref": "#/definitions/identifier"
+          }
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "#/definitions/citationBase"
+        }
+      ]
+    },
+    "identifier": {
+      "title": "identifier",
+      "description": "Assigned identifier for a resource.",
+      "example": "../../examples/full_example.json#/metadata/resourceInfo/citation/identifier",
+      "translation": {
+        "ISO 19115-2": ["MD_Identifier"]
+      },
+      "type": "object",
+      "required": ["identifier"],
+      "properties": {
+        "identifier": {
+          "type": "string",
+          "description": "A name that is used to identify the resource.",
+          "translation": {
+            "ISO 19115-2": ["MD_Identifier > code"]
+          }
+        },
+        "type": {
+          "type": "string",
+          "description": "The type of identifier, e.g. doi, isbn, issn, etc.",
+          "translation": {
+            "ISO 19115-2": ["CI_Citation > ISBN", "CI_Citation > ISSN"]
+          }
+        },
+        "authority": {
+          "description": "Citation for the authority issuing the identifier.",
+          "example": "../../examples/full_example.json#/metadata/resourceInfo/citation/identifier",
+          "translation": {
+            "ISO 19115-2": ["MD_Identifier > authority > CI_Citation"]
+          },
+          "$ref": "#/definitions/citationBase"
+        }
+      }
+    },
+    "dictionary": {
+      "type": "object",
+      "example": "../../examples/full_example.json#/dataDictionary/0/dictionaryInfo/citation",
+      "required": ["title", "date"],
+      "title": "dictionary citation",
+      "description": "A citation object for data dictionaries.",
+      "properties": {
+        "edition": {
+          "type": "string",
+          "description": "Version identifier for the dictionary.",
+          "translation": {
+            "ISO 19115-2": ["CI_Citation > edition"],
+            "FGDC CSDGM": ["idinfo > citation > edition"]
+          }
+        }
+      },
+      "allOf": [
+        {
+          "$ref": "#/definitions/citationBase"
+        }
+      ]
+    }
+  }
+}

data/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/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"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}