Просмотр исходного кода

Added friendly descriptions to json schema

alex.kopachov 2 лет назад
Родитель
Сommit
35832a9b72
1 измененных файлов с 7 добавлено и 0 удалено
  1. 7 0
      docs/firmwares.schema.json

+ 7 - 0
docs/firmwares.schema.json

@@ -12,6 +12,7 @@
           {
           {
             "properties": {
             "properties": {
               "alias": {
               "alias": {
+                "description": "Firmware alias(-es)",
                 "type": "array",
                 "type": "array",
                 "items": {
                 "items": {
                   "type": "string"
                   "type": "string"
@@ -20,9 +21,11 @@
                 "uniqueItems": true
                 "uniqueItems": true
               },
               },
               "description": {
               "description": {
+                "description": "User-friendly description explaining firmware details",
                 "type": "string"
                 "type": "string"
               },
               },
               "type": {
               "type": {
+                "description": "Type of firmware reference. `index` - firmware from index; `git-release` - firmware from gir releases",
                 "enum": [
                 "enum": [
                   "index",
                   "index",
                   "git-release"
                   "git-release"
@@ -51,9 +54,11 @@
                 "then": {
                 "then": {
                   "properties": {
                   "properties": {
                     "index_url": {
                     "index_url": {
+                      "description": "Index URL to look for firmware",
                       "type": "string"
                       "type": "string"
                     },
                     },
                     "channel": {
                     "channel": {
+                      "description": "Index channel to pull firmware from",
                       "type": "string"
                       "type": "string"
                     }
                     }
                   },
                   },
@@ -79,9 +84,11 @@
                 "then": {
                 "then": {
                   "properties": {
                   "properties": {
                     "git_repo": {
                     "git_repo": {
+                      "description": "Firmware Github repo in format `author/repo_name`",
                       "type": "string"
                       "type": "string"
                     },
                     },
                     "git_release": {
                     "git_release": {
+                      "description": "Github release name to pull firmware from",
                       "type": "string"
                       "type": "string"
                     }
                     }
                   },
                   },