Ver Fonte

generatore doc, completato responses

fabio há 2 meses atrás
pai
commit
c88b54ce1f
3 ficheiros alterados com 517 adições e 9 exclusões
  1. 2 0
      genera.sh
  2. 410 0
      panorama.html
  3. 105 9
      panorama.yaml

+ 2 - 0
genera.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+npx @redocly/cli build-docs -o panorama.html panorama.yaml

Diff do ficheiro suprimidas por serem muito extensas
+ 410 - 0
panorama.html


+ 105 - 9
panorama.yaml

@@ -10,7 +10,7 @@ info:
     name: API Support
     email: support@panorama.edisonnext.it
 
-  version: 0.9.2
+  version: 0.9.3
   
   license:
     name: © 2025 - 2030 Copyright Edison Next Spa. All rights reserved
@@ -36,10 +36,8 @@ tags:
     description: operations for data sources
   - name: Type
     description: operations for data types
-  - name: Entity Browse
-    description: operations to browse entities and their state
   - name: Entity
-    description: operations to manage entities (data provider only)
+    description: operations to browse and manage entities
   - name: Device
     description: Operations about Devices
 paths:
@@ -60,8 +58,8 @@ paths:
     post:
       summary: Crea un nuovo Tipo di Entità (admin only)
       tags: [Type]
-#      security:
-#        - panorama_administrator_api_key: []
+      security:
+        - panorama_administrator_api_key: []
       requestBody:
         required: true
         content:
@@ -95,6 +93,8 @@ paths:
     put:
       summary: Modifica un Tipo esistente (admin only)
       tags: [Type]
+      security:
+        - panorama_administrator_api_key: []
       parameters:
         - in: path
           name: id
@@ -114,6 +114,17 @@ paths:
     delete:
       summary: Elimina un Tipo (senza istanze di elementi) esistente (admin only)
       tags: [Type]
+      security:
+        - panorama_administrator_api_key: []
+      parameters:
+        - in: path
+          name: id
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          description: Tipo eliminato
 
   /source:
     get:
@@ -132,6 +143,8 @@ paths:
     post:
       summary: Aggiunge una Fonte Dati (admin only)
       tags: [Data Source]
+      security:
+        - panorama_administrator_api_key: []
       requestBody:
         required: true
         content:
@@ -147,10 +160,38 @@ paths:
     put:
       summary: Modifica una sorgente dati esistente (admin only)
       tags: [Data Source]
+      security:
+        - panorama_administrator_api_key: []
+      parameters:
+        - in: path
+          name: id
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Source'
+      responses:
+        '200':
+          description: Data Source aggiornata
 
     delete:
       summary: Elimina una sorgente dati (vuota) esistente (admin only)
       tags: [Data Source]
+      security:
+        - panorama_administrator_api_key: []
+      parameters:
+        - in: path
+          name: id
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          description: Sorgente Dati eliminata
 
   /terminology:
     get:
@@ -169,6 +210,8 @@ paths:
     post:
       summary: Crea una nuova Nomenclatura (admin only)
       tags: [Type]
+      security:
+        - panorama_administrator_api_key: []
       requestBody:
         required: true
         content:
@@ -184,17 +227,62 @@ paths:
     get:
       summary: Restituisce una singola Nomenclatura
       tags: [Type]
+      parameters:
+        - in: path
+          name: id
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Tipo trovato
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Type'
+        '404':
+          description: Tipo non trovato
+
     put:
       summary: Modifica una Nomenclatura esistente (admin only)
       tags: [Type]
+      security:
+        - panorama_administrator_api_key: []
+      parameters:
+        - in: path
+          name: id
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Terminology'
+      responses:
+        '200':
+          description: Nomenclatura aggiornata
+
     delete:
       summary: Elimina una Nomenclatura (senza riferimenti in qualche tipo) esistente (admin only)
       tags: [Type]
+      security:
+        - panorama_administrator_api_key: []
+      parameters:
+        - in: path
+          name: id
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          description: Nomenclatura eliminata
 
   /entity:
     get:
       summary: Ricerca di entità
-      tags: [Entity Browse]
+      tags: [Entity]
       parameters:
         - name: type
           in: query
@@ -230,6 +318,8 @@ paths:
     post:
       summary: Crea una nuova entità
       tags: [Entity]
+      security:
+        - panorama_provider_api_key: []
       requestBody:
         required: true
         content:
@@ -243,7 +333,7 @@ paths:
   /entity/{id}:
     get:
       summary: Ottiene una singola entità
-      tags: [Entity Browse]
+      tags: [Entity]
       parameters:
         - in: path
           name: id
@@ -263,6 +353,8 @@ paths:
     put:
       summary: Modifica un'entità esistente (escluso lo stato)
       tags: [Entity]
+      security:
+        - panorama_provider_api_key: []
       parameters:
         - in: path
           name: id
@@ -282,6 +374,8 @@ paths:
     delete:
       summary: Elimina un'entità
       tags: [Entity]
+      security:
+        - panorama_provider_api_key: []
       parameters:
         - in: path
           name: id
@@ -296,6 +390,8 @@ paths:
     put:
       summary: Modifica lo stato di un'Entità
       tags: [Entity]
+      security:
+        - panorama_provider_api_key: []
       parameters:
         - in: path
           name: id
@@ -315,7 +411,7 @@ paths:
   /history/{id}:
     get:
       summary: Ottiene la storia delle variazioni di stato di un'Entità
-      tags: [Entity Browse]
+      tags: [Entity]
       parameters:
         - in: path
           name: id

Alguns ficheiros não foram mostrados porque muitos ficheiros mudaram neste diff