84b1d89a80
This patch fixes the format and content of the api-ref documentation for
the build-info, resource-type-{list|template|schema}, versions APIs.
Major changes include:
- use status code table to show response codes
- add missing response parameters such as request id
- fixed cases where the response format was not clearly/correctly
documented.
Change-Id: Id7ac58ff19d3f7a0feb4d872efa7b46c01fa8f4b
58 lines
1.8 KiB
JSON
58 lines
1.8 KiB
JSON
{
|
|
"Description": "Initial template of KeyPair",
|
|
"HeatTemplateFormatVersion": "2012-12-12",
|
|
"Outputs": {
|
|
"private_key": {
|
|
"Description": "The private key if it has been saved.",
|
|
"Value": "{\"Fn::GetAtt\": [\"KeyPair\", \"private_key\"]}"
|
|
},
|
|
"public_key": {
|
|
"Description": "The public key.",
|
|
"Value": "{\"Fn::GetAtt\": [\"KeyPair\", \"public_key\"]}"
|
|
},
|
|
"show": {
|
|
"Description": "Detailed information about resource.",
|
|
"Value": "{\"Fn::GetAtt\": [\"KeyPair\", \"show\"]}"
|
|
}
|
|
},
|
|
"Parameters": {
|
|
"name": {
|
|
"Description": "The name of the key pair.",
|
|
"MaxLength": 255,
|
|
"MinLength": 1,
|
|
"Type": "String"
|
|
},
|
|
"public_key": {
|
|
"Description": "The optional public key. This allows users to supply the public key from a pre-existing key pair. If not supplied, a new key pair will be generated.",
|
|
"Type": "String"
|
|
},
|
|
"save_private_key": {
|
|
"AllowedValues": [
|
|
"True",
|
|
"true",
|
|
"False",
|
|
"false"
|
|
],
|
|
"Default": false,
|
|
"Description": "True if the system should remember a generated private key; False otherwise.",
|
|
"Type": "Boolean"
|
|
}
|
|
},
|
|
"Resources": {
|
|
"KeyPair": {
|
|
"Properties": {
|
|
"name": {
|
|
"Ref": "name"
|
|
},
|
|
"public_key": {
|
|
"Ref": "public_key"
|
|
},
|
|
"save_private_key": {
|
|
"Ref": "save_private_key"
|
|
}
|
|
},
|
|
"Type": "OS::Nova::KeyPair"
|
|
}
|
|
}
|
|
}
|