| 1 |
{ |
| 2 |
"$defs": { |
| 3 |
"plugin-descriptions": { |
| 4 |
"items": { |
| 5 |
"properties": { |
| 6 |
"description": { |
| 7 |
"markdownDescription": "Value of `short_description` from plugin `DOCUMENTATION`.", |
| 8 |
"title": "Description", |
| 9 |
"type": "string" |
| 10 |
}, |
| 11 |
"name": { |
| 12 |
"markdownDescription": "It must not be the FQCN, but the name inside the collection.", |
| 13 |
"pattern": "[a-zA-Z0-9_]+", |
| 14 |
"title": "Name", |
| 15 |
"type": "string" |
| 16 |
}, |
| 17 |
"namespace": { |
| 18 |
"type": "null" |
| 19 |
} |
| 20 |
}, |
| 21 |
"type": "object" |
| 22 |
}, |
| 23 |
"type": "array" |
| 24 |
}, |
| 25 |
"release": { |
| 26 |
"additionalProperties": false, |
| 27 |
"properties": { |
| 28 |
"changes": { |
| 29 |
"additionalProperties": true, |
| 30 |
"properties": { |
| 31 |
"breaking_changes": { |
| 32 |
"items": { |
| 33 |
"type": "string" |
| 34 |
}, |
| 35 |
"type": "array" |
| 36 |
}, |
| 37 |
"bugfixes": { |
| 38 |
"items": { |
| 39 |
"type": "string" |
| 40 |
}, |
| 41 |
"type": "array" |
| 42 |
}, |
| 43 |
"deprecated_features": { |
| 44 |
"items": { |
| 45 |
"type": "string" |
| 46 |
}, |
| 47 |
"type": "array" |
| 48 |
}, |
| 49 |
"known_issues": { |
| 50 |
"items": { |
| 51 |
"type": "string" |
| 52 |
}, |
| 53 |
"type": "array" |
| 54 |
}, |
| 55 |
"major_changes": { |
| 56 |
"items": { |
| 57 |
"type": "string" |
| 58 |
}, |
| 59 |
"type": "array" |
| 60 |
}, |
| 61 |
"minor_changes": { |
| 62 |
"items": { |
| 63 |
"type": "string" |
| 64 |
}, |
| 65 |
"type": "array" |
| 66 |
}, |
| 67 |
"release_summary": { |
| 68 |
"markdownDescription": "This must be valid [reStructuredText](https://en.wikipedia.org/wiki/ReStructuredText).", |
| 69 |
"title": "Release Summary", |
| 70 |
"type": "string" |
| 71 |
}, |
| 72 |
"removed_features": { |
| 73 |
"items": { |
| 74 |
"type": "string" |
| 75 |
}, |
| 76 |
"type": "array" |
| 77 |
}, |
| 78 |
"security_fixes": { |
| 79 |
"items": { |
| 80 |
"type": "string" |
| 81 |
}, |
| 82 |
"type": "array" |
| 83 |
}, |
| 84 |
"trivial": { |
| 85 |
"items": { |
| 86 |
"type": "string" |
| 87 |
}, |
| 88 |
"type": "array" |
| 89 |
} |
| 90 |
}, |
| 91 |
"type": "object" |
| 92 |
}, |
| 93 |
"codename": { |
| 94 |
"type": "string" |
| 95 |
}, |
| 96 |
"fragments": { |
| 97 |
"items": { |
| 98 |
"type": "string" |
| 99 |
}, |
| 100 |
"markdownDescription": "List of strings representing filenames of changelog fragments.", |
| 101 |
"type": "array" |
| 102 |
}, |
| 103 |
"modules": { |
| 104 |
"items": { |
| 105 |
"properties": { |
| 106 |
"description": { |
| 107 |
"markdownDescription": "Value of `short_description` from plugin `DOCUMENTATION`.", |
| 108 |
"title": "Description", |
| 109 |
"type": "string" |
| 110 |
}, |
| 111 |
"name": { |
| 112 |
"markdownDescription": "It must not be the FQCN, but the name inside the collection.", |
| 113 |
"pattern": "[a-zA-Z0-9_]+", |
| 114 |
"title": "Short module name", |
| 115 |
"type": "string" |
| 116 |
}, |
| 117 |
"namespace": { |
| 118 |
"markdownDescription": "Must be `''` for modules directly in `plugins/modules/`, or the dot-separated list of directories the module is in inside the `plugins/modules/` directory. The namespace is used to group new modules by their namespace inside the collection.", |
| 119 |
"title": "Namespace", |
| 120 |
"type": "string" |
| 121 |
} |
| 122 |
}, |
| 123 |
"type": "object" |
| 124 |
}, |
| 125 |
"type": "array" |
| 126 |
}, |
| 127 |
"objects": { |
| 128 |
"additionalProperties": false, |
| 129 |
"properties": { |
| 130 |
"playbook": { |
| 131 |
"items": { |
| 132 |
"properties": { |
| 133 |
"description": { |
| 134 |
"markdownDescription": "A short description of what the playbook does.", |
| 135 |
"title": "Description", |
| 136 |
"type": "string" |
| 137 |
}, |
| 138 |
"name": { |
| 139 |
"markdownDescription": "It must not be the FQCN, but the name inside the collection.", |
| 140 |
"pattern": "[a-zA-Z0-9_]+", |
| 141 |
"title": "Short playbook name", |
| 142 |
"type": "string" |
| 143 |
}, |
| 144 |
"namespace": { |
| 145 |
"type": "null" |
| 146 |
} |
| 147 |
}, |
| 148 |
"type": "object" |
| 149 |
}, |
| 150 |
"type": "array" |
| 151 |
}, |
| 152 |
"role": { |
| 153 |
"items": { |
| 154 |
"properties": { |
| 155 |
"description": { |
| 156 |
"markdownDescription": "Value of `short_description` from role's argument spec.", |
| 157 |
"title": "Description", |
| 158 |
"type": "string" |
| 159 |
}, |
| 160 |
"name": { |
| 161 |
"markdownDescription": "It must not be the FQCN, but the name inside the collection.", |
| 162 |
"pattern": "[a-zA-Z0-9_]+", |
| 163 |
"title": "Short role name", |
| 164 |
"type": "string" |
| 165 |
}, |
| 166 |
"namespace": { |
| 167 |
"type": "null" |
| 168 |
} |
| 169 |
}, |
| 170 |
"type": "object" |
| 171 |
}, |
| 172 |
"type": "array" |
| 173 |
} |
| 174 |
}, |
| 175 |
"type": "object" |
| 176 |
}, |
| 177 |
"plugins": { |
| 178 |
"additionalProperties": false, |
| 179 |
"properties": { |
| 180 |
"become": { |
| 181 |
"$ref": "#/$defs/plugin-descriptions" |
| 182 |
}, |
| 183 |
"cache": { |
| 184 |
"$ref": "#/$defs/plugin-descriptions" |
| 185 |
}, |
| 186 |
"callback": { |
| 187 |
"$ref": "#/$defs/plugin-descriptions" |
| 188 |
}, |
| 189 |
"cliconf": { |
| 190 |
"$ref": "#/$defs/plugin-descriptions" |
| 191 |
}, |
| 192 |
"connection": { |
| 193 |
"$ref": "#/$defs/plugin-descriptions" |
| 194 |
}, |
| 195 |
"filter": { |
| 196 |
"$ref": "#/$defs/plugin-descriptions" |
| 197 |
}, |
| 198 |
"httpapi": { |
| 199 |
"$ref": "#/$defs/plugin-descriptions" |
| 200 |
}, |
| 201 |
"inventory": { |
| 202 |
"$ref": "#/$defs/plugin-descriptions" |
| 203 |
}, |
| 204 |
"lookup": { |
| 205 |
"$ref": "#/$defs/plugin-descriptions" |
| 206 |
}, |
| 207 |
"netconf": { |
| 208 |
"$ref": "#/$defs/plugin-descriptions" |
| 209 |
}, |
| 210 |
"shell": { |
| 211 |
"$ref": "#/$defs/plugin-descriptions" |
| 212 |
}, |
| 213 |
"strategy": { |
| 214 |
"$ref": "#/$defs/plugin-descriptions" |
| 215 |
}, |
| 216 |
"test": { |
| 217 |
"$ref": "#/$defs/plugin-descriptions" |
| 218 |
}, |
| 219 |
"vars": { |
| 220 |
"$ref": "#/$defs/plugin-descriptions" |
| 221 |
} |
| 222 |
}, |
| 223 |
"type": "object" |
| 224 |
}, |
| 225 |
"release_date": { |
| 226 |
"format": "date", |
| 227 |
"markdownDescription": "Use ISO-8601 date format, like 2020-12-31", |
| 228 |
"pattern": "\\d\\d\\d\\d-\\d\\d-\\d\\d", |
| 229 |
"title": "Date of the release.", |
| 230 |
"type": "string" |
| 231 |
} |
| 232 |
}, |
| 233 |
"type": "object" |
| 234 |
}, |
| 235 |
"semver": { |
| 236 |
"pattern": "\\d+.\\d+.\\d+.*", |
| 237 |
"title": "Version string following SemVer specification.", |
| 238 |
"type": ["string", "null"] |
| 239 |
} |
| 240 |
}, |
| 241 |
"$id": "https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/changelog.json", |
| 242 |
"$schema": "http://json-schema.org/draft-07/schema", |
| 243 |
"additionalProperties": false, |
| 244 |
"examples": ["changelogs/changelog.yaml"], |
| 245 |
"markdownDescription": "Antsibull Changelog Schema is based on [changelog.yaml-format.md](https://github.com/ansible-community/antsibull-changelog/blob/main/docs/changelog.yaml-format.md).", |
| 246 |
"properties": { |
| 247 |
"ancestor": { |
| 248 |
"$ref": "#/$defs/semver" |
| 249 |
}, |
| 250 |
"releases": { |
| 251 |
"patternProperties": { |
| 252 |
"\\d+.\\d+.\\d+.*": { |
| 253 |
"$ref": "#/$defs/release", |
| 254 |
"type": "object" |
| 255 |
} |
| 256 |
}, |
| 257 |
"type": "object" |
| 258 |
} |
| 259 |
}, |
| 260 |
"title": "Antsibull Changelog Schema", |
| 261 |
"type": "object" |
| 262 |
} |