iobroker.rest-api 0.3.5 → 0.3.6

package/README.md

@@ -51,6 +51,9 @@ This adapter can run as web-extension. In this case the path is available under
 -->
 
 ## Changelog
+### 0.3.6 (2022-04-22)
+* (bluefox) Added object creation and enumerations reading
+
 ### 0.3.5 (2022-04-22)
 * (bluefox) Allowed the reading of current subscriptions
 

package/io-package.json

@@ -1,8 +1,20 @@
 {
   "common": {
     "name": "rest-api",
-    "version": "0.3.5",
+    "version": "0.3.6",
     "news": {
+      "0.3.6": {
+        "en": "Added object creation and enumerations reading",
+        "de": "Objekterstellung und Lesen von Aufzählungen hinzugefügt",
+        "ru": "Добавлено создание объектов и чтение перечислений",
+        "pt": "Adicionado criação de objetos e leitura de enumerações",
+        "nl": "Toegevoegd objectcreatie en opsommingen lezen",
+        "fr": "Ajout de la création d'objets et de la lecture des énumérations",
+        "it": "Aggiunta creazione di oggetti e lettura di enumerazioni",
+        "es": "Añadida creación de objetos y lectura de enumeraciones.",
+        "pl": "Dodano tworzenie obiektów i odczytywanie wyliczeń",
+        "zh-cn": "添加了对象创建和枚举读取"
+      },
       "0.3.5": {
         "en": "Allowed the reading of current subscriptions",
         "de": "Erlaubt das Lesen aktueller Abonnements",

package/lib/api/controllers/enum.js

@@ -0,0 +1,44 @@
+'use strict';
+const commonLib = require('./common.js');
+
+module.exports = {
+    readMainEnums: function (req, res) {
+        commonLib.checkPermissions(req._adapter, req._user, [{type: 'object', operation: 'read'}],  async err => {
+            if (err) {
+                res.status(403).json({error: err});
+            } else {
+                // check if instance is alive
+                try {
+                    const enums = await req._adapter.getEnumsAsync('', {user: req._user});
+                    res.json(enums);
+                } catch (error) {
+                    res.status(500).json({error});
+                }
+            }
+        });
+    },
+    readEnums: function (req, res) {
+        commonLib.checkPermissions(req._adapter, req._user, [{type: 'object', operation: 'read'}],  async err => {
+            if (err) {
+                res.status(403).json({error: err});
+            } else {
+                const params = commonLib.parseUrl(req.url, req.swagger);
+                // check if instance is alive
+                try {
+                    const enums = await req._adapter.getEnumAsync(params.enumId, {user: req._user});
+                    if (enums && enums.result) {
+                        res.json(Object.keys(enums.result).filter(id => id.split('.').length > 2).map(id => ({
+                            _id: id,
+                            common: enums.result[id].common
+                        })));
+                    } else {
+                        res.json([]);
+                    }
+                } catch (error) {
+                    res.status(500).json({error});
+                }
+
+            }
+        });
+    },
+};

package/lib/api/controllers/object.js

@@ -64,6 +64,28 @@ module.exports = {
         });
     },
 
+    createObject: function (req, res) {
+        commonLib.checkPermissions(req._adapter, req._user, [{type: 'object', operation: 'write'}], async err => {
+            if (err) {
+                res.status(403).json({error: err});
+            } else {
+                const params = commonLib.parseUrl(req.url, req.swagger);
+                const body = req.body;
+                try {
+                    const obj = await req._adapter.getForeignObjectAsync(params.objectId, {user: req._user});
+                    if (!obj) {
+                        await req._adapter.setForeignObjectAsync(params.objectId, body, {user: req._user});
+                        res.status(200).json(body);
+                    } else {
+                        res.status(409).json({error: 'Object already exists', id: params.objectId});
+                    }
+                } catch (error) {
+                    res.status(500).json({error, objectId: params.objectId});
+                }
+            }
+        });
+    },
+
     deleteObject: function (req, res) {
         commonLib.checkPermissions(req._adapter, req._user, [{type: 'object', operation: 'write'}], async err => {
             if (err) {

package/lib/api/swagger/swagger.yaml

@@ -20,6 +20,8 @@ tags:
     description: "Read the objects"
   - name: "history"
     description: "Read the history"
+  - name: "enum"
+    description: "Read the categories"
 securityDefinitions:
   basicAuth:
     type: basic
@@ -379,11 +381,44 @@ paths:
           description: "Object not found"
         400:
           description: "Invalid object ID supplied"
+    post:
+      tags:
+        - "object"
+      summary: "Create the object"
+      description: "Create new object. If object already exists, the error will be returned"
+      operationId: "createObject"
+      consumes:
+        - "application/json"
+      produces:
+        - "application/json"
+      parameters:
+        - in: "path"
+          name: "objectId"
+          description: "ID of the object to write"
+          required: true
+          type: "string"
+        - in: "body"
+          name: "value"
+          description: "Object"
+          required: true
+          schema:
+            $ref: "#/definitions/Object"
+      responses:
+        200:
+          description: "successful operation"
+          schema:
+            $ref: "#/definitions/Object"
+        400:
+          description: "Invalid object ID supplied"
+        409:
+          description: "Object already exists"
+        405:
+          description: "Invalid object structure"
     put:
       tags:
         - "object"
       summary: "Update the object"
-      description: "To delete the parts of the object, set the value to 'null', like {\"common\": {\"desc\": null} to delete the \"common.desc\""
+      description: "To delete the parts of the object, set the value to 'null', like {\"common\": {\"desc\": null} to delete the \"common.desc\". If object does not exist it will be created"
       operationId: "updateObject"
       consumes:
         - "application/json"
@@ -782,6 +817,40 @@ paths:
             $ref: "#/definitions/HistoryAddResponse"
         422:
           description: "Invalid options supplied"
+  /enum:
+    x-swagger-router-controller: enum
+    get:
+      tags:
+        - "enum"
+      summary: "Reads categories of enums"
+      operationId: "readMainEnums"
+      produces:
+        - "application/json"
+      responses:
+        200:
+          description: "successful operation"
+  /enum/{enumId}:
+    x-swagger-router-controller: enum
+    get:
+      tags:
+        - "enum"
+      summary: "Reads enums of specific type"
+      operationId: "readEnums"
+      produces:
+        - "application/json"
+      parameters:
+        - name: "enumId"
+          in: "path"
+          description: "Enum ID in form \"functions\" or \"room\" without \"enum.\""
+          type: "string"
+          required: true
+      responses:
+        200:
+          description: "successful operation"
+          schema:
+            $ref: "#/definitions/EnumResponse"
+        404:
+          description: "Category not found"
 definitions:
   State:
     type: "object"
@@ -989,6 +1058,37 @@ definitions:
       error:
         type: "string"
         description: "Error description"
+  EnumCommon:
+    type: "object"
+    properties:
+      name:
+        type: "string"
+        description: "Name can be string or object"
+      icon:
+        type: "string"
+        description: "Icon for category (optional)"
+      desc:
+        type: "string"
+        description: "Description can be string or object"
+      members:
+        type: "array"
+        items:
+          type: "string"
+  EnumEntry:
+    type: "object"
+    properties:
+      _id:
+        type: "string"
+        description: "Enum ID"
+      common:
+        $ref: "#/definitions/EnumCommon"
+      type:
+        type: "string"
+        description: "Always enum"
+  EnumResponse:
+    type: "array"
+    items:
+      $ref: "#/definitions/EnumEntry"
 externalDocs:
   description: "Find out more about ioBroker"
   url: "https://www.iobroker.net"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.rest-api",
-  "version": "0.3.5",
+  "version": "0.3.6",
   "description": "RESTful interface for ioBroker with GUI.",
   "author": {
     "name": "bluefox",