Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions schemas/.htaccess
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,35 @@
# versioned schema files rather than to the base, so we will not add extra
# redirects here for new schemas


# keyboard_info.schema.json (deprecates keyboard_info.source.json, keyboard_info.distribution.json)
RewriteRule "^keyboard_info\.schema\.json$" "/schemas/keyboard_info/2.0/keyboard_info.schema.json" [END]

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

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


# keyboard_json.json
RewriteRule "^keyboard_json\.json$" "/schemas/keyboard_json/1.0/keyboard_json.json" [END]

# model_info.distribution.json"

# model_info.schema.json (deprecates model_info.source.json, model_info.distribution.json)
RewriteRule "^model_info\.schema\.json$" "/schemas/model_info/2.0/model_info.schema.json" [END]

# model_info.distribution.json" (deprecated by model_info.schema.json)
RewriteRule "^model_info\.distribution\.json$" "/schemas/model_info.distribution/1.0.1/model_info.distribution.json" [END]

# model_info.source.json
# model_info.source.json (deprecated by model_info.schema.json)
RewriteRule "^model_info\.source\.json$" "/schemas/model_info.source/1.0.1/model_info.source.json" [END]


# model-search.json
RewriteRule "^model-search\.json$" "/schemas/model-search/1.0.1/model-search.json" [END]


# package.json (renamed to kmp.schema.json)

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


# package-version.json
RewriteRule "^package-version\.json$" "/schemas/package-version/1.0.1/package-version.json" [END]


# search.json
RewriteRule "^search\.json$" "/schemas/search/3.0/search.json" [END]


# version.json
RewriteRule "^version\.json$" "/schemas/version/2.0/version.json" [END]


# windows-update.json
RewriteRule "^windows-update\.json$" "/schemas/windows-update/17.0/windows-update.json" [END]
8 changes: 5 additions & 3 deletions schemas/model_info.distribution/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# model_info

Deprecated: see [model_info/README.md](../model_info/README.md)

* model_info.source.json
* model_info.distribution.json

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

## 2019-01-31 1.0 beta
* Initial version, seeded from .keyboard_info specification

## 2020-09-21 1.0.1
* Relaxed the URL definitions in the schema so extension is no longer tested

## 2019-01-31 1.0 beta
* Initial version, seeded from .keyboard_info specification
8 changes: 5 additions & 3 deletions schemas/model_info.source/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# model_info

Deprecated: see [model_info/README.md](../model_info/README.md)

* model_info.source.json
* model_info.distribution.json

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

## 2019-01-31 1.0 beta
* Initial version, seeded from .keyboard_info specification

## 2020-09-21 1.0.1
* Relaxed the URL definitions in the schema so extension is no longer tested

## 2019-01-31 1.0 beta
* Initial version, seeded from .keyboard_info specification
49 changes: 49 additions & 0 deletions schemas/model_info/2.0/model_info.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
{
"$schema": "http://json-schema.org/schema#",
"$ref": "#/definitions/ModelInfo",

"definitions": {
"ModelInfo": {
"type": "object",
"properties": {
"id": { "type": "string" },
"name": { "type": "string" },
"authorName": { "type": "string" },
"authorEmail": { "type": "string", "format": "email" },
"description": { "type": "string" },
"license": { "type": "string", "enum": ["mit"] },
"languages": { "type": "array", "items": { "type": "string" }, "uniqueItems": true },
"lastModifiedDate": { "type": "string", "format": "date-time" },
"packageFilename": { "type": "string" },
"packageFileSize": { "type": "number" },
"jsFilename": { "type": "string" },
"jsFileSize": { "type": "number" },
"isRTL": { "type": "boolean" },
"packageIncludes": { "type": "array", "items": { "type": "string", "enum": ["fonts"] }, "additionalItems": false },
"version": { "type": "string" },
"minKeymanVersion": { "type": "string", "pattern": "^\\d+\\.0$" },
"helpLink": { "type": "string", "pattern": "^http(s)?://help\\.keyman(-staging)?\\.com(.localhost)?/model/" },
"sourcePath": { "type": "string", "pattern": "^(release|experimental)/.+/.+$" },
"related": { "type": "object", "patternProperties": {
".": { "$ref": "#/definitions/ModelRelatedInfo" }
},
"additionalProperties": false
}
},
"required": [
"license", "languages"
],
"additionalProperties": false
},

"ModelRelatedInfo": {
"type": "object",
"properties": {
"deprecates": { "type": "boolean" },
"deprecatedBy": { "type": "boolean" }
},
"required": [],
"additionalProperties": false
}
}
}
25 changes: 25 additions & 0 deletions schemas/model_info/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# model_info

* **model_info.schema.json**

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

* Primary version:
* https://github.com/keymanapp/api.keyman.com/tree/master/schemas/model_info
* Synchronized copies at:
* https://github.com/keymanapp/keyman/tree/master/common/schemas/model_info

# .model_info version history

## 2023-08-11 2.0 stable
* Removed:
`.links`
`.related[].note`
- Source .model_info files are no longer needed, so source vs distribution
model_info distinction is removed

## 2020-09-21 1.0.1
* Relaxed the URL definitions in the schema so extension is no longer tested

## 2019-01-31 1.0 beta
* Initial version, seeded from .keyboard_info specification