chore: Add npm test step CI

.github/workflows/openapi-test.yaml

@@ -0,0 +1,18 @@
+name: OpenAPI Test
+
+on:
+  pull_request:
+
+jobs:
+  npm-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+      - name: Test
+        run: |
+          npm install -g @apidevtools/swagger-cli
+          npm install -g @stoplight/spectral
+          npm run test

src/schemas/ClusterRequest.yaml

@@ -29,8 +29,7 @@ properties:
     example: "T3A_LARGE"
     description: the instance type to be used for this cluster. The list of values can be retrieved via the endpoint /{CloudProvider}/instanceType
   kubernetes:
-    $ref: ./enums/Kubernetes.yaml
-    default: "MANAGED"
+    $ref: './enums/Kubernetes.yaml'
   production:
     type: boolean
     description: specific flag to indicate that this cluster is a production one

src/schemas/ClusterResponse.yaml

@@ -31,8 +31,7 @@ allOf:
         example: "T3A_LARGE"
         description: the instance type to be used for this cluster. The list of values can be retrieved via the endpoint /{CloudProvider}/instanceType
       kubernetes:
-        $ref: ./enums/Kubernetes.yaml
-        default: "MANAGED"
+        $ref: './enums/Kubernetes.yaml'
       cpu:
         type: integer
         example: 10000

src/schemas/CommitResponse.yaml

@@ -1,4 +1,5 @@
 type: object
+nullable: true
 required:
   - git_commit_id
   - created_at

src/schemas/EnvironmentVariableResponse.yaml

@@ -16,13 +16,10 @@ allOf:
       service_id:
         type: string
         format: uuid
-        description: present only for `BUILT_IN` variable
       service_name:
         type: string
-        description: present only for `BUILT_IN` variable
       service_type:
         $ref: './enums/LinkedServiceType.yaml'
-        description: present only for `BUILT_IN` variable
       owned_by:
         type: string
         description: "Entity that created/own the variable (i.e: Qovery, Doppler)"

src/schemas/Healthcheck.yaml

@@ -3,7 +3,5 @@ nullable: false
 properties:
   readiness_probe:
     $ref: './Probe.yaml'
-    nullable: true
   liveness_probe:
     $ref: './Probe.yaml'
-    nullable: true

src/schemas/InviteMemberRequest.yaml

@@ -6,7 +6,6 @@ properties:
     type: string
   role:
     $ref: './enums/InviteMemberRole.yaml'
-    description: deprecated
   role_id:
     type: string
     format: uuid

src/schemas/InviteMemberResponse.yaml

@@ -13,7 +13,6 @@
          format: email
        role:
          $ref: './enums/InviteMemberRole.yaml'
-         description: deprecated
        invitation_link:
          type: string
          format: uri

src/schemas/MemberResponse.yaml

@@ -20,7 +20,6 @@ allOf:
         description: last time the user was connected
       role:
         $ref: './enums/InviteMemberRole.yaml'
-        description: deprecated
       role_name:
         type: string
         description: the role linked to the user

src/schemas/OrganizationEventResponse.yaml

@@ -15,16 +15,12 @@ properties:
   target_name:
     type: string
   target_type:
-    type: string
     $ref: './enums/OrganizationEventTargetType.yaml'
   sub_target_type:
-    type: string
-    nullable: true
     $ref: './enums/OrganizationEventSubTargetType.yaml'
   change:
     type: string
   origin:
-    type: string
     $ref: './enums/OrganizationEventOrigin.yaml'
   triggered_by:
     type: string

src/schemas/Probe.yaml

@@ -1,4 +1,5 @@
 type: object
+nullable: true
 properties:
   type:
     type: object

src/schemas/SecretResponse.yaml

@@ -19,13 +19,10 @@ allOf:
       service_id:
         type: string
         format: uuid
-        description: present only for `BUILT_IN` variable
       service_name:
         type: string
-        description: present only for `BUILT_IN` variable
       service_type:
         $ref: './enums/LinkedServiceType.yaml'
-        description: present only for `BUILT_IN` variable
       owned_by:
         type: string
         description: "Entity that created/own the variable (i.e: Qovery, Doppler)"

src/schemas/enums/Kubernetes.yaml

@@ -1,4 +1,5 @@
 type: string
 enum:
   - "K3S"
-  - "MANAGED"
+  - "MANAGED"
+default: "MANAGED"

src/schemas/enums/LinkedServiceType.yaml

@@ -1,7 +1,5 @@
 type: string
-description: |
-  type of the service (application, database, job, gateway...)  
-  present only for `BUILT_IN` variable
+description: type of the service (application, database, job, gateway...)
 enum:
   - APPLICATION
   - CONTAINER

src/schemas/enums/OrganizationEventSubTargetType.yaml

@@ -1,5 +1,6 @@
 type: string
 description: Type of the organization event
+nullable: true
 enum:
   - ADVANCED_SETTINGS
   - API_TOKEN

src/schemas/job/DeploymentHistoryJobResponse.yaml

@@ -13,7 +13,6 @@ allOf:
         type: string
       commit:
         $ref: '../CommitResponse.yaml'
-        nullable: true
       schedule:
         type: object
         properties:

src/schemas/variable/VariableResponse.yaml

@@ -15,13 +15,12 @@ allOf:
       service_id:
         type: string
         format: uuid
-        description: The id of the service referenced by this variable. present only for `BUILT_IN` variable
+        description: The id of the service referenced by this variable.
       service_name:
         type: string
-        description: The name of the service referenced by this variable. present only for `BUILT_IN` variable
+        description: The name of the service referenced by this variable.
       service_type:
         $ref: '../enums/LinkedServiceType.yaml'
-        description: present only for `BUILT_IN` variable
       owned_by:
         type: string
         description: "Entity that created/own the variable (i.e: Qovery, Doppler)"