Merge pull request #207 from peridio/jwong/eng-2446-docs-extend-tunne…

…l-ttl add extend tunnel options
peridio · Jul 8, 2024 · 419deb5 · 419deb5
2 parents 90db0de + e5423d8
commit 419deb5
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/src/openapi/peridio-admin-openapi.yaml b/src/openapi/peridio-admin-openapi.yaml
@@ -353,7 +353,7 @@ paths:
                   type: number
                   default: 3600
                   description: The amount of time in seconds that the tunnel is available for.
-                  minimum: 0
+                  minimum: 1
                   maximum: 3600
               required:
                 - device_prn
@@ -410,7 +410,9 @@ paths:
       operationId: update-a-tunnel
       summary: Update a tunnel
       description: |
-        Update a tunnel currently only allows changing a tunnel to a closed state.
+        Update a tunnel
+          - allows changing a tunnel to a closed state.
+          - allows extending the expiration (the number of seconds from current time).
 
         <a style="display: flex; margin-bottom: 16px; background: purple; color: white; border-radius: 5px; padding: 2px 4px; width: fit-content;" href="/device-api#tunnels">
           <svg style="margin-right: 0.4em;" width="19.6px" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="w-6 h-6"> <path stroke-linecap="round" stroke-linejoin="round" d="M9.75 3.104v5.714a2.25 2.25 0 0 1-.659 1.591L5 14.5M9.75 3.104c-.251.023-.501.05-.75.082m.75-.082a24.301 24.301 0 0 1 4.5 0m0 0v5.714c0 .597.237 1.17.659 1.591L19.8 15.3M14.25 3.104c.251.023.501.05.75.082M19.8 15.3l-1.57.393A9.065 9.065 0 0 1 12 15a9.065 9.065 0 0 0-6.23-.693L5 14.5m14.8.8 1.402 1.402c1.232 1.232.65 3.318-1.067 3.611A48.309 48.309 0 0 1 12 21c-2.773 0-5.491-.235-8.135-.687-1.718-.293-2.3-2.379-1.067-3.61L5 14.5" /></svg>Labs
@@ -433,6 +435,11 @@ paths:
                   type: string
                   examples: [closed]
                   description: The state we want the tunnel to be in. Only accepts "closed".
+                ttl:
+                  type: number
+                  description: The amount of time in seconds to extend the tunnel for.
+                  minimum: 1
+                  maximum: 3600
       responses:
         "200":
           description: Ok.