Merge pull request #6 from meshcloud/feature/meshworkspace

feat: update API version for meshCustomer to meshWorkspace rename
meshcloud · Aug 2, 2023 · c9ba775 · c9ba775
2 parents 812ec2a + e01a7c9
commit c9ba775
Show file tree

Hide file tree

Showing 20 changed files with 83 additions and 77 deletions.
diff --git a/.github/workflows/ci_workflow.yml b/.github/workflows/ci_workflow.yml
@@ -4,7 +4,7 @@ on: [push]
 
 jobs:
   pytest:
-
+    timeout-minutes: 5
     runs-on: ubuntu-latest
     env:
       GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
@@ -13,9 +13,9 @@ jobs:
         python-version: [3.7, 3.8, 3.9]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install Poetry

diff --git a/README.md b/README.md
@@ -53,13 +53,13 @@ schemas can more handle easily handle the dynamic schema nature of tags.
 
 > Note that meshObject tag schemas can also be different from object to object in the same collection.
 
-Consider the following example to understand how the transformation works. The `meshCustomer` has the following
+Consider the following example to understand how the transformation works. The `meshWorkspace` has the following
 JSON representation in the meshObject API:
 
 ```json
 {
   "apiVersion": "v1",
-  "kind": "meshCustomer",
+  "kind": "meshWorkspace",
   "metadata": {
       "name": "customer",
       "createdOn": "2021-01-25T10:28:38Z"
@@ -78,7 +78,7 @@ The tap transforms this object into the following record representation
 ```json
 {
   "apiVersion": "v1",
-  "kind": "meshCustomer",
+  "kind": "meshWorkspace",
   "metadata": {
       "name": "customer",
       "createdOn": "2021-01-25T10:28:38Z"

diff --git a/makeSchemas.sh b/makeSchemas.sh
@@ -16,7 +16,7 @@ main() {
   if [[ -z $krakenApiSpecFile ]]; then usage "openapi.yaml file argument for kraken missing"; fi;
 
   # meshfed-api
-  extractSchema "$apiSpecFile" "meshCustomer"
+  extractSchema "$apiSpecFile" "meshWorkspace"
   extractSchema "$apiSpecFile" "meshProject"
   extractSchema "$apiSpecFile" "meshPaymentMethod"
   extractSchema "$apiSpecFile" "meshTenant"

diff --git a/meltano.yml b/meltano.yml
@@ -12,7 +12,7 @@ plugins:
     - discover
     # TODO: please configure your meshObjects you want to add to the data ware house
     select:
-      - meshCustomers.*
+      - meshWorkspaces.*
       - meshProjects.*
       - meshPaymentMethods.*
       - meshTenants.*

diff --git a/stub/meshobjects/meshchargebacks.json b/stub/meshobjects/meshchargebacks.json
@@ -2,14 +2,14 @@
   "_embedded": {
       "meshChargebacks": [
           {
-              "apiVersion": "v1",
+              "apiVersion": "v2",
               "kind": "meshChargeback",
               "metadata": {
                   "name": "2022-06-06Z/demo-partner:unipipe-video:unipipe-service-broker-dev",
                   "createdOn": "2022-06-28T08:39:46.950195Z"
               },
               "spec": {
-                  "customerIdentifier": "unipipe-video",
+                  "workspaceIdentifier": "unipipe-video",
                   "projectIdentifier": "unipipe-service-broker-dev",
                   "partnerIdentifier": "demo-partner",
                   "period": "2022-06-06Z",

diff --git a/stub/meshobjects/meshchargebacks?page=1&size=1.json b/stub/meshobjects/meshchargebacks?page=1&size=1.json
@@ -2,14 +2,14 @@
   "_embedded": {
       "meshChargebacks": [
           {
-              "apiVersion": "v1",
+              "apiVersion": "v2",
               "kind": "meshChargeback",
               "metadata": {
                   "name": "2022-06-06Z/demo-partner:unipipe-video:unipipe-service-broker-dev",
                   "createdOn": "2022-06-28T08:39:46.950195Z"
               },
               "spec": {
-                  "customerIdentifier": "unipipe-video",
+                  "workspaceIdentifier": "unipipe-video",
                   "projectIdentifier": "unipipe-service-broker-dev",
                   "partnerIdentifier": "demo-partner",
                   "period": "2022-06-06Z",

diff --git a/stub/meshobjects/meshpaymentmethods.json b/stub/meshobjects/meshpaymentmethods.json
@@ -2,11 +2,11 @@
     "_embedded": {
         "meshPaymentMethods": [
             {
-                "apiVersion": "v1",
+                "apiVersion": "v2",
                 "kind": "meshPaymentMethod",
                 "metadata": {
                     "name": "default",
-                    "ownedByCustomer": "managed-customer"
+                    "ownedByWorkspace": "managed-customer"
                 },
                 "spec": {
                     "displayName": "Default",

diff --git a/stub/meshobjects/meshprojects.json b/stub/meshobjects/meshprojects.json
@@ -2,11 +2,11 @@
   "_embedded": {
     "meshProjects": [
       {
-        "apiVersion": "v1",
+        "apiVersion": "v2",
         "kind": "meshProject",
         "metadata": {
           "name": "test-metrics-metering-dev",
-          "ownedByCustomer": "managed-customer",
+          "ownedByWorkspace": "managed-customer",
           "createdOn": "2021-01-27T07:49:12Z"
         },
         "spec": {
@@ -22,11 +22,11 @@
             "href": "http://localhost:8000/api/meshobjects/meshprojects/managed-customer.test-metrics-metering-dev"
           },
           "meshtenants": {
-            "href": "http://localhost:8000/api/meshobjects/meshtenants?customerIdentifier=managed-customer&projectIdentifier=test-metrics-metering-dev{&platformIdentifier}",
+            "href": "http://localhost:8000/api/meshobjects/meshtenants?workspaceIdentifier=managed-customer&projectIdentifier=test-metrics-metering-dev{&platformIdentifier}",
             "templated": true
           },
           "meshusers": {
-            "href": "http://localhost:8000/api/meshobjects/meshusers?customerIdentifier=managed-customer&projectIdentifier=test-metrics-metering-dev{&platformIdentifier,customerRole,projectRole}",
+            "href": "http://localhost:8000/api/meshobjects/meshusers?workspaceIdentifier=managed-customer&projectIdentifier=test-metrics-metering-dev{&platformIdentifier,customerRole,projectRole}",
             "templated": true
           },
           "activePaymentMethod": {

diff --git a/stub/meshobjects/meshtenants.json b/stub/meshobjects/meshtenants.json
@@ -2,11 +2,11 @@
   "_embedded": {
     "meshTenants": [
       {
-        "apiVersion": "v2",
+        "apiVersion": "v3",
         "kind": "meshTenant",
         "metadata": {
           "ownedByProject": "tenant-import-aws-dev",
-          "ownedByCustomer": "managed-customer",
+          "ownedByWorkspace": "managed-customer",
           "platformIdentifier": "aws.aws-meshstack-dev",
           "assignedTags": {
             "environment": ["dev"],
@@ -26,7 +26,7 @@
             "href": "http://localhost:8000/api/meshobjects/meshtenants/managed-customer.tenant-import-aws-dev.aws.aws-meshstack-dev"
           },
           "meshusers": {
-            "href": "http://localhost:8000/api/meshobjects/meshusers?customerIdentifier=managed-customer&projectIdentifier=tenant-import-aws-dev&platformIdentifier=aws.aws-meshstack-dev{&customerRole,projectRole}",
+            "href": "http://localhost:8000/api/meshobjects/meshusers?workspaceIdentifier=managed-customer&projectIdentifier=tenant-import-aws-dev&platformIdentifier=aws.aws-meshstack-dev{&customerRole,projectRole}",
             "templated": true
           }
         }

diff --git a/stub/meshobjects/meshcustomers.json → stub/meshobjects/meshworkspaces.json b/stub/meshobjects/meshcustomers.json → stub/meshobjects/meshworkspaces.json
@@ -1,9 +1,9 @@
 {
   "_embedded": {
-      "meshCustomers": [
+      "meshWorkspaces": [
           {
               "apiVersion": "v1",
-              "kind": "meshCustomer",
+              "kind": "meshWorkspace",
               "metadata": {
                   "name": "admin-customer",
                   "createdOn": "2021-01-25T10:28:38Z"
@@ -16,38 +16,38 @@
               },
               "_links": {
                   "self": {
-                      "href": "http://localhost:8000/api/meshobjects/meshcustomers/admin-customer"
+                      "href": "http://localhost:8000/api/meshobjects/meshworkspaces/admin-customer"
                   },
                   "meshtenants": {
-                      "href": "http://localhost:8000/api/meshobjects/meshtenants?customerIdentifier=admin-customer{&projectIdentifier,platformIdentifier}",
+                      "href": "http://localhost:8000/api/meshobjects/meshtenants?workspaceIdentifier=admin-customer{&projectIdentifier,platformIdentifier}",
                       "templated": true
                   },
                   "meshprojects": {
-                      "href": "http://localhost:8000/api/meshobjects/meshprojects?customerIdentifier=admin-customer"
+                      "href": "http://localhost:8000/api/meshobjects/meshprojects?workspaceIdentifier=admin-customer"
                   },
                   "meshusers": {
-                      "href": "http://localhost:8000/api/meshobjects/meshusers?customerIdentifier=admin-customer{&projectIdentifier,platformIdentifier,customerRole,projectRole}",
+                      "href": "http://localhost:8000/api/meshobjects/meshusers?workspaceIdentifier=admin-customer{&projectIdentifier,platformIdentifier,customerRole,projectRole}",
                       "templated": true
                   },
                   "meshpaymentmethods": {
-                      "href": "http://localhost:8000/api/meshobjects/meshpaymentmethods?customerIdentifier=admin-customer"
+                      "href": "http://localhost:8000/api/meshobjects/meshpaymentmethods?workspaceIdentifier=admin-customer"
                   }
               }
           }
       ]
   },
   "_links": {
       "first": {
-          "href": "http://localhost:8000/api/meshobjects/meshcustomers?page=0&size=1"
+          "href": "http://localhost:8000/api/meshobjects/meshworkspaces?page=0&size=1"
       },
       "self": {
-          "href": "http://localhost:8000/api/meshobjects/meshcustomers?size=1"
+          "href": "http://localhost:8000/api/meshobjects/meshworkspaces?size=1"
       },
       "next": {
-          "href": "http://localhost:8000/api/meshobjects/meshcustomers?page=1&size=1"
+          "href": "http://localhost:8000/api/meshobjects/meshworkspaces?page=1&size=1"
       },
       "last": {
-          "href": "http://localhost:8000/api/meshobjects/meshcustomers?page=44&size=1"
+          "href": "http://localhost:8000/api/meshobjects/meshworkspaces?page=44&size=1"
       }
   },
   "page": {

diff --git a/...hobjects/meshcustomers?page=1&size=1.json → ...objects/meshworkspaces?page=1&size=1.json b/...hobjects/meshcustomers?page=1&size=1.json → ...objects/meshworkspaces?page=1&size=1.json
@@ -1,9 +1,9 @@
 {
     "_embedded": {
-        "meshCustomers": [
+        "meshWorkspaces": [
             {
                 "apiVersion": "v1",
-                "kind": "meshCustomer",
+                "kind": "meshWorkspace",
                 "metadata": {
                     "name": "demo-customer",
                     "createdOn": "2021-01-25T10:28:38Z"
@@ -21,35 +21,35 @@
                 },
                 "_links": {
                     "self": {
-                        "href": "http://localhost:8000/api/meshobjects/meshcustomers/demo-customer"
+                        "href": "http://localhost:8000/api/meshobjects/meshworkspaces/demo-customer"
                     },
                     "meshtenants": {
-                        "href": "http://localhost:8000/api/meshobjects/meshtenants?customerIdentifier=demo-customer{&projectIdentifier,platformIdentifier}",
+                        "href": "http://localhost:8000/api/meshobjects/meshtenants?workspaceIdentifier=demo-customer{&projectIdentifier,platformIdentifier}",
                         "templated": true
                     },
                     "meshprojects": {
-                        "href": "http://localhost:8000/api/meshobjects/meshprojects?customerIdentifier=demo-customer"
+                        "href": "http://localhost:8000/api/meshobjects/meshprojects?workspaceIdentifier=demo-customer"
                     },
                     "meshusers": {
-                        "href": "http://localhost:8000/api/meshobjects/meshusers?customerIdentifier=demo-customer{&projectIdentifier,platformIdentifier,customerRole,projectRole}",
+                        "href": "http://localhost:8000/api/meshobjects/meshusers?workspaceIdentifier=demo-customer{&projectIdentifier,platformIdentifier,customerRole,projectRole}",
                         "templated": true
                     },
                     "meshpaymentmethods": {
-                        "href": "http://localhost:8000/api/meshobjects/meshpaymentmethods?customerIdentifier=demo-customer"
+                        "href": "http://localhost:8000/api/meshobjects/meshpaymentmethods?workspaceIdentifier=demo-customer"
                     }
                 }
             }
         ]
     },
     "_links": {
         "first": {
-            "href": "http://localhost:8000/api/meshobjects/meshcustomers?page=0&size=1"
+            "href": "http://localhost:8000/api/meshobjects/meshworkspaces?page=0&size=1"
         },
         "prev": {
-            "href": "http://localhost:8000/api/meshobjects/meshcustomers?page=0&size=1"
+            "href": "http://localhost:8000/api/meshobjects/meshworkspaces?page=0&size=1"
         },
         "self": {
-            "href": "http://localhost:8000/api/meshobjects/meshcustomers?page=1&size=1"
+            "href": "http://localhost:8000/api/meshobjects/meshworkspaces?page=1&size=1"
         }
     },
     "page": {

diff --git a/tap_meshstack/client.py b/tap_meshstack/client.py
@@ -89,6 +89,10 @@ def prepare_request(
         request_data = self.prepare_request_payload(context, next_page_token)
         headers = self.http_headers
 
+        headers.update({
+            "accept": self.meshobject_version
+        })
+
         authenticator = self.authenticator
         if authenticator:
             headers.update(authenticator.auth_headers or {})

diff --git a/tap_meshstack/schemas/meshChargeback.json b/tap_meshstack/schemas/meshChargeback.json
@@ -29,15 +29,15 @@
       "properties": {
         "partnerIdentifier": {
           "type": "string",
-          "description": "The meshPartner the meshCustomer of this meshChargeback belongs to."
+          "description": "The meshPartner the meshWorkspace of this meshChargeback belongs to."
         },
         "period": {
           "type": "string",
           "description": "The period of the meshChargeback, e.g. '2022-01-06Z'."
         },
-        "customerIdentifier": {
+        "workspaceIdentifier": {
           "type": "string",
-          "description": "The meshCustomer identifier this meshChargeback belongs to."
+          "description": "The meshWorkspace identifier this meshChargeback belongs to."
         },
         "projectIdentifier": {
           "type": "string",

diff --git a/tap_meshstack/schemas/meshPaymentMethod.json b/tap_meshstack/schemas/meshPaymentMethod.json
@@ -5,16 +5,16 @@
     "metadata": {
       "type": "object",
       "properties": {
-        "ownedByCustomer": {
+        "ownedByWorkspace": {
           "type": "string",
-          "description": "The customerIdentifier as 'ownedByCustomer'."
+          "description": "The workspaceIdentifier as 'ownedByWorkspace'."
         },
         "name": {
           "type": "string",
           "description": "The paymentMethodIdentifier as 'name'."
         }
       },
-      "description": "Always contains the 'name' and (optional) 'ownedByCustomer' to uniquely identify the meshPaymentMethod."
+      "description": "Always contains the 'name' and (optional) 'ownedByWorkspace' to uniquely identify the meshPaymentMethod."
     },
     "apiVersion": {
       "type": "string",

diff --git a/tap_meshstack/schemas/meshProject.json b/tap_meshstack/schemas/meshProject.json
@@ -5,9 +5,9 @@
     "metadata": {
       "type": "object",
       "properties": {
-        "ownedByCustomer": {
+        "ownedByWorkspace": {
           "type": "string",
-          "description": "The customerIdentifier as 'ownedByCustomer'."
+          "description": "The workspaceIdentifier as 'ownedByWorkspace'."
         },
         "deletedOn": {
           "type": "string",
@@ -22,7 +22,7 @@
           "description": "The meshProject has been created at this <<data_types,date>> (e.g. `2020-12-22T09:37:43Z`)."
         }
       },
-      "description": "Always contains the 'name' and 'ownedByCustomer' to uniquely identify the meshProject."
+      "description": "Always contains the 'name' and 'ownedByWorkspace' to uniquely identify the meshProject."
     },
     "apiVersion": {
       "type": "string",

diff --git a/tap_meshstack/schemas/meshTenant.json b/tap_meshstack/schemas/meshTenant.json
@@ -9,20 +9,20 @@
           "type": "string",
           "description": "The identifier of the meshProject the meshTenant belongs to."
         },
-        "ownedByCustomer": {
+        "ownedByWorkspace": {
           "type": "string",
-          "description": "The identifier of the meshCustomer the meshTenant belongs to."
+          "description": "The identifier of the meshWorkspace the meshTenant belongs to."
         },
         "assignedTags": {
           "type": "object",
-          "description": "The tags assigned to this meshTenant originating from meshCustomer, Payment Method and meshProject. Keep in mind, that values are an array. Also see our general section about <<tags>>"
+          "description": "The tags assigned to this meshTenant originating from meshWorkspace, Payment Method and meshProject. Keep in mind, that values are an array. Also see our general section about <<tags>>"
         },
         "platformIdentifier": {
           "type": "string",
           "description": "The identifier of the related platform instance"
         }
       },
-      "description": "Always contains the 'ownedByProject', 'ownedByCustomer' and 'platformIdentifier' to identify the meshTenant."
+      "description": "Always contains the 'ownedByProject', 'ownedByWorkspace' and 'platformIdentifier' to identify the meshTenant."
     },
     "apiVersion": {
       "type": "string",