openstack/senlin
Code Issues Proposed changes

Fixed profile create api doc

Browse Source
This commit is contained in:
tengqm
2015-03-01 22:36:07 +08:00
parent 3e3e5b845b
commit af2435c8c4
2 changed files with 52 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -591,7 +591,7 @@ name could be delayed for an unspecified time.</para></note>'>
</wadl:doc>
<param name="name" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>Name for the newly created profile.</para>
<para>Name for the profile to be created.</para>
</wadl:doc>
</param>
<param name="type" style="plain" required="true">
@@ -616,7 +616,7 @@ name could be delayed for an unspecified time.</para></note>'>
</param>
</representation>
</request>
<response status="201">
<response status="200">
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<xsdxt:code href="samples/profile_create_resp.json" />

57
doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/profile_create_resp.json
View File

@@ -1,11 +1,54 @@
{
"profile": {
"id": "9dc26f35-9c46-4d7a-88b4-a9ca3b0b68de",
"links": [
{
"href": "http://192.168.12.34:8778/v1/eb1c63a4f77141548385f113a28f0f52/profiles/9dc26f35-9c46-4d7a-88b4-a9ca3b0b68de",
"rel": "self"
}
]
"created_time": "2015-03-01T14:28:25.000000",
"deleted_time": null,
"id": "7fa885cd-fa39-4531-a42d-780af95c84a4",
"name": "test_prof1",
"permission": "xxx",
"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": null
}
}