Re-generate clients with additional endpoints (#87)

rjtokenring · web-flow · commit 647c963412e4 · 2024-07-03T09:57:56.000+02:00
* Client re-generation with new endpoints

* Swagger updated
diff --git a/config/languages/go_v2.json b/config/languages/go_v2.json
@@ -3,6 +3,6 @@
     "gitRepoId": "iot-client-go",
     "isGoSubmodule": false,
     "packageName": "iot",
-    "packageVersion": "2.0.3",
+    "packageVersion": "2.0.4",
     "withGoCodegenComment": true
 }
diff --git a/config/languages/html2_v2.json b/config/languages/html2_v2.json
@@ -1,5 +1,5 @@
 {
     "packageName": "iot",
-    "packageVersion": "2.0.3",
+    "packageVersion": "2.0.4",
     "usePromises": true
 }
diff --git a/config/languages/javascript_v2.json b/config/languages/javascript_v2.json
@@ -1,8 +1,8 @@
 {
     "projectName": "@arduino/arduino-iot-client",
     "moduleName": "ArduinoIotClient",
-    "projectVersion": "2.0.3",
-    "packageVersion": "2.0.3",
+    "projectVersion": "2.0.4",
+    "packageVersion": "2.0.4",
     "usePromises": true,
     "licenseName":"GPLv3",
     "generateSourceCodeOnly": true
diff --git a/config/languages/python_v2.json b/config/languages/python_v2.json
@@ -1,6 +1,6 @@
 {
     "packageName": "iot_api_client",
     "projectName": "arduino-iot-client",
-    "packageVersion": "2.0.3",
+    "packageVersion": "2.0.4",
     "generateSourceCodeOnly": false
 }
diff --git a/spec/v2/swagger.yaml b/spec/v2/swagger.yaml
@@ -51,6 +51,36 @@ components:
       - signature_asn1_y
       title: 'Mediatype identifier: application/vnd.arduino.compressedv2; view=default'
       type: object
+    ArduinoCredentialsv1:
+      description: ArduinoCredentialsv1 media type (default view)
+      properties:
+        friendly_name:
+          description: Friendly name
+          type: string
+        required:
+          description: Tell if the parameter is required or not
+          type: boolean
+        secret_name:
+          description: The secret parameter name
+          type: string
+        sensitive:
+          description: Tell if the field is sensitive
+          type: boolean
+      required:
+      - secret_name
+      - required
+      - friendly_name
+      - sensitive
+      title: 'Mediatype identifier: application/vnd.arduino.credentialsv1+json; view=default'
+      type: object
+    ArduinoCredentialsv1Collection:
+      description: ArduinoCredentialsv1Collection is the media type for an array of
+        ArduinoCredentialsv1 (default view)
+      items:
+        $ref: '#/components/schemas/ArduinoCredentialsv1'
+      title: 'Mediatype identifier: application/vnd.arduino.credentialsv1+json; type=collection;
+        view=default'
+      type: array
     ArduinoDashboardowner:
       description: ArduinoDashboardowner media type (default view)
       properties:
@@ -1105,6 +1135,25 @@ components:
       - tags
       title: 'Mediatype identifier: application/vnd.arduino.tags+json; view=default'
       type: object
+    ArduinoTemplate:
+      description: ArduinoTemplate media type (default view)
+      properties:
+        dashboards:
+          items:
+            format: uuid
+            type: string
+          type: array
+        things:
+          $ref: '#/components/schemas/ArduinoThingresultCollection'
+        triggers:
+          items:
+            format: uuid
+            type: string
+          type: array
+      required:
+      - things
+      title: 'Mediatype identifier: application/vnd.arduino.template+json; view=default'
+      type: object
     ArduinoTemplateproperty:
       description: ArduinoTemplateproperty media type (default view)
       properties:
@@ -1277,6 +1326,34 @@ components:
       title: 'Mediatype identifier: application/vnd.arduino.thing+json; type=collection;
         view=default'
       type: array
+    ArduinoThingresult:
+      description: ArduinoThingresult media type (default view)
+      properties:
+        device_id:
+          description: UUID of the attached device
+          format: uuid
+          type: string
+        id:
+          description: UUID of the created Thing
+          format: uuid
+          type: string
+        sketch_id:
+          description: UUID of the created Sketch
+          format: uuid
+          type: string
+      required:
+      - id
+      - sketch_id
+      title: 'Mediatype identifier: application/vnd.arduino.thingresult+json; view=default'
+      type: object
+    ArduinoThingresultCollection:
+      description: ArduinoThingresultCollection is the media type for an array of
+        ArduinoThingresult (default view)
+      items:
+        $ref: '#/components/schemas/ArduinoThingresult'
+      title: 'Mediatype identifier: application/vnd.arduino.thingresult+json; type=collection;
+        view=default'
+      type: array
     ArduinoThingtemplate:
       description: ArduinoThingtemplate media type (default view)
       properties:
@@ -2411,6 +2488,29 @@ components:
       - value
       title: tag
       type: object
+    template:
+      description: TemplatePayload describes the needed attribute to apply a template
+      properties:
+        custom_template_id:
+          description: The name of the directory on S3 bucket containing the user's
+            template
+          type: string
+        prefix_name:
+          description: The prefix to apply to the names of the generated resources
+          maxLength: 45
+          pattern: ^[a-zA-Z0-9_. -]+$
+          type: string
+        template_name:
+          description: The name of the directory on S3 bucket containing the template
+          example: remote-controlled-lights
+          type: string
+        things_options:
+          additionalProperties: true
+          type: object
+      required:
+      - template_name
+      title: template
+      type: object
     thingSketch:
       description: ThingSketchPayload describes a sketch of a thing
       properties:
@@ -2626,6 +2726,173 @@ paths:
       summary: list lora_freq_plan_v1
       tags:
       - lora_freq_plan_v1
+  /v1/network_credentials/{type}:
+    get:
+      description: Show required network credentials depending on device type
+      operationId: network_credentials_v1#show
+      parameters:
+      - description: Connection used by the device
+        in: query
+        name: connection
+        schema:
+          enum:
+          - wifi
+          - eth
+          - wifiandsecret
+          - gsm
+          - nb
+          - lora
+          - catm1
+          - cellular
+          type: string
+      - description: Device type
+        in: path
+        name: type
+        required: true
+        schema:
+          enum:
+          - mkrwifi1010
+          - mkr1000
+          - nano_33_iot
+          - mkrgsm1400
+          - mkrwan1310
+          - mkrwan1300
+          - mkrnb1500
+          - lora-device
+          - login_and_secretkey_wifi
+          - envie_m7
+          - nanorp2040connect
+          - nicla_vision
+          - opta
+          - giga
+          - portenta_c33
+          - unor4wifi
+          - nano_nora
+          type: string
+      responses:
+        "200":
+          content:
+            application/vnd.arduino.credentialsv1+json; type=collection:
+              schema:
+                $ref: '#/components/schemas/ArduinoCredentialsv1Collection'
+          description: OK
+        "401":
+          description: Unauthorized
+        "404":
+          description: Not Found
+      summary: show network_credentials_v1
+      tags:
+      - network_credentials_v1
+  /v1/network_credentials/{type}/connections:
+    get:
+      description: Show available connection types depending on device type
+      operationId: network_credentials_v1#showByDevice
+      parameters:
+      - description: Device type
+        in: path
+        name: type
+        required: true
+        schema:
+          enum:
+          - mkrwifi1010
+          - mkr1000
+          - nano_33_iot
+          - mkrgsm1400
+          - mkrwan1310
+          - mkrwan1300
+          - mkrnb1500
+          - lora-device
+          - login_and_secretkey_wifi
+          - envie_m7
+          - nanorp2040connect
+          - nicla_vision
+          - opta
+          - giga
+          - portenta_c33
+          - unor4wifi
+          - nano_nora
+          type: string
+      responses:
+        "200":
+          description: OK
+        "401":
+          description: Unauthorized
+        "404":
+          description: Not Found
+      summary: showByDevice network_credentials_v1
+      tags:
+      - network_credentials_v1
+  /v1/templates:
+    put:
+      description: Apply an existing cloud template and generate all the needed resources
+      operationId: templates#apply
+      parameters:
+      - in: header
+        name: X-Organization
+        schema:
+          type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/template'
+          application/x-www-form-urlencoded:
+            schema:
+              $ref: '#/components/schemas/template'
+        description: TemplatePayload describes the needed attribute to apply a template
+        required: true
+        x-originalParamName: payload
+      responses:
+        "200":
+          content:
+            application/vnd.arduino.template+json:
+              schema:
+                $ref: '#/components/schemas/ArduinoTemplate'
+            application/vnd.goa.error+json:
+              schema:
+                $ref: '#/components/schemas/ArduinoTemplate'
+          description: OK
+        "400":
+          content:
+            application/vnd.arduino.template+json:
+              schema:
+                $ref: '#/components/schemas/error'
+            application/vnd.goa.error+json:
+              schema:
+                $ref: '#/components/schemas/error'
+          description: Bad Request
+        "401":
+          description: Unauthorized
+        "404":
+          content:
+            application/vnd.arduino.template+json:
+              schema:
+                $ref: '#/components/schemas/error'
+            application/vnd.goa.error+json:
+              schema:
+                $ref: '#/components/schemas/error'
+          description: Not Found
+        "409":
+          content:
+            application/vnd.arduino.template+json:
+              schema:
+                $ref: '#/components/schemas/error'
+            application/vnd.goa.error+json:
+              schema:
+                $ref: '#/components/schemas/error'
+          description: Conflict
+        "500":
+          content:
+            application/vnd.arduino.template+json:
+              schema:
+                $ref: '#/components/schemas/error'
+            application/vnd.goa.error+json:
+              schema:
+                $ref: '#/components/schemas/error'
+          description: Internal Server Error
+      summary: apply templates
+      tags:
+      - templates
   /v2/dashboards:
     get:
       description: Returns the list of dashboards

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,6 @@`
`3`	`3`	`"gitRepoId": "iot-client-go",`
`4`	`4`	`"isGoSubmodule": false,`
`5`	`5`	`"packageName": "iot",`
`6`		`- "packageVersion": "2.0.3",`
	`6`	`+ "packageVersion": "2.0.4",`
`7`	`7`	`"withGoCodegenComment": true`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`	`2`	`"packageName": "iot",`
`3`		`- "packageVersion": "2.0.3",`
	`3`	`+ "packageVersion": "2.0.4",`
`4`	`4`	`"usePromises": true`
`5`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"packageName": "iot_api_client",`
`3`	`3`	`"projectName": "arduino-iot-client",`
`4`		`- "packageVersion": "2.0.3",`
	`4`	`+ "packageVersion": "2.0.4",`
`5`	`5`	`"generateSourceCodeOnly": false`
`6`	`6`	`}`