@jsonresume/schema 1.8.0 → 1.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/SPEC.md +9 -2
- package/package.json +1 -1
- package/schema.json +77 -0
package/SPEC.md
CHANGED
|
@@ -74,14 +74,21 @@ MAY additionally sort dated entries by date.
|
|
|
74
74
|
| `awards` | `title`, `date`, `awarder`, `summary`. |
|
|
75
75
|
| `certificates` | `name`, `date`, `issuer`, `url`, `credentialId`, `expiryDate`, `summary`. |
|
|
76
76
|
| `publications` | `name`, `authors` (in published order, including the owner), `publisher` (for a talk, the event), `releaseDate`, `volume`, `issue`, `pages`, `identifiers` (keyed by scheme: `doi`, `isbn`, `arxiv`, …), `url`, `summary`, `type` (`article`, `book`, `patent`, `thesis`, `talk`, …). |
|
|
77
|
-
| `skills` | `name`, `level`, `keywords
|
|
78
|
-
| `languages` | `language` (its name)
|
|
77
|
+
| `skills` | `name`, `level`, `keywords`, `id` (a short stable identifier, such as `typescript`). |
|
|
78
|
+
| `languages` | `language` (its name), `fluency` (a label people read, such as "Fluent") and `scale` (the level on a published scale, for tools: `{ framework, level }`, such as `{ "framework": "CEFR", "level": "C1" }`; `framework` is free text: `CEFR`, `ILR`, `ACTFL`, …). |
|
|
79
79
|
| `interests` | `name`, `keywords`. |
|
|
80
80
|
| `references` | `name`, `reference` (the text), `relationship`, `organization`, `date`, `availableOnRequest` (show "available on request" instead of the text). There are deliberately no contact fields. |
|
|
81
81
|
| `projects` | `name`, `summary`, `description` (deprecated alias of `summary`; `summary` wins when both are set), `highlights`, `keywords`, `startDate`, `endDate`, `url`, `roles`, `entity` (affiliation), `type` (`talk`, `application`, …). |
|
|
82
82
|
| `meta` | About the document, not the person (§5). |
|
|
83
83
|
| `custom` | Extension data (§6). Allowed at the root, in `basics`, and on every entry of every section. |
|
|
84
84
|
|
|
85
|
+
`work[].skills`, `volunteer[].skills`, `education[].skills` and
|
|
86
|
+
`projects[].skills` list the skills an entry used. Each item is a string,
|
|
87
|
+
the `name` or `id` of a top-level skill, or a skill object (`name`, `level`,
|
|
88
|
+
`keywords`) for a skill grouped there. Consumers SHOULD resolve a string
|
|
89
|
+
against `skills[].id` first, then `skills[].name`, and SHOULD accept a
|
|
90
|
+
string that matches neither as a skill name.
|
|
91
|
+
|
|
85
92
|
Free-text type fields (`work[].type`, `publications[].type`, `projects[].type`) take any
|
|
86
93
|
value; the values listed are recommendations, so that tools can agree on
|
|
87
94
|
common cases.
|
package/package.json
CHANGED
package/schema.json
CHANGED
|
@@ -38,6 +38,36 @@
|
|
|
38
38
|
"description": "The general region where you live. Can be a US state, or a province, for instance."
|
|
39
39
|
}
|
|
40
40
|
}
|
|
41
|
+
},
|
|
42
|
+
"skillReference": {
|
|
43
|
+
"description": "A skill used in this entry (#313): the name or id of a skill in the top-level skills list, or a skill object shaped like one, e.g. { \"name\": \"Backend\", \"keywords\": [\"Go\"] }",
|
|
44
|
+
"anyOf": [
|
|
45
|
+
{
|
|
46
|
+
"type": "string",
|
|
47
|
+
"description": "A skills[].name or skills[].id, e.g. 'TypeScript'"
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
"type": "object",
|
|
51
|
+
"additionalProperties": true,
|
|
52
|
+
"properties": {
|
|
53
|
+
"name": {
|
|
54
|
+
"type": "string",
|
|
55
|
+
"description": "e.g. Backend"
|
|
56
|
+
},
|
|
57
|
+
"level": {
|
|
58
|
+
"type": "string",
|
|
59
|
+
"description": "e.g. Master"
|
|
60
|
+
},
|
|
61
|
+
"keywords": {
|
|
62
|
+
"type": "array",
|
|
63
|
+
"items": {
|
|
64
|
+
"type": "string",
|
|
65
|
+
"description": "e.g. Go"
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
]
|
|
41
71
|
}
|
|
42
72
|
},
|
|
43
73
|
"properties": {
|
|
@@ -178,6 +208,13 @@
|
|
|
178
208
|
"description": "e.g. React"
|
|
179
209
|
}
|
|
180
210
|
},
|
|
211
|
+
"skills": {
|
|
212
|
+
"type": "array",
|
|
213
|
+
"description": "Skills used in this role, naming or repeating entries of the top-level skills list, so a skill can point to where it was used (#313)",
|
|
214
|
+
"items": {
|
|
215
|
+
"$ref": "#/definitions/skillReference"
|
|
216
|
+
}
|
|
217
|
+
},
|
|
181
218
|
"custom": {
|
|
182
219
|
"$ref": "#/definitions/custom"
|
|
183
220
|
}
|
|
@@ -232,6 +269,13 @@
|
|
|
232
269
|
"description": "e.g. Increased profits by 20% from 2011-2012 through viral advertising"
|
|
233
270
|
}
|
|
234
271
|
},
|
|
272
|
+
"skills": {
|
|
273
|
+
"type": "array",
|
|
274
|
+
"description": "Skills used in this role, naming or repeating entries of the top-level skills list, so a skill can point to where it was used (#313)",
|
|
275
|
+
"items": {
|
|
276
|
+
"$ref": "#/definitions/skillReference"
|
|
277
|
+
}
|
|
278
|
+
},
|
|
235
279
|
"custom": {
|
|
236
280
|
"$ref": "#/definitions/custom"
|
|
237
281
|
}
|
|
@@ -294,6 +338,13 @@
|
|
|
294
338
|
"type": "string",
|
|
295
339
|
"description": "Thesis topic, honours, notable projects or other context (#292). Inline Markdown allowed: **strong**, *emphasis*, `code` and [links](https://example.com); no headings, lists or tables (#600)"
|
|
296
340
|
},
|
|
341
|
+
"skills": {
|
|
342
|
+
"type": "array",
|
|
343
|
+
"description": "Skills used in this course of study, naming or repeating entries of the top-level skills list, so a skill can point to where it was used (#313)",
|
|
344
|
+
"items": {
|
|
345
|
+
"$ref": "#/definitions/skillReference"
|
|
346
|
+
}
|
|
347
|
+
},
|
|
297
348
|
"custom": {
|
|
298
349
|
"$ref": "#/definitions/custom"
|
|
299
350
|
}
|
|
@@ -456,6 +507,10 @@
|
|
|
456
507
|
"type": "string",
|
|
457
508
|
"description": "e.g. Web Development"
|
|
458
509
|
},
|
|
510
|
+
"id": {
|
|
511
|
+
"type": "string",
|
|
512
|
+
"description": "A short, stable identifier that entries' skills lists can use instead of the name, e.g. 'typescript' (#313)"
|
|
513
|
+
},
|
|
459
514
|
"level": {
|
|
460
515
|
"type": "string",
|
|
461
516
|
"description": "e.g. Master"
|
|
@@ -489,6 +544,21 @@
|
|
|
489
544
|
"type": "string",
|
|
490
545
|
"description": "e.g. Fluent, Beginner"
|
|
491
546
|
},
|
|
547
|
+
"scale": {
|
|
548
|
+
"type": "object",
|
|
549
|
+
"description": "Where the language sits on a published proficiency scale, for tools; fluency stays the label people read (#315). e.g. { \"framework\": \"CEFR\", \"level\": \"C1\" }",
|
|
550
|
+
"additionalProperties": true,
|
|
551
|
+
"properties": {
|
|
552
|
+
"framework": {
|
|
553
|
+
"type": "string",
|
|
554
|
+
"description": "The scale, free text: 'CEFR', 'ILR', 'ACTFL', 'JLPT', 'HSK', …"
|
|
555
|
+
},
|
|
556
|
+
"level": {
|
|
557
|
+
"type": "string",
|
|
558
|
+
"description": "The level on that scale as it writes it, e.g. 'C1', '3+', 'Advanced Mid', 'N2'"
|
|
559
|
+
}
|
|
560
|
+
}
|
|
561
|
+
},
|
|
492
562
|
"custom": {
|
|
493
563
|
"$ref": "#/definitions/custom"
|
|
494
564
|
}
|
|
@@ -616,6 +686,13 @@
|
|
|
616
686
|
"type": "string",
|
|
617
687
|
"description": " e.g. 'volunteering', 'presentation', 'talk', 'application', 'conference'"
|
|
618
688
|
},
|
|
689
|
+
"skills": {
|
|
690
|
+
"type": "array",
|
|
691
|
+
"description": "Skills used in this project, naming or repeating entries of the top-level skills list, so a skill can point to where it was used (#313)",
|
|
692
|
+
"items": {
|
|
693
|
+
"$ref": "#/definitions/skillReference"
|
|
694
|
+
}
|
|
695
|
+
},
|
|
619
696
|
"custom": {
|
|
620
697
|
"$ref": "#/definitions/custom"
|
|
621
698
|
}
|