Skip to content
This repository was archived by the owner on Jun 18, 2024. It is now read-only.

Commit b27b723

Browse files
committed
updating contactPoint directions
In response to #358
1 parent cfd0e1a commit b27b723

File tree

1 file changed

+28
-13
lines changed

1 file changed

+28
-13
lines changed

Diff for: v1.1/schema.md

+28-13
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,7 @@ description | Description | Human-readable description (e.g., a
7272
keyword | Tags | Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non-technical users.
7373
modified | Last Update | Most recent date on which the dataset was changed, updated or modified.
7474
publisher | Publisher | The publishing entity.
75-
contactPoint | Contact Name | Contact person's name for the asset.
76-
mbox | Contact Email | Contact person's email address.
75+
contactPoint | Contact Name and Email | Contact person's name and email for the asset.
7776
identifier | Unique Identifier | A unique identifier for the dataset or API as maintained within an Agency catalog or database.
7877
accessLevel | Public Access Level | The degree to which this dataset **could** be made publicly-available, *regardless of whether it has been made available*. Choices: public (Data asset is or could be made publicly available to all without restrictions), restricted public (Data asset is available under certain use restrictions), or non-public (Data asset is not available to members of the public)
7978

@@ -200,9 +199,34 @@ Dataset Fields {#Dataset}
200199
----- | -----
201200
**Cardinality** | (1,1)
202201
**Required** | Yes, always
202+
**Accepted Values** | vCard object
203+
**Usage Notes** | This is a container for two fields that together make up the contact information for the dataset. **contactPoint** should always contain both the person's appropriately formatted full name (**fn**) and email (**hasEmail**).
204+
**Example** | See below
205+
206+
~~~
207+
"contactPoint": {
208+
"fn": "Jane Doe",
209+
"hasEmail": "mailto:[email protected]"
210+
}
211+
~~~
212+
213+
{: .table .table-striped .child-field #contactPoint-fn}
214+
**Field [#](#contactPoint-fn){: .permalink}** | **contactPoint → fn**
215+
----- | -----
216+
**Cardinality** | (1,1)
217+
**Required** | Yes, always
203218
**Accepted Values** | String
204-
**Usage Notes** | -
205-
**Example** | `{"contactPoint":"John Brown"}`
219+
**Usage Notes** | This should include included with **hasEmail** as part of a record's **contactPoint** (see above example).
220+
**Example** | `{"fn": "Jane Doe"}`
221+
222+
{: .table .table-striped .child-field #contactPoint-hasEmail}
223+
**Field [#](#contactPoint-hasEmail){: .permalink}** | **contactPoint → hasEmail**
224+
----- | -----
225+
**Cardinality** | (1,1)
226+
**Required** | Yes, always
227+
**Accepted Values** | String
228+
**Usage Notes** | This should be formatted per vCard specifications (see example below) and included with **fn** as part of a record's **contactPoint** (see above example).
229+
**Example** | `{"hasEmail": "mailto:[email protected]"}`
206230

207231
{: .table .table-striped #dataDictionary}
208232
**Field [#](#dataDictionary){: .permalink}** | **dataDictionary**
@@ -383,15 +407,6 @@ Dataset Fields {#Dataset}
383407
**Usage Notes** | See list of licenses.
384408
**Example** | `{"license":""}`
385409

386-
{: .table .table-striped #mbox}
387-
**Field [#](#mbox){: .permalink}** | **mbox**
388-
----- | -----
389-
**Cardinality** | (1,1)
390-
**Required** | Yes, always
391-
**Accepted Values** | Email address
392-
**Usage Notes** | -
393-
**Example** | `{"mbox":"[email protected]"}`
394-
395410
{: .table .table-striped #modified}
396411
**Field [#](#modified){: .permalink}** | **modified**
397412
----- | -----

0 commit comments

Comments
 (0)