You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@warble.apache.org by hu...@apache.org on 2018/06/26 15:21:14 UTC

[incubator-warble-server] 07/07: regen openapi yaml

This is an automated email from the ASF dual-hosted git repository.

humbedooh pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-warble-server.git

commit eb3d105762663e36447f605f00e8b3020f1f5cf5
Author: Daniel Gruno <hu...@apache.org>
AuthorDate: Tue Jun 26 10:20:51 2018 -0500

    regen openapi yaml
---
 api/yaml/openapi.yaml | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)

diff --git a/api/yaml/openapi.yaml b/api/yaml/openapi.yaml
index 7d96aff..f18c53c 100644
--- a/api/yaml/openapi.yaml
+++ b/api/yaml/openapi.yaml
@@ -73,6 +73,47 @@ components:
       - hostname
       - pubkey
       - version
+    NodeDetails:
+      properties:
+        description:
+          description: A description of the node
+          example: This is the internal node in DC1
+          type: string
+        enabled:
+          description: Whether the node is enabled or paused
+          example: true
+          type: boolean
+        hostname:
+          description: The node's own perceived hostname
+          example: foo1.warble.xyz
+          type: string
+        id:
+          description: the numeric ID of the node to modify
+          example: 42
+          type: integer
+        ip:
+          description: The IP generally associated with this client
+          type: string
+        lastping:
+          description: The last UNIX timestamp of activity from the client
+          type: integer
+        location:
+          description: Physical location of the node
+          example: DC1, Chicago, Illinois
+          type: string
+        pubkey:
+          description: The node's self-generated public RSA key, PEM-encoded
+          type: string
+        verified:
+          description: Whether the node is verified as ours or not
+          example: true
+          type: boolean
+        version:
+          description: The version of Warble the node is running
+          example: 0.1.0
+          type: string
+      required:
+      - id
     Timeseries:
       properties:
         interval:
@@ -338,6 +379,29 @@ paths:
                 $ref: '#/components/schemas/Error'
           description: unexpected error
       summary: Create a new account
+  /api/node/modify:
+    post:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/NodeDetails'
+        description: Node details to modify
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ActionCompleted'
+          description: Node successfully modified on server
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+          description: unexpected error
+      summary: Modifies base data of a node in the registry
   /api/node/register:
     post:
       requestBody:
@@ -361,6 +425,22 @@ paths:
                 $ref: '#/components/schemas/Error'
           description: unexpected error
       summary: Registers a new node with the Warble server
+  /api/node/status:
+    get:
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/NodeDetails'
+          description: Node status
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+          description: unexpected error
+      summary: Displays the current status of a node
   /api/session:
     delete:
       requestBody:


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@warble.apache.org
For additional commands, e-mail: commits-help@warble.apache.org