Skip to content

Commit 9e8e141

Browse files
kevinwang5658kevinwang5658
committed
fix: Fixed title and description not properly for some resources in the schema
1 parent 6cb649b commit 9e8e141

File tree

1 file changed

+71
-99
lines changed

1 file changed

+71
-99
lines changed

‎src/schemastore/codify-schema.json‎

Lines changed: 71 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -225,36 +225,30 @@
225225
"type": "object",
226226
"properties": {
227227
"aliases": {
228-
"description": "aliases resource. Can be used to manage aliases",
228+
"description": "Aliases to create",
229229
"type": "array",
230230
"items": {
231231
"type": "object",
232232
"properties": {
233233
"alias": {
234-
"type": "string",
235-
"title": "aliases",
236-
"description": "aliases resource. Can be used to manage aliases"
234+
"description": "The name of the alias",
235+
"type": "string"
237236
},
238237
"value": {
239-
"type": "string",
240-
"title": "aliases",
241-
"description": "aliases resource. Can be used to manage aliases"
238+
"description": "The alias value",
239+
"type": "string"
242240
}
243241
},
244242
"required": [
245243
"alias",
246244
"value"
247245
],
248-
"additionalProperties": false,
249-
"title": "aliases",
250-
"description": "aliases resource. Can be used to manage aliases"
251-
},
252-
"title": "aliases"
246+
"additionalProperties": false
247+
}
253248
},
254249
"declarationsOnly": {
255-
"type": "boolean",
256-
"title": "aliases",
257-
"description": "aliases resource. Can be used to manage aliases"
250+
"description": "Only plan and manage explicitly declared aliases found in shell startup scripts.",
251+
"type": "boolean"
258252
},
259253
"os": {
260254
"type": "array",
@@ -285,7 +279,8 @@
285279
}
286280
},
287281
"additionalProperties": false,
288-
"description": "aliases resource. Can be used to manage aliases",
282+
"description": "Aliases resource. Can be used to manage multiple aliases",
283+
"$comment": "https://codifycli.com/docs/resources/shell/aliases",
289284
"required": [
290285
"type"
291286
]
@@ -843,14 +838,12 @@
843838
"type": "object",
844839
"properties": {
845840
"version": {
846-
"description": "android-studio resource. Can be used to manage android-studio",
847-
"type": "string",
848-
"title": "android-studio"
841+
"description": "Android studios version. Visit: https://developer.android.com/studio/releases for version info",
842+
"type": "string"
849843
},
850844
"directory": {
851-
"description": "android-studio resource. Can be used to manage android-studio",
852-
"type": "string",
853-
"title": "android-studio"
845+
"description": "The directory to install Android Studios into. Defaults to /Applications",
846+
"type": "string"
854847
},
855848
"os": {
856849
"type": "array",
@@ -882,6 +875,7 @@
882875
},
883876
"additionalProperties": false,
884877
"description": "android-studio resource. Can be used to manage android-studio",
878+
"$comment": "https://codifycli.com/docs/resources/android-studio",
885879
"required": [
886880
"type"
887881
]
@@ -890,14 +884,11 @@
890884
"type": "object",
891885
"properties": {
892886
"plugins": {
893-
"description": "asdf resource. Can be used to manage asdf",
887+
"description": "Asdf plugins to install. See: https://github.com/asdf-community for a full list",
894888
"type": "array",
895889
"items": {
896-
"type": "string",
897-
"title": "asdf",
898-
"description": "asdf resource. Can be used to manage asdf"
899-
},
900-
"title": "asdf"
890+
"type": "string"
891+
}
901892
},
902893
"os": {
903894
"type": "array",
@@ -928,7 +919,8 @@
928919
}
929920
},
930921
"additionalProperties": false,
931-
"description": "asdf resource. Can be used to manage asdf",
922+
"description": "Asdf resource for installing asdf, a tool version manager",
923+
"$comment": "https://codifycli.com/docs/resources/asdf/asdf",
932924
"required": [
933925
"type"
934926
]
@@ -937,24 +929,19 @@
937929
"type": "object",
938930
"properties": {
939931
"plugin": {
940-
"description": "asdf-plugin resource. Can be used to manage asdf-plugin",
941-
"type": "string",
942-
"title": "asdf-plugin"
932+
"description": "Asdf plugin name",
933+
"type": "string"
943934
},
944935
"versions": {
945-
"description": "asdf-plugin resource. Can be used to manage asdf-plugin",
936+
"description": "A list of versions to install",
946937
"type": "array",
947938
"items": {
948-
"type": "string",
949-
"title": "asdf-plugin",
950-
"description": "asdf-plugin resource. Can be used to manage asdf-plugin"
951-
},
952-
"title": "asdf-plugin"
939+
"type": "string"
940+
}
953941
},
954942
"gitUrl": {
955-
"description": "asdf-plugin resource. Can be used to manage asdf-plugin",
956-
"type": "string",
957-
"title": "asdf-plugin"
943+
"description": "The gitUrl of the plugin",
944+
"type": "string"
958945
},
959946
"os": {
960947
"type": "array",
@@ -989,30 +976,26 @@
989976
"type"
990977
],
991978
"additionalProperties": false,
992-
"description": "asdf-plugin resource. Can be used to manage asdf-plugin"
979+
"description": "Asdf plugin resource for installing asdf plugins.",
980+
"$comment": "https://codifycli.com/docs/resources/asdf/asdf-plugin"
993981
},
994982
{
995983
"type": "object",
996984
"properties": {
997985
"plugin": {
998-
"description": "asdf-install resource. Can be used to manage asdf-install",
999-
"type": "string",
1000-
"title": "asdf-install"
986+
"description": "Asdf plugin name",
987+
"type": "string"
1001988
},
1002989
"versions": {
1003-
"description": "asdf-install resource. Can be used to manage asdf-install",
990+
"description": "A list of versions to install",
1004991
"type": "array",
1005992
"items": {
1006-
"type": "string",
1007-
"title": "asdf-install",
1008-
"description": "asdf-install resource. Can be used to manage asdf-install"
1009-
},
1010-
"title": "asdf-install"
993+
"type": "string"
994+
}
1011995
},
1012996
"directory": {
1013-
"description": "asdf-install resource. Can be used to manage asdf-install",
1014-
"type": "string",
1015-
"title": "asdf-install"
997+
"description": "The directory to run the install command",
998+
"type": "string"
1016999
},
10171000
"os": {
10181001
"type": "array",
@@ -1043,7 +1026,8 @@
10431026
}
10441027
},
10451028
"additionalProperties": false,
1046-
"description": "asdf-install resource. Can be used to manage asdf-install",
1029+
"description": "Install specific version of tools using asdf.",
1030+
"$comment": "https://codifycli.com/docs/resources/asdf/asdf-install",
10471031
"required": [
10481032
"type"
10491033
]
@@ -1317,19 +1301,16 @@
13171301
"type": "object",
13181302
"properties": {
13191303
"path": {
1320-
"description": "file resource. Can be used to manage file",
1321-
"type": "string",
1322-
"title": "file"
1304+
"description": "The location of the file.",
1305+
"type": "string"
13231306
},
13241307
"contents": {
1325-
"description": "file resource. Can be used to manage file",
1326-
"type": "string",
1327-
"title": "file"
1308+
"description": "The contents of the file.",
1309+
"type": "string"
13281310
},
13291311
"onlyCreate": {
1330-
"description": "file resource. Can be used to manage file",
1331-
"type": "boolean",
1332-
"title": "file"
1312+
"description": "Forces the resource to only create the file if it doesn't exist but don't detect any content changes.",
1313+
"type": "boolean"
13331314
},
13341315
"os": {
13351316
"type": "array",
@@ -1365,7 +1346,8 @@
13651346
"type"
13661347
],
13671348
"additionalProperties": false,
1368-
"description": "file resource. Can be used to manage file"
1349+
"description": "file resource. Can be used to manage file",
1350+
"$comment": "https://codifycli.com/docs/resources/scripting/file"
13691351
},
13701352
{
13711353
"$comment": "https://codifycli.com/docs/resources/scripting/remote-file/",
@@ -2321,36 +2303,30 @@
23212303
"type": "object",
23222304
"properties": {
23232305
"tartHome": {
2324-
"description": "tart resource. Can be used to manage tart",
2325-
"type": "string",
2326-
"title": "tart"
2306+
"description": "The home directory of tart. This controls where the images are stored. To create this, simply add an entry to the rc file of the shell specifying the TART_HOME environment variable",
2307+
"type": "string"
23272308
},
23282309
"clone": {
2329-
"description": "tart resource. Can be used to manage tart",
2310+
"description": "The image to clone. This is a stateful parameter that controls which images are cloned. Can be a string (clone directly) or an object with sourceName and name.",
23302311
"type": "array",
23312312
"items": {
23322313
"type": "object",
23332314
"properties": {
23342315
"sourceName": {
2335-
"description": "tart resource. Can be used to manage tart",
2336-
"type": "string",
2337-
"title": "tart"
2316+
"description": "The source image to clone from (OCI registry)",
2317+
"type": "string"
23382318
},
23392319
"name": {
2340-
"description": "tart resource. Can be used to manage tart",
2341-
"type": "string",
2342-
"title": "tart"
2320+
"description": "The local name for the cloned image",
2321+
"type": "string"
23432322
}
23442323
},
23452324
"required": [
23462325
"sourceName",
23472326
"name"
23482327
],
2349-
"additionalProperties": false,
2350-
"title": "tart",
2351-
"description": "tart resource. Can be used to manage tart"
2352-
},
2353-
"title": "tart"
2328+
"additionalProperties": false
2329+
}
23542330
},
23552331
"os": {
23562332
"type": "array",
@@ -2382,6 +2358,7 @@
23822358
},
23832359
"additionalProperties": false,
23842360
"description": "tart resource. Can be used to manage tart",
2361+
"$comment": "https://codifycli.com/docs/resources/tart/tart",
23852362
"required": [
23862363
"type"
23872364
]
@@ -2390,34 +2367,28 @@
23902367
"type": "object",
23912368
"properties": {
23922369
"sourceName": {
2393-
"description": "tart-vm resource. Can be used to manage tart-vm",
2394-
"type": "string",
2395-
"title": "tart-vm"
2370+
"description": "The source of the image (an OCI registry)",
2371+
"type": "string"
23962372
},
23972373
"localName": {
2398-
"description": "tart-vm resource. Can be used to manage tart-vm",
2399-
"type": "string",
2400-
"title": "tart-vm"
2374+
"description": "The local name of the image",
2375+
"type": "string"
24012376
},
24022377
"memory": {
2403-
"description": "tart-vm resource. Can be used to manage tart-vm",
2404-
"type": "number",
2405-
"title": "tart-vm"
2378+
"description": "Sets the memory of the vm in MB using tart set <vm-name> --memory",
2379+
"type": "number"
24062380
},
24072381
"cpu": {
2408-
"description": "tart-vm resource. Can be used to manage tart-vm",
2409-
"type": "number",
2410-
"title": "tart-vm"
2382+
"description": "Sets the cpu count of the vm using tart set <vm-name> --cpu",
2383+
"type": "number"
24112384
},
24122385
"display": {
2413-
"description": "tart-vm resource. Can be used to manage tart-vm",
2414-
"type": "string",
2415-
"title": "tart-vm"
2386+
"description": "Sets the display size in format <width>x<height>. For example 1200x800",
2387+
"type": "string"
24162388
},
24172389
"diskSize": {
2418-
"description": "tart-vm resource. Can be used to manage tart-vm",
2419-
"type": "number",
2420-
"title": "tart-vm"
2390+
"description": "The disk size in GB. Disk size can only be increased and not decreased",
2391+
"type": "number"
24212392
},
24222393
"os": {
24232394
"type": "array",
@@ -2453,7 +2424,8 @@
24532424
"type"
24542425
],
24552426
"additionalProperties": false,
2456-
"description": "tart-vm resource. Can be used to manage tart-vm"
2427+
"description": "tart-vm resource. Can be used to manage tart-vm",
2428+
"$comment": "https://codifycli.com/docs/resources/tart/tart-vm"
24572429
}
24582430
]
24592431
}

0 commit comments

Comments
 (0)