4b9b900d1a
Add a jsonschema document and a validation script so that we can gate on conformity. Add docs infrastructure to publish the README, the file and the schema. We can probably make it look nicer later with some sphinx magic. Depends-On: I5eb1503f815440cac2d127c1f1fec1318e894323 Change-Id: I0f5023d28d9344e87db5a01e7fd1f19a427bec4c
54 lines
1.6 KiB
JSON
54 lines
1.6 KiB
JSON
{
|
|
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
"id": "https://specs.openstack.org/openstack/service-types-authority/_downloads/schema.json#",
|
|
"type": "object",
|
|
"required": ["services"],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"services": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/service"
|
|
}
|
|
}
|
|
},
|
|
"definitions":{
|
|
"service":{
|
|
"properties": {
|
|
"service_type": {
|
|
"type":"string",
|
|
"pattern":"^[a-z][a-z-]+$",
|
|
"description": "The unique identifier for the service to be used in the service catalog"
|
|
},
|
|
"project": {
|
|
"type":"string",
|
|
"description": "An OpenStack git project that contains the definition of the API"
|
|
},
|
|
"api_reference": {
|
|
"type":"string",
|
|
"format": "url",
|
|
"description": "A published API reference document for the API identified by this service type."
|
|
},
|
|
"description": {
|
|
"type":"string",
|
|
"description": "A short description about the service in question."
|
|
},
|
|
"aliases": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"pattern": "^[a-z]+$"
|
|
},
|
|
"description": "An ordered list of historical aliases for this service type."
|
|
}
|
|
},
|
|
"additionalProperties":false,
|
|
"required":[
|
|
"api_reference",
|
|
"project",
|
|
"service_type"
|
|
]
|
|
}
|
|
}
|
|
}
|