feat: add postman step

Author: CasLubbers

.DS_Store

@@ -64,6 +64,14 @@ jobs:
             sleep 10
           done
           echo "API is ready!"
+      - name: Install Postman CLI
+        run: |
+          curl -o- "https://dl-cli.pstmn.io/install/linux64.sh" | sh
+      - name: Login to Postman CLI
+        run: postman login --with-api-key ${{ secrets.POSTMAN_API_KEY }}
+      - name: Run API tests
+        run: |
+          postman collection run "44183872-d3b3cdc9-ba1f-4a71-bcba-6a3cb3dc9643" -e "43715313-d380e919-5142-44e6-b52c-02f8b04da8fa"
       - name: Show logs
         run: |
           echo "::group::Core Server Logs"

.github/workflows/postman.yml

@@ -2598,7 +2598,6 @@ components:
           type: object
           properties:
             name:
-              example: name
               $ref: 'definitions.yaml#/idName'
           required:
             - name
@@ -2611,12 +2610,11 @@ components:
           type: object
           properties:
             name:
-              type: string
+              $ref: 'definitions.yaml#/idName'
             labels:
               type: object
               properties:
                 apl.io/teamId:
-                  example: team-name
                   $ref: 'definitions.yaml#/idName'
               required:
                 - apl.io/teamId

src/openapi/api.yaml

@@ -118,9 +118,11 @@ buildMode:
                   name:
                     title: Name
                     type: string
+                    example: MY_ENV_VAR
                   value:
                     title: Value
                     type: string
+                    example: my-value
                 required:
                   - name
                   - value

src/openapi/build.yaml

@@ -59,6 +59,7 @@ AplCodeRepoSpec:
       default: false
     secret:
       type: string
+      example: my-secret
   required:
     - gitService
     - repositoryUrl

src/openapi/codeRepo.yaml

@@ -108,6 +108,7 @@ alerts:
 annotation:
   type: string
   pattern: ^((.){1,253}\/)?(.){1,63}$
+  example: apl.io/annotation
 annotations:
   description: Kubernetes annotations with arbitrary metadata
   type: array
@@ -119,6 +120,7 @@ annotations:
       value:
         type: string
         maxLength: 32767
+        example: apl-value
 autoscaling:
   type: object
   properties:
@@ -625,6 +627,7 @@ idName:
   pattern: ^[a-z]([-a-z0-9]*[a-z0-9])+$
   type: string
   x-message: a valid name that consists of lowercase letters, dashes
+  example: team-name
 image:
   allOf:
     - properties:
@@ -654,6 +657,7 @@ imageTag:
   pattern: '[\w][\w.-]{0,127}'
   type: string
   x-message: a valid container registry image tag
+  example: latest
 imageSimple:
   properties:
     tag:
@@ -951,6 +955,7 @@ repoUrl:
   pattern: ^(.+@)*([\w\d\.]+)(:[\d]+){0,1}/*(.*)$
   type: string
   x-message: a valid git repo URL
+  example: github.com/example/repo
 resource:
   properties:
     cpu:
@@ -1106,6 +1111,7 @@ svcPredeployed:
 url:
   pattern: ^https?:\/\/[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&\/=]*)
   type: string
+  example: https://gituhb.com/example
 vaultToken:
   title: Token
   type: string

src/openapi/definitions.yaml

@@ -55,10 +55,12 @@ ruleType:
           type: string
           title: Selector label name
           description: 'The name of the Pod selector label.'
+          example: app
         toLabelValue:
           type: string
           title: Selector label value
           description: 'The value of the Pod selector label.'
+          example: my-app
         mode:
           type: string
           default: AllowAll
@@ -80,10 +82,12 @@ ruleType:
                 type: string
                 title: Selector label name
                 description: 'The name of the Pod selector label.'
+                example: app
               fromLabelValue:
                 type: string
                 title: Selector label value
                 description: 'The value of the Pod selector label.'
+                example: my-app
             required:
               - fromNamespace
       required:

src/openapi/netpol.yaml

@@ -308,9 +308,11 @@ AplServiceSpec:
                   name:
                     title: Name
                     type: string
+                    example: my-header
                   value:
                     title: Value
                     type: string
+                    example: my-value
                 required:
                   - name
                   - value