codify-schemas/src/messages/get-resource-info-response-data-schema.json at b220ad3a776f046b1911515b748cfaf4dc7c77ac · codifycli/codify-schemas · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
{
  "$schema": "http://json-schema.org/draft-07/schema",
  "$id": "https://www.codifycli.com/get-resource-info-response-data-schema.json",
  "title": "Get Resource Info Schema",
  "type": "object",
  "properties": {
    "plugin": {
      "type": "string",
      "description": "The plugin the resource is from"
    },
    "type": {
      "type": "string",
      "description": "The id/type of the resource"
    },
    "schema": {
      "type": "object",
      "description": "The JSON Schema validation schema for the resource."
    },
    "dependencies": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "operatingSystems": {
      "type": "array",
      "items": {
        "enum": ["Darwin", "Linux", "Windows_NT"]
      }
    },
    "linuxDistros": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "The Linux distros the resource is compatible with"
      }
    },
    "import": {
      "type": "object",
      "properties": {
        "requiredProperties": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "importAndDestroy": {
      "type": "object",
      "properties": {
        "requiredParameters": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "A list of properties that are required for importing and destroying a resource"
        },
        "preventImport": {
          "type": "boolean",
          "description": "Controls whether a resource can be imported. For example: action resources cannot be imported"
        }
      }
    },
    "sensitiveParameters": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "allowMultiple": {
      "type": "boolean"
    },
    "defaultConfig": {
      "type": "object",
      "description": "The default config that should be added. This prefills some parameters for the user to make it easier for them"
    },
    "exampleConfigs": {
      "type": "object",
      "description": "Some example configs. This makes it for the user."
    }
  },
  "required": ["type", "plugin"]
}