Browse Source

Merge "[Doc] Add documentation for messages API."

changes/05/449205/1
Jenkins 4 years ago
committed by Gerrit Code Review
parent
commit
ce32522d3a
5 changed files with 248 additions and 0 deletions
  1. +1
    -0
      api-ref/source/v3/index.rst
  2. +117
    -0
      api-ref/source/v3/messages.inc
  3. +64
    -0
      api-ref/source/v3/parameters.yaml
  4. +43
    -0
      api-ref/source/v3/samples/messages-list-response.json
  5. +23
    -0
      api-ref/source/v3/samples/messages-show-response.json

+ 1
- 0
api-ref/source/v3/index.rst View File

@ -16,6 +16,7 @@ Block Storage API V3 (CURRENT)
.. include:: group-snapshots.inc
.. include:: group-types.inc
.. include:: limits.inc
.. include:: messages.inc
.. include:: os-vol-image-meta-v3.inc
.. include:: os-vol-pool-v3.inc
.. include:: os-vol-transfer-v3.inc


+ 117
- 0
api-ref/source/v3/messages.inc View File

@ -0,0 +1,117 @@
.. -*- rst -*-
Messages
========
Lists all, shows, and deletes messages.
Delete message
~~~~~~~~~~~~~~
.. rest_method:: DELETE /v3/{project_id}/messages/{message_id}
Deletes a message.
Normal response codes: 202
Error response codes: badRequest(400), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- message_id: message_id
Show message details
~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v3/{project_id}/messages/{message_id}
Shows details for a message.
Normal response codes: 200
Error response codes: badRequest(400), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- message_id: message_id
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- request_id: request_id
- links: links_5
- message_level: message_level
- event_id: event_id
- created_at: created_at
- guaranteed_until: guaranteed_until
- resource_uuid: resource_uuid
- id: id_8
- resource_type: resource_type
- user_message: user_message
Response Example
----------------
.. literalinclude:: ./samples/messages-show-response.json
:language: javascript
List messages
~~~~~~~~~~~~~
.. rest_method:: GET /v3/{project_id}/messages
Lists all messages.
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- sort_key: sort_key
- sort_dir: sort_dir
- limit: limit
- offset: offset
- marker: marker
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- request_id: request_id
- links: links_5
- message_level: message_level
- event_id: event_id
- created_at: created_at
- guaranteed_until: guaranteed_until
- resource_uuid: resource_uuid
- id: id_8
- resource_type: resource_type
- user_message: user_message
Response Example
----------------
.. literalinclude:: ./samples/messages-list-response.json
:language: javascript

+ 64
- 0
api-ref/source/v3/parameters.yaml View File

@ -191,6 +191,12 @@ marker:
in: query
required: false
type: string
message_id:
description: |
The UUID of the message.
in: query
required: true
type: string
metadata_query:
description: |
Filters results by a metadata key and value pair.
@ -619,6 +625,13 @@ encryption_id_body:
in: body
required: true
type: string
event_id:
description: |
The id of the event to this message, this id could
eventually be translated into ``user_message``.
in: body
required: true
type: string
extra_specs:
description: |
A set of key and value pairs that contains the
@ -717,6 +730,13 @@ group_types:
in: body
required: true
type: array
guaranteed_until:
description: |
The expire time of the message, this message could be
be deleted after this time.
in: body
required: false
type: string
has_dependent_backups:
description: |
If this value is ``true``, the backup depends on
@ -792,6 +812,12 @@ id_7:
in: body
required: true
type: integer
id_8:
description: |
The ID for the message.
in: body
required: true
type: integer
imageRef:
description: |
The UUID of the image from which you want to
@ -932,6 +958,12 @@ links_4:
in: body
required: true
type: array
links_5:
description: |
Links for the message.
in: body
required: false
type: array
location:
description: |
Full URL to a service or server.
@ -971,6 +1003,13 @@ maxTotalVolumes:
in: body
required: true
type: integer
message_level:
description: |
The level of the message, possible value is
only 'ERROR' now.
in: body
required: true
type: string
metadata:
description: |
One or more metadata key and value pairs for the
@ -1434,6 +1473,12 @@ replication_status:
in: body
required: true
type: string
request_id:
description: |
The id of the request during which the message was created.
in: body
required: true
type: string
reserved:
description: |
Reserved volume size. Visible only if you set the
@ -1454,6 +1499,19 @@ reset_status:
in: body
required: true
type: object
resource_type:
description: |
The resource type corresponding to ``resource_uuid``.
in: body
required: false
type: string
resource_uuid:
description: |
The UUID of the resource during whose operation the
message was created.
in: body
required: false
type: string
restore:
description: |
A ``restore`` object.
@ -1732,6 +1790,12 @@ user_id:
in: body
required: true
type: string
user_message:
description: |
The translated readable message corresponding to ``event_id``.
in: body
required: false
type: string
vendor_name:
description: |
The name of the vendor.


+ 43
- 0
api-ref/source/v3/samples/messages-list-response.json View File

@ -0,0 +1,43 @@
{
"messages": [{
"request_id": "req-c1216709-afba-4703-a1a3-22eda88f2f5a",
"links": [
{
"href": "http://localhost:8776/v3/cd609134301246f0a3faa9c3da22082e/messages/c506cd4b-9048-43bc-97ef-0d7dec369b42",
"rel": "self"
},
{
"href": "http://localhost:8776/cd609134301246f0a3faa9c3da22082e/messages/c506cd4b-9048-43bc-97ef-0d7dec369b42",
"rel": "bookmark"
}
],
"message_level": "ERROR",
"event_id": "VOLUME_000002",
"created_at": "2014-10-28T00:00:00-00:00",
"guaranteed_until": "2014-10-28T00:00:00-00:00",
"resource_uuid": "d5f6c517-c3e8-45fe-b994-b11118e4cacf",
"id": "c506cd4b-9048-43bc-97ef-0d7dec369b42",
"resource_type": "VOLUME",
"user_message": "No storage could be allocated for this volume request."
},{
"request_id": "req-c1216709-afba-4703-a1a3-22eda88f2f5a",
"links": [
{
"href": "http://localhost:8776/v3/cd609134301246f0a3faa9c3da22082e/messages/c506cd4b-9048-43bc-97ef-0d7dec369b42",
"rel": "self"
},
{
"href": "http://localhost:8776/cd609134301246f0a3faa9c3da22082e/messages/c506cd4b-9048-43bc-97ef-0d7dec369b42",
"rel": "bookmark"
}
],
"message_level": "ERROR",
"event_id": "VOLUME_000002",
"created_at": "2014-10-28T00:00:00-00:00",
"guaranteed_until": "2014-10-28T00:00:00-00:00",
"resource_uuid": "d5f6c517-c3e8-45fe-b994-b11118e4df4e",
"id": "c506cd4b-9048-43bc-97ef-0d7dec36d5gt",
"resource_type": "VOLUME",
"user_message": "No storage could be allocated for this volume request."
}]
}

+ 23
- 0
api-ref/source/v3/samples/messages-show-response.json View File

@ -0,0 +1,23 @@
{
"message": {
"request_id": "req-c1216709-afba-4703-a1a3-22eda88f2f5a",
"links": [
{
"href": "http://localhost:8776/v3/cd609134301246f0a3faa9c3da22082e/messages/c506cd4b-9048-43bc-97ef-0d7dec369b42",
"rel": "self"
},
{
"href": "http://localhost:8776/cd609134301246f0a3faa9c3da22082e/messages/c506cd4b-9048-43bc-97ef-0d7dec369b42",
"rel": "bookmark"
}
],
"message_level": "ERROR",
"event_id": "VOLUME_000002",
"created_at": "2014-10-28T00:00:00-00:00",
"guaranteed_until": "2014-10-28T00:00:00-00:00",
"resource_uuid": "d5f6c517-c3e8-45fe-b994-b11118e4cacf",
"id": "c506cd4b-9048-43bc-97ef-0d7dec369b42",
"resource_type": "VOLUME",
"user_message": "No storage could be allocated for this volume request."
}
}

Loading…
Cancel
Save