service-types-authority/schema.json
Monty Taylor 4b1fa0e4a5 Remove leading openstack/ from project name
The leading openstack/ is repetitive. There are zero chances anything
will make it into this file without a leading openstack/.

We're not actually using project for anything yet, but we want to use
it for both validation of documentation locations as well as being able
to send legacy-style microversion headers. Rather than removing the
openstack/ at processing time, remove it in the data.

Change-Id: I740af4211dcf142865f1fe70fec41ab5ae73d0e3
2017-07-17 18:23:54 +00:00

58 lines
1.9 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-]*[a-z]+|ec2-api)$",
"description": "The unique identifier for the service to be used in the service catalog"
},
"project": {
"type":"string",
"pattern":"^([a-z][a-z-]*[a-z]+|ec2-api)$",
"description": "The OpenStack project name 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."
},
"api_reference_project": {
"type":"string",
"description": "Project where API reference is found, if not the same as the main project"
},
"description": {
"type":"string",
"description": "A short description about the service in question."
},
"aliases": {
"type": "array",
"items": {
"type": "string"
},
"description": "An ordered list of historical aliases for this service type."
}
},
"additionalProperties":false,
"required":[
"api_reference",
"project",
"service_type"
]
}
}
}