MuranoCLI 3.2.0.beta.1 → 3.2.0.beta.5

data/spec/fixtures/exchange_element/swagger-mur-6407__10k.yaml

@@ -0,0 +1,282 @@
+swagger: "2.0"
+
+################################################################################
+#                           Service Metadata                                   #
+################################################################################
+info:
+  version: "1.0"
+  title: Transformer
+  description: |
+    This service is for Transforming SignalData.
+  contact:
+    name: Exosite Exosite Exosite Exosite
+    email: exosite@exosite.com
+
+################################################################################
+#                            API Information                                   #
+################################################################################
+
+# A hostname with a valid, signed, and active TSL certificate is required.
+host: transformer-dev.hosted.exosite.io
+basePath: /api/v1
+schemes:
+  - https
+consumes:
+  - application/json
+produces:
+  - application/json
+
+################################################################################
+#                          Solution lifecycle Events                           #
+################################################################################
+# Following Operation should generally be restricted with "x-exosite-restricted: true"
+x-exosite-init: createSolution # Triggered by Murano when this service is enabled in a solution
+x-exosite-info: getSolution # Triggered by Murano to retrieve custom information about the service solution namespace
+x-exosite-update: updateSolution # Triggered by Murano when the solution service configuration is updated
+x-exosite-gc: delSolution # Triggered by Murano when the service is removed from a solution or if the solution is deleted
+
+################################################################################
+#                      Service Configuration Parameters                        #
+################################################################################
+x-exosite-config-parameters:
+  - name: maximumTTL
+    type: number
+    description: Maximum number of times a message can propagate through
+    required: true # Indicates this parameter is required during configuration
+  - name: authToken
+    type: string
+    description: This is a placeholder for a potential future feature.
+    required: true # the only option that works is true…
+  - name: eventURI
+    type: string
+    description: This is a placeholder for a potential future feature.
+    required: true # the only option that works is true…
+
+################################################################################
+#                                Operations                                    #
+################################################################################
+paths:
+  /:
+    get:
+      description: Alive check
+      operationId: alive
+      x-exosite-restricted: true # Indicate that this operation cannot be called from user scripts
+      responses:
+        "200":
+          description: Solution successfully created
+        default:
+          description: Error
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+
+  # Administration endpoint used by Murano solution lifecycle events
+  # Those operation uses the "x-exosite-restricted" to prevent the user to access them directly
+  /{solution_id}:
+    parameters:
+      - name: solution_id
+        x-exosite-from: solution_id # Indicate this value is injected from the user solution_id
+        x-exosite-restricted: true # Indicate the user cannot provide this parameter
+        type: string
+        in: path
+        description: The solution identifier. Set automatically.
+        required: true
+    post:
+      description: Used by Murano to create a solution namespace.
+      operationId: createSolution
+      x-exosite-restricted: true # Indicate that this operation cannot be called from user scripts
+      parameters:
+        - name: settings
+          in: body
+          description: The service settings for a solution.
+          required: true
+          schema:
+            $ref: "#/definitions/SolutionSettings"
+      responses:
+        "200":
+          description: Solution successfully created
+        default:
+          description: Error
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+    get:
+      description: Used by Murano to get the solution settings.
+      operationId: getSolution
+      responses:
+        "200":
+          description: Solution settings
+          schema:
+            $ref: "#/definitions/SolutionInfo"
+        default:
+          description: Error
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+    put:
+      description: Used by Murano to update the solution settings.
+      operationId: updateSolution
+      x-exosite-restricted: true
+      parameters:
+        - name: settings
+          in: body
+          description: The service settings for a solution.
+          required: true
+          schema:
+            $ref: "#/definitions/SolutionSettings"
+      responses:
+        "205":
+          description: Settings updated
+        default:
+          description: Error
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+    delete:
+      description: Used by Murano to remove a solution and clean its namespace.
+      operationId: delSolution
+      x-exosite-restricted: true
+      responses:
+        "205":
+          description: Solution successfully removed.
+        default:
+          description: Error
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+
+  # Service operations available from scripting
+  /{solution_id}/transform:
+    parameters:
+      - name: solution_id
+        type: string
+        in: path
+        description: The solution identifier. Set automatically by Murano at service call.
+        x-exosite-from: solution_id # Indicate this value is injected from the user solution_id
+        x-exosite-restricted: true # Indicate the user cannot provide this parameter
+        required: true
+    post:
+      description: Create Transform
+      operationId: create
+      x-exosite-example: |
+        local res = Transformer.create{
+            subscribe = {"topic.name"},
+            tags = {"asset-42"},
+            select = "value * 24"
+        }
+        -- res.id is the UUID assigned to the new transform.
+
+      parameters:
+        - name: body
+          in: body
+          description: The Transform to create.
+          required: true
+          schema:
+            $ref: "#/definitions/Transformation"
+      responses:
+        "200":
+          description: Transform successfully saved
+          schema:
+            type: object
+            description: Transformation Id Object
+            properties:
+              id:
+                description: Transform ID
+                type: string
+        default:
+          description: Error
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+    get:
+      description: Retrieve Transform from the solution namespace.
+      operationId: list
+      x-exosite-example: |
+
+        -- list Transforms with all of a specified tag
+        tag1 = "lkj32lk3lkj3"
+        tag2 = "lkj32lk3xyds"
+        rule = Transformer.list({all={tag1, tag2}})
+
+        --------------------------------------------------
+
+        -- list Transforms with any of a specified tag
+        tag1 = "lkj32lk3lkj3"
+        tag2 = "lkj32lk3xyds"
+        rule = Transformer.list({any={tag1, tag2}})
+
+        --------------------------------------------------
+
+        -- list Transforms with any of a specified tag and all of another tag
+        tag1 = "lkj32lk3lkj3"
+        tag2 = "lkj32lk3xyds"
+        rule = Transformer.list({any={tag2, tag3}, all={tag1, tag4}})
+        -- That is, (tag1 && tag4 && (tag2 || tag3))
+
+      parameters:
+        - name: tags_all
+          in: query
+          description: If present, only return Transforms with all of the listed tags
+          type: array
+          items:
+            type: string
+        - name: tags_any
+          in: query
+          description: If present, only return Transforms with any of the listed tags
+          type: array
+          items:
+            type: string
+        - name: limit
+          in: query
+          description: Maximum results to return
+          type: integer
+        - name: offset
+          in: query
+          description: Offset into results
+          type: integer
+      responses:
+        "200":
+          description: Successfully returned the Transforms for this solution
+          schema:
+            $ref: "#/definitions/TransformationArray"
+        default:
+          description: Error
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+
+    delete:
+      description: Delete multiple Transforms by matching tags
+      operationId: deleteByTags
+      x-exosite-example: |
+
+        -- delete Transform with all of a specified tag
+        tag1 = "lkj32lk3lkj3"
+        tag2 = "lkj32lk3xyds"
+        rule = Transformer.deleteByTags({all={tag1, tag2}})
+
+        --------------------------------------------------
+
+        -- delete Transform with any of a specified tag
+        tag1 = "lkj32lk3lkj3"
+        tag2 = "lkj32lk3xyds"
+        rule = Transformer.deleteByTags({any={tag1, tag2}})
+
+        --------------------------------------------------
+
+        -- delete Transform with any of a specified tag and all of another tag
+        tag1 = "lkj32lk3lkj3"
+        tag2 = "lkj32lk3xyds"
+        rule = Transformer.deleteByTags({any={tag2, tag3}, all={tag1, tag4}})
+        -- That is, (tag1 && tag4 && (tag2 || tag3))
+      parameters:
+        - name: all
+          in: query
+          description: If present, only delete Transforms with all listed tags
+          required: false
+          type: array
+          items:
+            type: string
+        - name: any
+          in: query
+          description: Delete Transforms with any listed tags
+          required: true
+          type: array
+          items:
+            type: string
+      responses:
+        "205":
+          description