@platzio/sdk 0.6.0-beta.0 → 0.6.0-beta.1-1

package/generate-sdk.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+set -eu
+
+OPENAPI_SCHEMA="$1"
+
+exec docker run --rm \
+    -v "$(pwd):/local" \
+    openapitools/openapi-generator-cli \
+    generate \
+    -i "/local/${OPENAPI_SCHEMA}" \
+    -g typescript-axios \
+    -o /local/src \
+    --additional-properties=useSingleRequestParameter=true

package/openapi.yaml

@@ -51,6 +51,126 @@ paths:
       security:
       - access_token: []
       - user_token: []
+  /api/v2/deployment-kinds:
+    get:
+      tags:
+      - Deployment Kinds
+      operationId: allDeploymentKinds
+      parameters:
+      - name: name
+        in: query
+        required: false
+        schema:
+          type: string
+          nullable: true
+      - name: page
+        in: query
+        required: false
+        schema:
+          type: integer
+          format: int64
+          nullable: true
+      - name: per_page
+        in: query
+        required: false
+        schema:
+          type: integer
+          format: int64
+          nullable: true
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                - page
+                - per_page
+                - items
+                - num_total
+                properties:
+                  page:
+                    type: integer
+                    format: int64
+                    example: '1'
+                  per_page:
+                    type: integer
+                    format: int64
+                    example: '50'
+                  items:
+                    type: array
+                    items:
+                      type: object
+                      required:
+                      - id
+                      - created_at
+                      - name
+                      properties:
+                        id:
+                          type: string
+                          format: uuid
+                        created_at:
+                          type: string
+                          format: date-time
+                        name:
+                          type: string
+                  num_total:
+                    type: integer
+                    format: int64
+                    example: '1'
+      security:
+      - access_token: []
+      - user_token: []
+  /api/v2/deployment-kinds/{id}:
+    get:
+      tags:
+      - Deployment Kinds
+      operationId: getDeploymentKind
+      parameters:
+      - name: id
+        in: path
+        required: true
+        schema:
+          type: string
+          format: uuid
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DeploymentKind'
+      security:
+      - access_token: []
+      - user_token: []
+    put:
+      tags:
+      - Deployment Kinds
+      operationId: updateDeploymentKind
+      parameters:
+      - name: id
+        in: path
+        required: true
+        schema:
+          type: string
+          format: uuid
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UpdateDeploymentKind'
+        required: true
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DeploymentKind'
+      security:
+      - access_token: []
+      - user_token: []
   /api/v2/deployment-permissions:
     get:
       tags:
@@ -108,7 +228,6 @@ paths:
                       - created_at
                       - env_id
                       - user_id
-                      - kind
                       - kind_id
                       - role
                       properties:
@@ -124,8 +243,6 @@ paths:
                         user_id:
                           type: string
                           format: uuid
-                        kind:
-                          type: string
                         kind_id:
                           type: string
                           format: uuid
@@ -210,12 +327,6 @@ paths:
           type: string
           format: uuid
           nullable: true
-      - name: deployment_kind
-        in: query
-        required: false
-        schema:
-          type: string
-          nullable: true
       - name: deployment_kind_id
         in: query
         required: false
@@ -272,7 +383,6 @@ paths:
                       - id
                       - created_at
                       - env_id
-                      - deployment_kind
                       - deployment_kind_id
                       - key
                       - spec
@@ -287,8 +397,6 @@ paths:
                           type: string
                           format: uuid
                           nullable: true
-                        deployment_kind:
-                          type: string
                         deployment_kind_id:
                           type: string
                           format: uuid
@@ -691,12 +799,6 @@ paths:
         schema:
           type: string
           nullable: true
-      - name: kind
-        in: query
-        required: false
-        schema:
-          type: string
-          nullable: true
       - name: kind_id
         in: query
         required: false
@@ -760,7 +862,6 @@ paths:
                       - id
                       - created_at
                       - name
-                      - kind
                       - kind_id
                       - cluster_id
                       - enabled
@@ -781,8 +882,6 @@ paths:
                           format: date-time
                         name:
                           type: string
-                        kind:
-                          type: string
                         kind_id:
                           type: string
                           format: uuid
@@ -1382,12 +1481,6 @@ paths:
         schema:
           type: string
           nullable: true
-      - name: kind
-        in: query
-        required: false
-        schema:
-          type: string
-          nullable: true
       - name: kind_id
         in: query
         required: false
@@ -1439,7 +1532,6 @@ paths:
                       - created_at
                       - domain_name
                       - repo_name
-                      - kind
                       - kind_id
                       - available
                       - fa_icon
@@ -1454,8 +1546,6 @@ paths:
                           type: string
                         repo_name:
                           type: string
-                        kind:
-                          type: string
                         kind_id:
                           type: string
                           format: uuid
@@ -2124,7 +2214,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/UpdateSecretApi'
+              $ref: '#/components/schemas/UpdateSecret'
         required: true
       responses:
         '200':
@@ -2866,7 +2956,6 @@ components:
       required:
       - deployment_id
       - operation
-      - execute_at
       properties:
         deployment_id:
           type: string
@@ -2958,7 +3047,6 @@ components:
       - id
       - created_at
       - name
-      - kind
       - kind_id
       - cluster_id
       - enabled
@@ -2979,8 +3067,6 @@ components:
           format: date-time
         name:
           type: string
-        kind:
-          type: string
         kind_id:
           type: string
           format: uuid
@@ -3037,6 +3123,21 @@ components:
         action_id:
           type: string
         body: {}
+    DeploymentKind:
+      type: object
+      required:
+      - id
+      - created_at
+      - name
+      properties:
+        id:
+          type: string
+          format: uuid
+        created_at:
+          type: string
+          format: date-time
+        name:
+          type: string
     DeploymentPermission:
       type: object
       required:
@@ -3044,7 +3145,6 @@ components:
       - created_at
       - env_id
       - user_id
-      - kind
       - kind_id
       - role
       properties:
@@ -3060,8 +3160,6 @@ components:
         user_id:
           type: string
           format: uuid
-        kind:
-          type: string
         kind_id:
           type: string
           format: uuid
@@ -3236,7 +3334,6 @@ components:
       - id
       - created_at
       - env_id
-      - deployment_kind
       - deployment_kind_id
       - key
       - spec
@@ -3251,8 +3348,6 @@ components:
           type: string
           format: uuid
           nullable: true
-        deployment_kind:
-          type: string
         deployment_kind_id:
           type: string
           format: uuid
@@ -3563,7 +3658,6 @@ components:
       - created_at
       - domain_name
       - repo_name
-      - kind
       - kind_id
       - available
       - fa_icon
@@ -3578,8 +3672,6 @@ components:
           type: string
         repo_name:
           type: string
-        kind:
-          type: string
         kind_id:
           type: string
           format: uuid
@@ -3734,7 +3826,6 @@ components:
     NewDeployment:
       type: object
       required:
-      - kind
       - kind_id
       - cluster_id
       - helm_chart_id
@@ -3743,8 +3834,6 @@ components:
       properties:
         name:
           type: string
-        kind:
-          type: string
         kind_id:
           type: string
           format: uuid
@@ -3780,13 +3869,10 @@ components:
     NewDeploymentResource:
       type: object
       required:
-      - id
-      - created_at
       - type_id
       - deployment_id
       - name
       - props
-      - sync_status
       properties:
         id:
           type: string
@@ -3813,13 +3899,11 @@ components:
       type: object
       required:
       - name
-      - auto_add_new_users
       properties:
         name:
           type: string
         auto_add_new_users:
           type: boolean
-          nullable: true
     NewEnvUserPermission:
       type: object
       required:
@@ -4122,14 +4206,6 @@ components:
             $ref: '#/components/schemas/ChartExtKindValuesUi'
     UpdateDeployment:
       type: object
-      required:
-      - name
-      - cluster_id
-      - helm_chart_id
-      - config
-      - values_override
-      - enabled
-      - description_md
       properties:
         name:
           type: string
@@ -4152,11 +4228,15 @@ components:
         description_md:
           type: string
           nullable: true
-    UpdateDeploymentResource:
+    UpdateDeploymentKind:
       type: object
       required:
       - name
-      - props
+      properties:
+        name:
+          type: string
+    UpdateDeploymentResource:
+      type: object
       properties:
         name:
           type: string
@@ -4165,11 +4245,6 @@ components:
           nullable: true
     UpdateEnv:
       type: object
-      required:
-      - name
-      - node_selector
-      - tolerations
-      - auto_add_new_users
       properties:
         name:
           type: string
@@ -4183,16 +4258,12 @@ components:
           nullable: true
     UpdateHelmRegistry:
       type: object
-      required:
-      - fa_icon
       properties:
         fa_icon:
           type: string
           nullable: true
     UpdateK8sCluster:
       type: object
-      required:
-      - ignore
       properties:
         env_id:
           type: string
@@ -4216,11 +4287,8 @@ components:
         grafana_datasource_name:
           type: string
           nullable: true
-    UpdateSecretApi:
+    UpdateSecret:
       type: object
-      required:
-      - name
-      - contents
       properties:
         name:
           type: string
@@ -4230,9 +4298,6 @@ components:
           nullable: true
     UpdateUser:
       type: object
-      required:
-      - is_admin
-      - is_active
       properties:
         is_admin:
           type: boolean
@@ -4298,6 +4363,8 @@ tags:
 - name: Authentication
   description: |
     APIs for logging into Platz and getting information about the current user.
+- name: Deployment Kinds
+  description: "Deployment kinds map between kind IDs and their names.\n        "
 - name: Deployment Permissions
   description: "APIs for setting deployment permissions per user.\n\nSee UserDeploymentRole for more information.\n        "
 - name: Deployment Resource Types

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@platzio/sdk",
-  "version": "0.6.0-beta.0",
+  "version": "0.6.0-beta.1-1",
   "description": "Platz.io SDK",
   "homepage": "https://platz.io",
   "repository": {
     "type": "git",
-    "url": "https://github.com/platzio/sdk-ts"
+    "url": "https://github.com/platzio/sdk-js"
   },
   "keywords": [
     "platz",
@@ -14,16 +14,16 @@
   ],
   "license": "Apache-2.0",
   "scripts": {
-    "build": "tsc --module commonjs"
+    "build": "tsup src/index.ts --format cjs,esm --dts"
   },
   "main": "dist/index.js",
-  "publishConfig": {
-    "access": "public"
-  },
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
   "peerDependencies": {
     "axios": "^1.7.5"
   },
   "devDependencies": {
+    "tsup": "^8.2.4",
     "typescript": "^5.5.4"
   }
 }