changeset 2253:a89093ff86a3

Clarified ISO 8601 time, changed example, bumped version in API.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 09 Oct 2018 12:28:06 +0300
parents 5a740d0f7a77
children d765ffffd08c
files xml/en/docs/http/ngx_http_api_module.xml yaml/nginx_api.yaml
diffstat 2 files changed, 31 insertions(+), 27 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_api_module.xml
+++ b/xml/en/docs/http/ngx_http_api_module.xml
@@ -1514,13 +1514,13 @@ The total number of configuration <link 
 <literal>load_timestamp</literal> (<literal>string</literal>)
 </tag-name>
 <tag-desc>
-Time of the last reload of configuration, in milliseconds since Epoch.
+Time of the last reload of configuration, in the ISO 8601 format with millisecond resolution.
 </tag-desc>
 <tag-name>
 <literal>timestamp</literal> (<literal>string</literal>)
 </tag-name>
 <tag-desc>
-Current time in milliseconds since Epoch.
+Current time in the ISO 8601 format with millisecond resolution.
 </tag-desc>
 <tag-name>
 <literal>pid</literal> (<literal>integer</literal>)
@@ -1539,12 +1539,12 @@ The ID of the master process that starte
 <example>
 {
   "nginx" : {
-    "version" : "1.13.3",
-    "build" : "nginx-plus-r12-p3",
+    "version" : "1.15.2",
+    "build" : "nginx-plus-r16",
     "address" : "206.251.255.64",
-    "generation" : 2,
-    "load_timestamp" : "2017-07-07T11:09:21.594Z",
-    "timestamp" : "2017-07-11T09:31:13.477Z",
+    "generation" : 6,
+    "load_timestamp" : "2018-10-08T09:05:48.776Z",
+    "timestamp" : "2018-10-08T15:23:17.056Z",
     "pid" : 32212,
     "ppid" : 32210
   }
@@ -2250,13 +2250,13 @@ Total time the server was in the “<literal>unavail</literal>”, “<literal>checking</literal>”, and “<literal>unhealthy</literal>” states.
 <literal>downstart</literal> (<literal>string</literal>)
 </tag-name>
 <tag-desc>
-The time (in milliseconds since Epoch) when the server became “<literal>unavail</literal>”, “<literal>checking</literal>”, or “<literal>unhealthy</literal>”.
+The time when the server became “<literal>unavail</literal>”, “<literal>checking</literal>”, or “<literal>unhealthy</literal>”, in the ISO 8601 format with millisecond resolution.
 </tag-desc>
 <tag-name>
 <literal>selected</literal> (<literal>string</literal>)
 </tag-name>
 <tag-desc>
-The time (in milliseconds since Epoch) when the server was last selected to process a request.
+The time when the server was last selected to process a request, in the ISO 8601 format with millisecond resolution.
 </tag-desc>
 <tag-name>
 <literal>header_time</literal> (<literal>integer</literal>)
@@ -2738,13 +2738,13 @@ Total time the server was in the “<literal>unavail</literal>”, “<literal>checking</literal>”, and “<literal>unhealthy</literal>” states.
 <literal>downstart</literal> (<literal>string</literal>)
 </tag-name>
 <tag-desc>
-The time (in milliseconds since Epoch) when the server became “<literal>unavail</literal>”, “<literal>checking</literal>”, or “<literal>unhealthy</literal>”.
+The time when the server became “<literal>unavail</literal>”, “<literal>checking</literal>”, or “<literal>unhealthy</literal>”, in the ISO 8601 format with millisecond resolution.
 </tag-desc>
 <tag-name>
 <literal>selected</literal> (<literal>string</literal>)
 </tag-name>
 <tag-desc>
-The time (in milliseconds since Epoch) when the server was last selected to process a connection.
+The time when the server was last selected to process a connection, in the ISO 8601 format with millisecond resolution.
 </tag-desc>
 </list>
 </tag-desc>
--- a/yaml/nginx_api.yaml
+++ b/yaml/nginx_api.yaml
@@ -1,6 +1,6 @@
 swagger: '2.0'
 info:
-  version: '2.0'
+  version: '3.0'
   title: NGINX Plus REST API
   description: NGINX Plus REST
     [API](https://nginx.org/en/docs/http/ngx_http_api_module.html)
@@ -1532,11 +1532,12 @@ definitions:
         type: string
         format: date-time
         description: Time of the last reload of configuration,
-          in milliseconds since Epoch.
+          in the ISO 8601 format with millisecond resolution.
       timestamp:
         type: string
         format: date-time
-        description: Current time in milliseconds since Epoch.
+        description: Current time
+          in the ISO 8601 format with millisecond resolution.
       pid:
         type: integer
         description: The ID of the worker process that handled status request.
@@ -1546,12 +1547,12 @@ definitions:
           <a href="https://nginx.org/en/docs/http/ngx_http_status_module.html#pid">worker process</a>.
     example:
       nginx:
-        version: 1.13.3
-        build: nginx-plus-r12-p3
+        version: 1.15.2
+        build: nginx-plus-r16
         address: 206.251.255.64
-        generation: 2
-        load_timestamp: 2017-07-07T11:09:21.594Z
-        timestamp: 2017-07-11T09:31:13.477Z
+        generation: 6
+        load_timestamp: 2018-10-08T09:05:48.776Z
+        timestamp: 2018-10-08T15:23:17.056Z
         pid: 32212
         ppid: 32210
   NginxProcesses:
@@ -2450,15 +2451,16 @@ definitions:
         type: string
         format: date-time
         readOnly: true
-        description: The time (in milliseconds since Epoch) when the server became
+        description: The time when the server became
           “<code>unavail</code>”, “<code>checking</code>”,
-          or “<code>unhealthy</code>”.
+          or “<code>unhealthy</code>”,
+          in the ISO 8601 format with millisecond resolution.
       selected:
         type: string
         format: date-time
         readOnly: true
-        description: The time (in milliseconds since Epoch)
-          when the server was last selected to process a request.
+        description: The time when the server was last selected to process a request,
+          in the ISO 8601 format with millisecond resolution.
       header_time:
         type: integer
         readOnly: true
@@ -3009,15 +3011,17 @@ definitions:
       downstart:
         type: string
         format: date-time
-        description: The time (in milliseconds since Epoch) when the server became
+        description: The time when the server became
           “<code>unavail</code>”, “<code>checking</code>”,
-          or “<code>unhealthy</code>”.
+          or “<code>unhealthy</code>”,
+          in the ISO 8601 format with millisecond resolution.
         readOnly: true
       selected:
         type: string
         format: date-time
-        description: The time (in milliseconds since Epoch)
-          when the server was last selected to process a connection.
+        description: The time when the server was last selected
+          to process a connection,
+          in the ISO 8601 format with millisecond resolution.
         readOnly: true
   NginxStreamUpstreamConfServerMap:
     title: Stream Upstream Servers