summaryrefslogtreecommitdiff
path: root/api-guide/source
diff options
context:
space:
mode:
authorMatt Riedemann <mriedem.os@gmail.com>2018-09-05 13:46:19 -0400
committerMatt Riedemann <mriedem.os@gmail.com>2018-09-07 14:29:57 -0400
commitde27a387b0447becf6a9abdf44d6a4c27dc42adf (patch)
tree69d8b62fa27d13cd8795a7720f1b846bfa4731d3 /api-guide/source
parent0f102089dd0b27c7d35f0cbba87332414032c0a4 (diff)
downloadnova-de27a387b0447becf6a9abdf44d6a4c27dc42adf.tar.gz
Fix formatting in changes-since guide
This fixes the weird formatting in the changes-since guide along with splitting up the giant wall of text so this is easier to consume. Change-Id: Ia15d3b5e3e1e8279d9109ca9c54f213c3e7838bb
Diffstat (limited to 'api-guide/source')
-rw-r--r--api-guide/source/polling_changes-since_parameter.rst28
1 files changed, 16 insertions, 12 deletions
diff --git a/api-guide/source/polling_changes-since_parameter.rst b/api-guide/source/polling_changes-since_parameter.rst
index 52ea273af9..9bd0a25853 100644
--- a/api-guide/source/polling_changes-since_parameter.rst
+++ b/api-guide/source/polling_changes-since_parameter.rst
@@ -1,28 +1,32 @@
==================================================
-Efficient polling with the Changes-Since parameter
+Efficient polling with the changes-since parameter
==================================================
The REST API allows you to poll for the status of certain operations by
performing a **GET** on various elements. Rather than re-downloading and
re-parsing the full status at each polling interval, your REST client
-may use the *``changes-since``* parameter to check for changes since a
-previous request. The *``changes-since``* time is specified as an `ISO
+may use the ``changes-since`` parameter to check for changes since a
+previous request.
+
+The ``changes-since`` time is specified as an `ISO
8601 <https://en.wikipedia.org/wiki/ISO_8601>`__ dateTime
-(2011-01-24T17:08Z). The form for the timestamp is CCYY-MM-DDThh:mm:ss.
+(2011-01-24T17:08Z). The form for the timestamp is **CCYY-MM-DDThh:mm:ss**.
An optional time zone may be written in by appending the form ±hh:mm
which describes the timezone as an offset from UTC. When the timezone is
-not specified (2011-01-24T17:08), the UTC timezone is assumed. If
-nothing has changed since the *``changes-since``* time, an empty list is
+not specified (2011-01-24T17:08), the UTC timezone is assumed.
+
+If nothing has changed since the ``changes-since`` time, an empty list is
returned. If data has changed, only the items changed since the
specified time are returned in the response. For example, performing a
-**GET** against
-https://api.servers.openstack.org/v2.1/servers?\ *``changes-since``*\ =2015-01-24T17:08Z
-would list all servers that have changed since Mon, 24 Jan 2015 17:08:00
-UTC.
+**GET** against::
+
+ https://api.servers.openstack.org/v2.1/servers?changes-since=2015-01-24T17:08Z
+
+would list all servers that have changed since Mon, 24 Jan 2015 17:08:00 UTC.
-To allow clients to keep track of changes, the changes-since filter
+To allow clients to keep track of changes, the ``changes-since`` filter
displays items that have been *recently* deleted. Both images and
servers contain a ``DELETED`` status that indicates that the resource
has been removed. Implementations are not required to keep track of
-deleted resources indefinitely, so sending a changes since time in the
+deleted resources indefinitely, so sending a ``changes-since`` time in the
distant past may miss deletions.