Update profile APIs doc

1. update some outputs field
2. update request params
3. update response params
4. update samples

Change-Id: Ibc2845633dc35e7c789578237bb219017f814c50
This commit is contained in:
liyi 2017-07-12 12:38:08 +08:00
parent a717e261f1
commit 5c8bc80409
5 changed files with 16 additions and 9 deletions

View File

@ -31,13 +31,16 @@ Request Parameters
.. rest_parameters:: parameters.yaml
- OpenStack-API-Version: microversion
- global_project: global_project
- limit: limit
- marker: marker
- sort: sort
- global_project: global_project
- name: name_query
- sort: sort
- type: type_query
The sorting keys include ``name``, ``type``, ``created_at`` and
``updated_at``.
Response Parameters
-------------------
@ -46,6 +49,7 @@ Response Parameters
- X-OpenStack-Request-Id: request_id
- profiles: profiles
- created_at: created_at
- domain: domain
- id: profile_id
- metadata: metadata
- name: name
@ -333,6 +337,7 @@ The response contains properties as if the profile is created.
.. rest_parameters:: parameters.yaml
- X-OpenStack-Request-Id: request_id
- profile: profile
- created_at: created_at
- domain: domain
- id: profile_id

View File

@ -1,6 +1,6 @@
{
"profile": {
"created_at": "2016-05-05T10:15:22",
"created_at": "2016-05-05T10:15:22Z",
"domain": null,
"id": "1d85fc39-7d9a-4f64-9751-b127ef554923",
"metadata": {},

View File

@ -1,7 +1,7 @@
{
"profiles": [
{
"created_at": "2016-01-03T16:22:23",
"created_at": "2016-01-03T16:22:23Z",
"domain": null,
"id": "9e1c6f42-acf5-4688-be2c-8ce954ef0f23",
"metadata": {},

View File

@ -1,6 +1,6 @@
{
"profile": {
"created_at": "2016-03-10T06:34:56",
"created_at": "2016-03-10T06:34:56Z",
"domain": null,
"id": "17151d8a-f46f-4541-bde0-db3b207c20d2",
"metadata": {},

View File

@ -1,10 +1,12 @@
{
"profile": {
"created_at": "2016-03-10T06:34:56",
"created_at": "2016-03-10T06:34:56Z",
"domain": null,
"id": "17151d8a-f46f-4541-bde0-db3b207c20d2",
"metadata": {},
"name": "PF20",
"metadata": {
"key": "value"
},
"name": "new-name",
"project": "42d9e9663331431f97b75e25136307ff",
"spec": {
"properties": {
@ -22,7 +24,7 @@
"version": 1.0
},
"type": "os.nova.server-1.0",
"updated_at": "2016-03-11T05:10:11",
"updated_at": "2016-03-11T05:10:11Z",
"user": "5e5bf8027826429c96af157f68dc9072"
}
}