1 | {
|
2 | "title": "PostalAddress",
|
3 | "@id": "schema:PostalAddress",
|
4 | "extends": "ContactPoint",
|
5 | "role": "tertiary",
|
6 | "status": "stable",
|
7 | "category": "other",
|
8 | "description": "A physical mailing address.",
|
9 | "properties": {
|
10 | "type": {
|
11 | "@id": "schema:type",
|
12 | "description": "The name of the type.",
|
13 | "type": "string",
|
14 | "enum": [
|
15 | "PostalAddress"
|
16 | ],
|
17 | "default": "PostalAddress",
|
18 | "from": "Entity"
|
19 | },
|
20 | "id": {
|
21 | "@id": "schema:id",
|
22 | "description": "The identifier for this item.",
|
23 | "type": "string",
|
24 | "from": "Entity"
|
25 | },
|
26 | "meta": {
|
27 | "@id": "stencila:meta",
|
28 | "description": "Metadata associated with this item.",
|
29 | "type": "object",
|
30 | "from": "Entity"
|
31 | },
|
32 | "alternateNames": {
|
33 | "@id": "schema:alternateName",
|
34 | "description": "Alternate names (aliases) for the item.",
|
35 | "type": "array",
|
36 | "items": {
|
37 | "type": "string"
|
38 | },
|
39 | "from": "Thing",
|
40 | "isArray": true,
|
41 | "isPlural": true,
|
42 | "aliases": [
|
43 | "alternateName"
|
44 | ]
|
45 | },
|
46 | "description": {
|
47 | "@id": "schema:description",
|
48 | "description": "A description of the item.",
|
49 | "$comment": "Allows for the description to be an array of nodes (e.g. an array of inline content,\nor a couple of paragraphs), or a string. The `minItems` restriction avoids a string\nbeing coerced into an array with a single string item.\n",
|
50 | "anyOf": [
|
51 | {
|
52 | "type": "array",
|
53 | "items": {
|
54 | "$ref": "BlockContent.schema.json"
|
55 | }
|
56 | },
|
57 | {
|
58 | "type": "array",
|
59 | "items": {
|
60 | "$ref": "InlineContent.schema.json"
|
61 | },
|
62 | "minItems": 2
|
63 | },
|
64 | {
|
65 | "type": "string"
|
66 | }
|
67 | ],
|
68 | "from": "Thing"
|
69 | },
|
70 | "identifiers": {
|
71 | "@id": "schema:identifier",
|
72 | "description": "Any kind of identifier for any kind of Thing.",
|
73 | "$comment": "Some identifiers have specific properties e.g the `issn` property for\nthe `Periodical` type. These should be used in preference to this\nproperty which is intended for identifiers that do not yet have a\nspecific property. Identifiers can be represented as strings, but\nusing a `PropertyValue` will usually be better because it allows\nfor `propertyID` (i.e. the type of identifier).\n",
|
74 | "type": "array",
|
75 | "items": {
|
76 | "anyOf": [
|
77 | {
|
78 | "$ref": "PropertyValue.schema.json"
|
79 | },
|
80 | {
|
81 | "type": "string"
|
82 | }
|
83 | ]
|
84 | },
|
85 | "from": "Thing",
|
86 | "isArray": true,
|
87 | "isPlural": true,
|
88 | "aliases": [
|
89 | "identifier"
|
90 | ]
|
91 | },
|
92 | "images": {
|
93 | "@id": "schema:image",
|
94 | "description": "Images of the item.",
|
95 | "type": "array",
|
96 | "items": {
|
97 | "anyOf": [
|
98 | {
|
99 | "$ref": "ImageObject.schema.json"
|
100 | },
|
101 | {
|
102 | "type": "string",
|
103 | "format": "uri"
|
104 | }
|
105 | ]
|
106 | },
|
107 | "from": "Thing",
|
108 | "isArray": true,
|
109 | "isPlural": true,
|
110 | "aliases": [
|
111 | "image"
|
112 | ]
|
113 | },
|
114 | "name": {
|
115 | "@id": "schema:name",
|
116 | "description": "The name of the item.",
|
117 | "type": "string",
|
118 | "from": "Thing"
|
119 | },
|
120 | "url": {
|
121 | "@id": "schema:url",
|
122 | "description": "The URL of the item.",
|
123 | "type": "string",
|
124 | "format": "uri",
|
125 | "from": "Thing"
|
126 | },
|
127 | "availableLanguages": {
|
128 | "@id": "schema:availableLanguage",
|
129 | "description": "Languages (human not programming) in which it is possible to communicate\nwith the organization/department etc.\n",
|
130 | "type": "array",
|
131 | "items": {
|
132 | "type": "string"
|
133 | },
|
134 | "from": "ContactPoint",
|
135 | "isArray": true,
|
136 | "isPlural": true,
|
137 | "aliases": [
|
138 | "availableLanguage"
|
139 | ]
|
140 | },
|
141 | "emails": {
|
142 | "@id": "schema:email",
|
143 | "description": "Email address for correspondence.",
|
144 | "type": "array",
|
145 | "items": {
|
146 | "type": "string",
|
147 | "format": "email"
|
148 | },
|
149 | "from": "ContactPoint",
|
150 | "isArray": true,
|
151 | "isPlural": true,
|
152 | "aliases": [
|
153 | "email"
|
154 | ]
|
155 | },
|
156 | "telephoneNumbers": {
|
157 | "@id": "schema:telephone",
|
158 | "aliases": [
|
159 | "telephone",
|
160 | "telephoneNumber"
|
161 | ],
|
162 | "description": "Telephone numbers for the contact point.",
|
163 | "type": "array",
|
164 | "items": {
|
165 | "type": "string"
|
166 | },
|
167 | "from": "ContactPoint",
|
168 | "isArray": true,
|
169 | "isPlural": true
|
170 | },
|
171 | "streetAddress": {
|
172 | "@id": "schema:streetAddress",
|
173 | "description": "The street address.",
|
174 | "$comment": "For example, 10 Downing Street.",
|
175 | "type": "string",
|
176 | "from": "PostalAddress"
|
177 | },
|
178 | "postOfficeBoxNumber": {
|
179 | "@id": "schema:postOfficeBoxNumber",
|
180 | "description": "The post office box number.",
|
181 | "type": "string",
|
182 | "from": "PostalAddress"
|
183 | },
|
184 | "addressLocality": {
|
185 | "@id": "schema:addressLocality",
|
186 | "description": "The locality in which the street address is, and which is in the region.",
|
187 | "$comment": "For example, London.",
|
188 | "type": "string",
|
189 | "from": "PostalAddress"
|
190 | },
|
191 | "addressRegion": {
|
192 | "@id": "schema:addressRegion",
|
193 | "description": "The region in which the locality is, and which is in the country.",
|
194 | "$comment": "For example, California or another appropriate first-level Administrative division",
|
195 | "type": "string",
|
196 | "from": "PostalAddress"
|
197 | },
|
198 | "postalCode": {
|
199 | "@id": "schema:postalCode",
|
200 | "description": "The postal code.",
|
201 | "$comment": "For example, 94043.",
|
202 | "type": "string",
|
203 | "from": "PostalAddress"
|
204 | },
|
205 | "addressCountry": {
|
206 | "@id": "schema:addressCountry",
|
207 | "description": "The country.",
|
208 | "$comment": "For example, United Kingdom. You can also provide the two-letter ISO 3166-1 alpha-2 country code.",
|
209 | "type": "string",
|
210 | "from": "PostalAddress"
|
211 | }
|
212 | },
|
213 | "file": "PostalAddress.schema.yaml",
|
214 | "children": [],
|
215 | "descendants": [],
|
216 | "$schema": "http://json-schema.org/draft-07/schema#",
|
217 | "$id": "https://schema.stenci.la/v1/PostalAddress.schema.json",
|
218 | "source": "https://github.com/stencila/schema/blob/master/schema/PostalAddress.schema.yaml",
|
219 | "type": "object",
|
220 | "additionalProperties": false,
|
221 | "required": [
|
222 | "type"
|
223 | ],
|
224 | "propertyAliases": {
|
225 | "alternateName": "alternateNames",
|
226 | "identifier": "identifiers",
|
227 | "image": "images",
|
228 | "availableLanguage": "availableLanguages",
|
229 | "email": "emails",
|
230 | "telephone": "telephoneNumbers",
|
231 | "telephoneNumber": "telephoneNumbers"
|
232 | }
|
233 | }
|