openstack/senlin
Code Issues Proposed changes

Updated profile-update api doc

Browse Source
This commit is contained in:
tengqm
2015-03-02 14:18:46 +08:00
parent dec8306c98
commit 88a069a54b
3 changed files with 72 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
doc/api-site/api-ref/src/wadls/clustering-api/src/v1/clustering-api.wadl
View File

@@ -671,12 +671,23 @@ name could be delayed for an unspecified time.</para></note>'>
</param>
<param name="tags" style="plain" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>A list of key-value pairs to be associated with the target profile.</para>
<para>A list of key-value pairs to be associated with the target
profile.</para>
</wadl:doc>
</param>
</representation>
</request>
<response status="202"/>
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>A profile record that contains fields like <code>id</code>,
<code>name</code>, <code>type</code>, <code>spec</code>,
<code>permission</code>, <code>tags</code> etc.
</para>
<xsdxt:code href="samples/profile_update_resp.json"/>
</wadl:doc>
</representation>
</response>
</method>
<method name="DELETE" id="profile_delete">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete profile">

40
doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/profile_update.json
View File

@@ -1,38 +1,8 @@
{
"name": "my_stack_profile",
"permission": "",
"spec": {
"context": {
"region_name": "RegionTwo",
},
"environment": {},
"files": {
"file1": "new contents",
},
"parameters": {
"key_name": "JohnKey",
},
"template": {
"heat_template_version": "2014-10-16",
"parameters": {
"length": {
"type": "integer",
"default": "32",
},
},
"outputs": {
"random_value": {
"value": {
"get_attr": ["random1", "value"],
},
},
},
"resources": {
"random1": {
"type": "OS::Heat::RandomString",
},
},
},
"profile": {
"name": null,
"permission": "111100001111",
"spec": null,
"tags": {}
}
"tags": {}
}

54
doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/profile_update_resp.json Normal file
View File

@@ -0,0 +1,54 @@
{
"profile": {
"created_time": "2015-03-01T14:28:25.000000",
"deleted_time": null,
"id": "7fa885cd-fa39-4531-a42d-780af95c84a4",
"name": "test_prof1",
"permission": "010101",
"spec": {
"disable_rollback": false,
"environment": {
"resource_registry": {
"os.heat.server": "OS::Heat::Server"
}
},
"files": {
"file:///opt/stack/senlin/examples/profiles/test_script.sh": "#!/bin/bash\n\necho \"this is a test script file\"\n"
},
"parameters": {},
"template": {
"heat_template_version": "2014-10-16",
"outputs": {
"result": {
"value": {
"get_attr": [
"random",
"value"
]
}
}
},
"parameters": {
"file": {
"default": {
"get_file": "file:///opt/stack/senlin/examples/profiles/test_script.sh"
},
"type": "string"
}
},
"resources": {
"random": {
"properties": {
"length": 64
},
"type": "OS::Heat::RandomString"
}
}
},
"timeout": 60
},
"tags": {},
"type": "os.heat.stack",
"updated_time": "2015-03-02T06:16:01.050516"
}
}