Skip to content

Commit c6a5a93

Browse files
mcdurdinmcdurdin
authored
Merge pull request #308 from keymanapp/docs/schema-model_info
docs: add .model_info 2.0 schema
2 parents ca0c985 + a9c9133 commit c6a5a93

5 files changed

Lines changed: 101 additions & 8 deletions

File tree

‎schemas/.htaccess‎

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,35 @@
22
# versioned schema files rather than to the base, so we will not add extra
33
# redirects here for new schemas
44

5+
6+
# keyboard_info.schema.json (deprecates keyboard_info.source.json, keyboard_info.distribution.json)
7+
RewriteRule "^keyboard_info\.schema\.json$" "/schemas/keyboard_info/2.0/keyboard_info.schema.json" [END]
8+
59
# keyboard_info.distribution.json (deprecated by keyboard_info.schema.json)
610
RewriteRule "^keyboard_info\.distribution\.json$" "/schemas/keyboard_info.distribution/1.0.6/keyboard_info.distribution.json" [END]
711

812
# keyboard_info.source.json (deprecated by keyboard_info.schema.json)
913
RewriteRule "^keyboard_info\.source\.json$" "/schemas/keyboard_info.source/1.0.6/keyboard_info.source.json" [END]
1014

15+
1116
# keyboard_json.json
1217
RewriteRule "^keyboard_json\.json$" "/schemas/keyboard_json/1.0/keyboard_json.json" [END]
1318

14-
# model_info.distribution.json"
19+
20+
# model_info.schema.json (deprecates model_info.source.json, model_info.distribution.json)
21+
RewriteRule "^model_info\.schema\.json$" "/schemas/model_info/2.0/model_info.schema.json" [END]
22+
23+
# model_info.distribution.json" (deprecated by model_info.schema.json)
1524
RewriteRule "^model_info\.distribution\.json$" "/schemas/model_info.distribution/1.0.1/model_info.distribution.json" [END]
1625

17-
# model_info.source.json
26+
# model_info.source.json (deprecated by model_info.schema.json)
1827
RewriteRule "^model_info\.source\.json$" "/schemas/model_info.source/1.0.1/model_info.source.json" [END]
1928

29+
2030
# model-search.json
2131
RewriteRule "^model-search\.json$" "/schemas/model-search/1.0.1/model-search.json" [END]
2232

33+
2334
# package.json (renamed to kmp.schema.json)
2435

2536
# note: package.json has been renamed to kmp.schema.json to reduce confusion with
@@ -31,14 +42,18 @@ RewriteRule "^package/1\.0\.1/package\.json$" "/schemas/kmp/1.0.1/kmp.schema.jso
3142
RewriteRule "^package/1\.0\.2/package\.json$" "/schemas/kmp/1.0.2/kmp.schema.json" [END]
3243
RewriteRule "^package/1\.1\.0/package\.json$" "/schemas/kmp/1.1.0/kmp.schema.json" [END]
3344

45+
3446
# package-version.json
3547
RewriteRule "^package-version\.json$" "/schemas/package-version/1.0.1/package-version.json" [END]
3648

49+
3750
# search.json
3851
RewriteRule "^search\.json$" "/schemas/search/3.0/search.json" [END]
3952

53+
4054
# version.json
4155
RewriteRule "^version\.json$" "/schemas/version/2.0/version.json" [END]
4256

57+
4358
# windows-update.json
4459
RewriteRule "^windows-update\.json$" "/schemas/windows-update/17.0/windows-update.json" [END]

‎schemas/model_info.distribution/README.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# model_info
22

3+
Deprecated: see [model_info/README.md](../model_info/README.md)
4+
35
* model_info.source.json
46
* model_info.distribution.json
57

68
Documentation at https://help.keyman.com/developer/cloud/model_info
79

8-
## 2019-01-31 1.0 beta
9-
* Initial version, seeded from .keyboard_info specification
10-
1110
## 2020-09-21 1.0.1
1211
* Relaxed the URL definitions in the schema so extension is no longer tested
12+
13+
## 2019-01-31 1.0 beta
14+
* Initial version, seeded from .keyboard_info specification

‎schemas/model_info.source/README.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# model_info
22

3+
Deprecated: see [model_info/README.md](../model_info/README.md)
4+
35
* model_info.source.json
46
* model_info.distribution.json
57

68
Documentation at https://help.keyman.com/developer/cloud/model_info
79

8-
## 2019-01-31 1.0 beta
9-
* Initial version, seeded from .keyboard_info specification
10-
1110
## 2020-09-21 1.0.1
1211
* Relaxed the URL definitions in the schema so extension is no longer tested
12+
13+
## 2019-01-31 1.0 beta
14+
* Initial version, seeded from .keyboard_info specification

‎schemas/model_info/2.0/model_info.schema.json‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
{
2+
"$schema": "http://json-schema.org/schema#",
3+
"$ref": "#/definitions/ModelInfo",
4+
5+
"definitions": {
6+
"ModelInfo": {
7+
"type": "object",
8+
"properties": {
9+
"id": { "type": "string" },
10+
"name": { "type": "string" },
11+
"authorName": { "type": "string" },
12+
"authorEmail": { "type": "string", "format": "email" },
13+
"description": { "type": "string" },
14+
"license": { "type": "string", "enum": ["mit"] },
15+
"languages": { "type": "array", "items": { "type": "string" }, "uniqueItems": true },
16+
"lastModifiedDate": { "type": "string", "format": "date-time" },
17+
"packageFilename": { "type": "string" },
18+
"packageFileSize": { "type": "number" },
19+
"jsFilename": { "type": "string" },
20+
"jsFileSize": { "type": "number" },
21+
"isRTL": { "type": "boolean" },
22+
"packageIncludes": { "type": "array", "items": { "type": "string", "enum": ["fonts"] }, "additionalItems": false },
23+
"version": { "type": "string" },
24+
"minKeymanVersion": { "type": "string", "pattern": "^\\d+\\.0$" },
25+
"helpLink": { "type": "string", "pattern": "^http(s)?://help\\.keyman(-staging)?\\.com(.localhost)?/model/" },
26+
"sourcePath": { "type": "string", "pattern": "^(release|experimental)/.+/.+$" },
27+
"related": { "type": "object", "patternProperties": {
28+
".": { "$ref": "#/definitions/ModelRelatedInfo" }
29+
},
30+
"additionalProperties": false
31+
}
32+
},
33+
"required": [
34+
"license", "languages"
35+
],
36+
"additionalProperties": false
37+
},
38+
39+
"ModelRelatedInfo": {
40+
"type": "object",
41+
"properties": {
42+
"deprecates": { "type": "boolean" },
43+
"deprecatedBy": { "type": "boolean" }
44+
},
45+
"required": [],
46+
"additionalProperties": false
47+
}
48+
}
49+
}

‎schemas/model_info/README.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# model_info
2+
3+
* **model_info.schema.json**
4+
5+
Documentation at https://help.keyman.com/developer/cloud/model_info
6+
7+
* Primary version:
8+
* https://github.com/keymanapp/api.keyman.com/tree/master/schemas/model_info
9+
* Synchronized copies at:
10+
* https://github.com/keymanapp/keyman/tree/master/common/schemas/model_info
11+
12+
# .model_info version history
13+
14+
## 2023-08-11 2.0 stable
15+
* Removed:
16+
`.links`
17+
`.related[].note`
18+
- Source .model_info files are no longer needed, so source vs distribution
19+
model_info distinction is removed
20+
21+
## 2020-09-21 1.0.1
22+
* Relaxed the URL definitions in the schema so extension is no longer tested
23+
24+
## 2019-01-31 1.0 beta
25+
* Initial version, seeded from .keyboard_info specification

0 commit comments

Comments
 (0)