Create PublicInformation-local-openapi-v3.yml

openapi/PublicInformation-local-openapi-v3.yml

@@ -0,0 +1,102 @@
+### Generated by Eclipse Vorto OpenAPI Generator from Model 'vorto.private.local.com.bosch.sh:SmartPlug:1.0.0'
+openapi: 3.0.0
+info:
+  title: Bosch Smart Home Local API for Main Resources
+  description: |- 
+    This API interface provides access to public information from the Bosch Smart Home Controller. It enables the retrieval of a list of all clients paired with the controller, including details on software updates, connectivity versions, and system properties. The API serves as a central point for querying system information essential for integrating and managing smart home devices. By utilizing this interface, developers can efficiently access crucial data to enhance the functionality and user experience of their applications.
+
+    By using this documentation, the developer accepts and agrees to be bound by our [Terms and Conditions](https://github.com/BoschSmartHome/bosch-shc-api-docs#terms-and-conditions).
+
+    This documentation is subject to the [Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International Public License](https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode).
+
+    Please report any issues you encounter with this documentation in our [GitHub tracker](https://github.com/BoschSmartHome/bosch-shc-api-docs/issues).
+  version: "3.6"
+servers:
+  - url: https://{{host}}:8446/smarthome
+    description: "Bosch Smart Home Controller URL"
+    variables:    
+      shcIp:
+        default: 192.168.0.10
+tags:
+  - name: SystemInformation
+
+paths:
+  ###
+  ### System Information
+  ###
+  '/public/information':
+    get:
+      summary: List all available Devices.
+      description: Returns all Devices paired with the Smart Home Controller.
+      tags:
+      - SystemInformation
+      responses:
+        '200':
+          description: Accepted request.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PublicInformation'
+
+components:
+  schemas:
+    PublicInformation:
+      type: object
+      properties:
+        apiVersions:
+          type: array
+          items:
+            type: string
+        softwareUpdateState:
+          type: object
+          properties:
+            "@type":
+              type: string
+            swUpdateState:
+              type: string
+            swUpdateLastResult:
+              type: string
+            swUpdateAvailableVersion:
+              type: string
+            swInstalledVersion:
+              type: string
+            swActivationDate:
+              type: object
+              properties:
+                "@type":
+                  type: string
+                timeout:
+                  type: integer
+            automaticUpdatesEnabled:
+              type: boolean
+        macAddress:
+          type: string
+        claimed:
+          type: boolean
+        country:
+          type: string
+        tacVersion:
+          type: string
+        shcIpAddress:
+          type: string
+        clientIds:
+          type: array
+          items:
+            type: string
+        featureToggles:
+          type: object
+          additionalProperties:
+            type: boolean
+        connectivityVersions:
+          type: array
+          items:
+            type: object
+            properties:
+              name:
+                type: string
+              minVersion:
+                type: integer
+              maxVersion:
+                type: integer
+        shcGeneration:
+          type: string