Skip to content

Commit 1b5ede8

Browse files
dino8890c00kiemon5ter
authored andcommitted
Corrected documentation for contact_person.
1 parent 297ac5c commit 1b5ede8

File tree

1 file changed

+27
-23
lines changed

1 file changed

+27
-23
lines changed

docs/howto/config.rst

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -221,26 +221,30 @@ contact_person
221221
^^^^^^^^^^^^^^
222222

223223
This is only used by *make_metadata.py* when it constructs the metadata for
224-
the service described by the configuration file.
225-
This is where you describe who can be contacted if questions arise
226-
about the service or if support is needed. The possible types are according to
227-
the standard **technical**, **support**, **administrative**, **billing**
228-
and **other**.::
224+
the service described by the configuration file. This is where you describe
225+
who can be contacted if questions arise about the service or if support is
226+
needed.
227+
228+
Note that `contact_type` is required for a valid schema. The possible types
229+
are according to the standard **technical**, **support**, **administrative**,
230+
**billing** and **other**::
229231

230232
contact_person: [
231233
{
232-
"givenname": "Derek",
233-
"surname": "Jeter",
234+
"given_name": "Derek",
235+
"sur_name": "Jeter",
234236
"company": "Example Co.",
235-
"mail": ["jeter@example.com"],
236-
"type": "technical",
237+
"email_address": ["jeter@example.com"],
238+
"telephone_number": ["123-456-789", "+1 234 567 89"]
239+
"contact_type": "technical",
237240
},
238241
{
239-
"givenname": "Joe",
240-
"surname": "Girardi",
242+
"given_name": "Joe",
243+
"sur_name": "Girardi",
241244
"company": "Example Co.",
242-
"mail": "girardi@example.com",
243-
"type": "administrative",
245+
"email_address": ["girardi@example.com", "admin@example.com"]
246+
"telephone_number": ["987-654-321"]
247+
"contact_type": "administrative",
244248
},
245249
]
246250

@@ -1481,11 +1485,11 @@ We start with a simple but fairly complete Service provider configuration::
14811485
}
14821486
"contact_person": [
14831487
{
1484-
"givenname": "Roland",
1485-
"surname": "Hedberg",
1486-
"phone": "+46 90510",
1487-
"mail": "roland@example.com",
1488-
"type": "technical",
1488+
"given_name": "Roland",
1489+
"sur_name": "Hedberg",
1490+
"telephone_number": ["+46 90510"],
1491+
"email_address": ["roland@example.com"],
1492+
"contact_type": "technical",
14891493
},
14901494
]
14911495
}
@@ -1539,11 +1543,11 @@ A slightly more complex configuration::
15391543
}
15401544
"contact_person": [
15411545
{
1542-
"givenname": "Roland",
1543-
"surname": "Hedberg",
1544-
"phone": "+46 90510",
1545-
"mail": "roland@example.com",
1546-
"type": "technical",
1546+
"given_name": "Roland",
1547+
"sur_name": "Hedberg",
1548+
"telephone_number": ["+46 90510"],
1549+
"email_address": ["roland@example.com"],
1550+
"contact_type": "technical",
15471551
},
15481552
]
15491553
}

0 commit comments

Comments
 (0)