Merge pull request #1 from MohamedSadiq102/master

Add schema.yaml && swagger.yaml
smart-data-models · Jun 22, 2020 · dfa3bab · dfa3bab
2 parents 56a45a5 + 856a7ad
commit dfa3bab
Show file tree

Hide file tree

Showing 4 changed files with 143 additions and 0 deletions.
diff --git a/SmartPointOfInteraction/schema.yaml b/SmartPointOfInteraction/schema.yaml
@@ -0,0 +1,16 @@
+SmartPointOfInteraction:
+  required:
+    - id
+  allOf:
+    - $ref: >-
+        https://raw.githubusercontent.com/smart-data-models/data-models/master/ngsi-ld.yaml#/Common
+  type: object
+  description: |
+    This repository is going to be archived (Jan-2020) and subsequent works will be carried out in [Smart data models]
+    (https://github.com/smart-data-models) repositories. Further questions on migration. alberto.abella@fiware.org
+    As an alternative or extension to traditional interactive points (shopping malls, museums, airports, etc.), a Smart Point of Interaction use technologies such as Bluetooth Low Energy or Wi-Fi to bring new interactions to user's devices (smartphones, wearables, etc.).
+
+    A smart point of interaction is composed mainly by two entities: "Smart Point of Interaction": defines an
+    interactive point which provides information, entertainment or co-creation tools to citizens.
+    Optionally it can reference a related smart city asset with enriched interaction provided by this technology.
+    "Smart Spot": a set of resources related to a physical device and the technology to provide a Smart Point of Interaction.
diff --git a/SmartPointOfInteraction/swagger.yaml b/SmartPointOfInteraction/swagger.yaml
@@ -0,0 +1,56 @@
+--- 
+components: 
+  schemas: 
+    SmartPointOfInteraction: 
+      $ref: "https://raw.githubusercontent.com/smart-data-models/dataModel.PointOfInteraction/master/SmartPointOfInteraction/schema.yaml#/SmartPointOfInteraction"
+info: 
+  description: |
+    This repository is going to be archived (Jan-2020) and subsequent works will be carried out in [Smart data models]
+    (https://github.com/smart-data-models) repositories. Further questions on migration. alberto.abella@fiware.org
+    As an alternative or extension to traditional interactive points (shopping malls, museums, airports, etc.), a Smart Point of Interaction use technologies such as Bluetooth Low Energy or Wi-Fi to bring new interactions to user's devices (smartphones, wearables, etc.).
+
+    A smart point of interaction is composed mainly by two entities: "Smart Point of Interaction": defines an
+    interactive point which provides information, entertainment or co-creation tools to citizens.
+    Optionally it can reference a related smart city asset with enriched interaction provided by this technology.
+    "Smart Spot": a set of resources related to a physical device and the technology to provide a Smart Point of Interaction.
+  title: SmartPointOfInteraction
+  version: "1.0.0"
+openapi: "3.0.0"
+
+# These paths are merely representative.
+paths: 
+  /ngsi-ld/v1/entities: 
+    get: 
+      description: "Retrieve a set of entities which matches a specific query from an NGSI-LD system"
+      parameters: 
+        - 
+          in: query
+          name: type
+          required: true
+          schema: 
+            enum: 
+              - SmartPointOfInteraction
+            type: string
+      responses: 
+        ? "200"
+        : 
+          content: 
+            application/ld+json: 
+              examples: 
+                keyvalues: 
+                  summary: "Key-Values Pairs"
+                  value: 
+                    - 
+                      $ref: "https://raw.githubusercontent.com/smart-data-models/dataModel.PointOfInteraction/master/SmartPointOfInteraction/example.json"
+                normalized: 
+                  summary: "Normalized NGSI-LD"
+                  value: 
+                    - 
+                      $ref: "https://raw.githubusercontent.com/smart-data-models/dataModel.PointOfInteraction/master/SmartPointOfInteraction/example-normalized-ld.jsonld"
+          description: OK
+      tags: 
+        - ngsi-ld
+tags: 
+  - 
+    description: "NGSI-LD Linked-data Format"
+    name: ngsi-ld
diff --git a/SmartSpot/schema.yaml b/SmartSpot/schema.yaml
@@ -0,0 +1,15 @@
+SmartSpot:
+  required:
+    - id
+  allOf:
+    - $ref: >-
+        https://raw.githubusercontent.com/smart-data-models/data-models/master/ngsi-ld.yaml#/Common
+  type: object
+  description: |
+    According to Wikipedia a Key Performance Indicator (KPI) is a type of performance measurement.
+    KPIs evaluate the success of an organization or of a particular activity in which it engages.
+    
+    The present data model defines a type of NGSI entity which captures the value and associated details of a key performance
+    indicator. The data model is flexible enough to accommodate different usage scenarios: An entity per KPI calculation or 
+    a unique entity per KPI which value evolves along time. Please note that in the latter case a historical module, such 
+    as the STH, would have to take care of the KPI evolution.
diff --git a/SmartSpot/swagger.yaml b/SmartSpot/swagger.yaml
@@ -0,0 +1,56 @@
+--- 
+components: 
+  schemas: 
+    SmartSpot: 
+      $ref: "https://raw.githubusercontent.com/smart-data-models/dataModel.PointOfInteraction/master/SmartSpot/schema.yaml#/SmartSpot"
+info: 
+  description: |
+    This repository is going to be archived (Jan-2020) and subsequent works will be carried out in [Smart data models]
+    (https://github.com/smart-data-models) repositories. Further questions on migration. alberto.abella@fiware.org
+    As an alternative or extension to traditional interactive points (shopping malls, museums, airports, etc.), a Smart Point of Interaction use technologies such as Bluetooth Low Energy or Wi-Fi to bring new interactions to user's devices (smartphones, wearables, etc.).
+
+    A smart point of interaction is composed mainly by two entities: "Smart Point of Interaction": defines an
+    interactive point which provides information, entertainment or co-creation tools to citizens.
+    Optionally it can reference a related smart city asset with enriched interaction provided by this technology.
+    "Smart Spot": a set of resources related to a physical device and the technology to provide a Smart Point of Interaction.
+  title: SmartSpot
+  version: "1.0.0"
+openapi: "3.0.0"
+
+# These paths are merely representative.
+paths: 
+  /ngsi-ld/v1/entities: 
+    get: 
+      description: "Retrieve a set of entities which matches a specific query from an NGSI-LD system"
+      parameters: 
+        - 
+          in: query
+          name: type
+          required: true
+          schema: 
+            enum: 
+              - SmartSpot
+            type: string
+      responses: 
+        ? "200"
+        : 
+          content: 
+            application/ld+json: 
+              examples: 
+                keyvalues: 
+                  summary: "Key-Values Pairs"
+                  value: 
+                    - 
+                      $ref: "https://raw.githubusercontent.com/smart-data-models/dataModel.PointOfInteraction/master/SmartSpot/example.json"
+                normalized: 
+                  summary: "Normalized NGSI-LD"
+                  value: 
+                    - 
+                      $ref: "https://raw.githubusercontent.com/smart-data-models/dataModel.PointOfInteraction/master/SmartSpot/example-normalized-ld.jsonld"
+          description: OK
+      tags: 
+        - ngsi-ld
+tags: 
+  - 
+    description: "NGSI-LD Linked-data Format"
+    name: ngsi-ld