Merge "API ref: Update sample output of resource type APIs"
This commit is contained in:
Zuul
Gerrit Code Review
commit
a0ee275ebe
@ -1,7 +1,8 @@
|
||||
{
|
||||
"attributes": {
|
||||
"an_attribute": {
|
||||
"description": "A runtime value of the resource."
|
||||
"description": "A runtime value of the resource.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"properties": {
|
||||
@ -15,16 +16,17 @@
|
||||
}
|
||||
}
|
||||
],
|
||||
"description": "A resource description.",
|
||||
"description": "A resource property description.",
|
||||
"required": true,
|
||||
"type": "string",
|
||||
"update_allowed": false
|
||||
"update_allowed": false,
|
||||
"immutable": false
|
||||
}
|
||||
},
|
||||
"resource_type": "OS::Heat::AResourceName",
|
||||
"support_status": {
|
||||
"message": "A status message",
|
||||
"status": "SUPPORTED",
|
||||
"version": "2014.1"
|
||||
"version": "10.0.0"
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,22 +1,38 @@
|
||||
{
|
||||
"description": "Initial template of KeyPair",
|
||||
"heat_template_version": "2016-10-14",
|
||||
"outputs": {
|
||||
"private_key": {
|
||||
"description": "The private key if it has been saved.",
|
||||
"value": "{\"get_attr\": [\"KeyPair\", \"private_key\"]}"
|
||||
},
|
||||
"public_key": {
|
||||
"description": "The public key.",
|
||||
"value": "{\"get_attr\": [\"KeyPair\", \"public_key\"]}"
|
||||
},
|
||||
"show": {
|
||||
"description": "Detailed information about resource.",
|
||||
"value": "{\"get_attr\": [\"KeyPair\", \"show\"]}"
|
||||
}
|
||||
},
|
||||
"description": "Initial template of KeyPair",
|
||||
"parameters": {
|
||||
"public_key": {
|
||||
"type": "string",
|
||||
"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."
|
||||
},
|
||||
"save_private_key": {
|
||||
"default": false,
|
||||
"type": "boolean",
|
||||
"description": "True if the system should remember a generated private key; False otherwise."
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"description": "Keypair type. Supported since Nova api version 2.2.",
|
||||
"constraints": [
|
||||
{
|
||||
"allowed_values": [
|
||||
"ssh",
|
||||
"x509"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"user": {
|
||||
"type": "string",
|
||||
"description": "ID or name of user to whom to add key-pair. The usage of this property is limited to being used by administrators only. Supported since Nova api version 2.10.",
|
||||
"constraints": [
|
||||
{}
|
||||
]
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The name of the key pair.",
|
||||
"constraints": [
|
||||
{
|
||||
"length": {
|
||||
@ -24,34 +40,63 @@
|
||||
"min": 1
|
||||
}
|
||||
}
|
||||
],
|
||||
"description": "The name of the key pair.",
|
||||
"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": {
|
||||
"default": false,
|
||||
"description": "True if the system should remember a generated private key; False otherwise.",
|
||||
"type": "boolean"
|
||||
]
|
||||
}
|
||||
},
|
||||
"resources": {
|
||||
"KeyPair": {
|
||||
"type": "OS::Nova::KeyPair",
|
||||
"properties": {
|
||||
"name": {
|
||||
"get_param": "name"
|
||||
},
|
||||
"public_key": {
|
||||
"get_param": "public_key"
|
||||
},
|
||||
"save_private_key": {
|
||||
"get_param": "save_private_key"
|
||||
},
|
||||
"type": {
|
||||
"get_param": "type"
|
||||
},
|
||||
"user": {
|
||||
"get_param": "user"
|
||||
},
|
||||
"name": {
|
||||
"get_param": "name"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"type": "OS::Nova::KeyPair"
|
||||
"outputs": {
|
||||
"public_key": {
|
||||
"description": "The public key.",
|
||||
"value": {
|
||||
"get_attr": [
|
||||
"KeyPair",
|
||||
"public_key"
|
||||
]
|
||||
}
|
||||
},
|
||||
"private_key": {
|
||||
"description": "The private key if it has been saved.",
|
||||
"value": {
|
||||
"get_attr": [
|
||||
"KeyPair",
|
||||
"private_key"
|
||||
]
|
||||
}
|
||||
},
|
||||
"OS::stack_id": {
|
||||
"value": {
|
||||
"get_resource": "KeyPair"
|
||||
}
|
||||
},
|
||||
"show": {
|
||||
"description": "Detailed information about resource.",
|
||||
"value": {
|
||||
"get_attr": [
|
||||
"KeyPair",
|
||||
"show"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,57 +1,95 @@
|
||||
{
|
||||
"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\"]}"
|
||||
}
|
||||
},
|
||||
"Description": "Initial template of KeyPair",
|
||||
"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"
|
||||
"Type": "String",
|
||||
"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."
|
||||
},
|
||||
"save_private_key": {
|
||||
"Default": false,
|
||||
"Type": "Boolean",
|
||||
"Description": "True if the system should remember a generated private key; False otherwise.",
|
||||
"AllowedValues": [
|
||||
"True",
|
||||
"true",
|
||||
"False",
|
||||
"false"
|
||||
],
|
||||
"Default": false,
|
||||
"Description": "True if the system should remember a generated private key; False otherwise.",
|
||||
"Type": "Boolean"
|
||||
]
|
||||
},
|
||||
"type": {
|
||||
"Type": "String",
|
||||
"Description": "Keypair type. Supported since Nova api version 2.2.",
|
||||
"AllowedValues": [
|
||||
"ssh",
|
||||
"x509"
|
||||
]
|
||||
},
|
||||
"user": {
|
||||
"Type": "String",
|
||||
"Description": "ID or name of user to whom to add key-pair. The usage of this property is limited to being used by administrators only. Supported since Nova api version 2.10."
|
||||
},
|
||||
"name": {
|
||||
"MinLength": 1,
|
||||
"Type": "String",
|
||||
"Description": "The name of the key pair.",
|
||||
"MaxLength": 255
|
||||
}
|
||||
},
|
||||
"Resources": {
|
||||
"KeyPair": {
|
||||
"Type": "OS::Nova::KeyPair",
|
||||
"Properties": {
|
||||
"name": {
|
||||
"Ref": "name"
|
||||
},
|
||||
"public_key": {
|
||||
"Ref": "public_key"
|
||||
},
|
||||
"save_private_key": {
|
||||
"Ref": "save_private_key"
|
||||
},
|
||||
"type": {
|
||||
"Ref": "type"
|
||||
},
|
||||
"user": {
|
||||
"Ref": "user"
|
||||
},
|
||||
"name": {
|
||||
"Ref": "name"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"Type": "OS::Nova::KeyPair"
|
||||
"Outputs": {
|
||||
"public_key": {
|
||||
"Description": "The public key.",
|
||||
"Value": {
|
||||
"Fn::GetAtt": [
|
||||
"KeyPair",
|
||||
"public_key"
|
||||
]
|
||||
}
|
||||
},
|
||||
"private_key": {
|
||||
"Description": "The private key if it has been saved.",
|
||||
"Value": {
|
||||
"Fn::GetAtt": [
|
||||
"KeyPair",
|
||||
"private_key"
|
||||
]
|
||||
}
|
||||
},
|
||||
"OS::stack_id": {
|
||||
"Value": {
|
||||
"Ref": "KeyPair"
|
||||
}
|
||||
},
|
||||
"show": {
|
||||
"Description": "Detailed information about resource.",
|
||||
"Value": {
|
||||
"Fn::GetAtt": [
|
||||
"KeyPair",
|
||||
"show"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user