Add import samples (#417)

* add more samples

* more samples

* more samples

* more samples

* more samples

* sample

* fix

* fix

* fix

* fix

* fix table

* fix table

* fix

* fix

* fix

* fix

* fix

* fix samples for apps

* fix samples for apps

* apidocs

* rename file

* rename file

.gitignore

@@ -27,7 +27,9 @@ remote-service.*
 #json files
 *.json
 
+!samples/*/*.zip
 !samples/*.json
+!samples/*/*.json
 !test/*.json
 !test/*.yaml
 !test/*.zip

README.md

@@ -388,6 +388,27 @@ x-google-jwt-locations:
 
 query parameters are ignored. By default, if no location is specified, the JWT location is the `Authorization` header and value_prefix is `Bearer <token>`
 
+## How do I import entities using apigeecli?
+
+The table below illustrates how you can import different entities into Apigee. It refers to the [samples](./samples/) directory.
+
+
+| Operations | Import command |
+|---|---|
+| apicategories | `apigeecli apicategories import -o $org -t $token -f samples/apicategories.json -s $siteId` |
+| apis | `apigeecli apis import -f samples/apis -o $org -t $token` |
+| appgroups | `apigeecli appgroups import -f samples/appgroups.json -o $org -t $token` |
+| datacollectors | `apigeecli datacollectors import -f samples/datacollectors.json -o $org -t $token` |
+| developers | `apigeecli developers import -f samples/developers.json -o $org -t $token` |
+| kvms | `apigeecli kvms import -f samples/kvms -o $org -t $token` (Rename the files under samples/kvms to match your Apigee setup)  |
+| products | `apigeecli products import -f samples/apiproduct-legacy.json -o $org -t $token`  `apigeecli products import -f samples/apiproduct-gqlgroup.json -o $org -t $token`  `apigeecli products import -f samples/apiproduct-op-group.json -o $org -t $token` |
+| sharedflows | `apigeecli sharedflows import -f samples/sharedflows -o $org -t $token` |
+| targetservers | `apigeecli targetservers import -f samples/targetservers.json -o $org -t $token -e $env` |
+| keystores | `apigeecli keystores import -f samples/keystores.json -o $org -t $token -e $env` |
+| references | `apigeecli references import -f samples/references.json -o $org -t $token -e $env` |
+| apps | `apigeecli apps import -f samples/references.json -d samples/developers.json -o $org -t $token` (better used when the developers and apps are exported using the export) |
+| apidocs | `apigeecli apidocs import -f samples/apidocs -o $org -t $token -s $siteId` (Rename the files under samples/apidocs to match your Apigee setup for siteId) |
+
 ## How do I verify the binary?
 
 All artifacts are signed by [cosign](https://github.com/sigstore/cosign). We recommend verifying any artifact before using them.

samples/apicategories.json

@@ -0,0 +1,10 @@
+{
+    "data": [
+        {
+            "name": "foo"
+        },
+        {
+            "name": "bar"
+        }
+    ]
+}

samples/apidocs/apidocs_siteId_123.json

@@ -0,0 +1,11 @@
+{
+  "data": {
+    "oasDocumentation": {
+      "spec": {
+        "displayName": "mocktarget.yaml",
+        "contents": "c3dhZ2dlcjogJzIuMCcKaW5mbzoKICBkZXNjcmlwdGlvbjogJ09wZW5BUEkgU3BlY2lmaWNhdGlvbiBmb3IgdGhlIEFwaWdlZSBtb2NrIHRhcmdldCBzZXJ2aWNlIGVuZHBvaW50LicKICB2ZXJzaW9uOiAxLjAuMAogIHRpdGxlOiBNb2NrIFRhcmdldCBBUEkKaG9zdDogbW9ja3RhcmdldC5hcGlnZWUubmV0CnNjaGVtZXM6CiAgLSBodHRwCiAgLSBodHRwcwpzZWN1cml0eURlZmluaXRpb25zOgogIGJhc2ljQXV0aDoKICAgIHR5cGU6IGJhc2ljCiAgICBkZXNjcmlwdGlvbjogSFRUUCBCYXNpYyBBdXRoZW50aWNhdGlvbi4KcGF0aHM6CiAgLzoKICAgIGdldDoKICAgICAgc3VtbWFyeTogVmlldyBwZXJzb25hbGl6ZWQgZ3JlZXRpbmcKICAgICAgb3BlcmF0aW9uSWQ6IFZpZXcgYSBwZXJzb25hbGl6ZWQgZ3JlZXRpbmcKICAgICAgZGVzY3JpcHRpb246IFZpZXcgYSBwZXJzb25hbGl6ZWQgZ3JlZXRpbmcgZm9yIHRoZSBzcGVjaWZpZWQgb3IgZ3Vlc3QgdXNlci4KICAgICAgcHJvZHVjZXM6CiAgICAgICAgLSB0ZXh0L3BsYWluCiAgICAgIHBhcmFtZXRlcnM6CiAgICAgICAgLSBuYW1lOiB1c2VyCiAgICAgICAgICBpbjogcXVlcnkKICAgICAgICAgIGRlc2NyaXB0aW9uOiBZb3VyIHVzZXIgbmFtZS4KICAgICAgICAgIHJlcXVpcmVkOiBmYWxzZQogICAgICAgICAgdHlwZTogc3RyaW5nCiAgICAgIHJlc3BvbnNlczoKICAgICAgICAnMjAwJzoKICAgICAgICAgIGRlc2NyaXB0aW9uOiBTdWNjZXNzCiAgL2hlbHA6CiAgICBnZXQ6CiAgICAgIHN1bW1hcnk6IEdldCBoZWxwCiAgICAgIG9wZXJhdGlvbklkOiBHZXQgaGVscAogICAgICBkZXNjcmlwdGlvbjogVmlldyBoZWxwIGluZm9ybWF0aW9uIGFib3V0IGF2YWlsYWJsZSByZXNvdXJjZXMgaW4gSFRNTCBmb3JtYXQuCiAgICAgIHByb2R1Y2VzOgogICAgICAgIC0gdGV4dC9odG1sCiAgICAgIHJlc3BvbnNlczoKICAgICAgICAnMjAwJzoKICAgICAgICAgIGRlc2NyaXB0aW9uOiBTdWNjZXNzCiAgL3VzZXI6CiAgICBnZXQ6CiAgICAgIHN1bW1hcnk6IFZpZXcgcGVyc29uYWxpemVkIGdyZWV0aW5nCiAgICAgIG9wZXJhdGlvbklkOiBWaWV3IHBlcnNvbmFsaXplZCBncmVldGluZwogICAgICBkZXNjcmlwdGlvbjogVmlldyBhIHBlcnNvbmFsaXplZCBncmVldGluZyBmb3IgdGhlIHNwZWNpZmllZCBvciBndWVzdCB1c2VyLgogICAgICBwcm9kdWNlczoKICAgICAgICAtIHRleHQvcGxhaW4KICAgICAgcGFyYW1ldGVyczoKICAgICAgICAtIG5hbWU6IHVzZXIKICAgICAgICAgIGluOiBxdWVyeQogICAgICAgICAgZGVzY3JpcHRpb246IFlvdXIgdXNlciBuYW1lLgogICAgICAgICAgcmVxdWlyZWQ6IGZhbHNlCiAgICAgICAgICB0eXBlOiBzdHJpbmcKICAgICAgcmVzcG9uc2VzOgogICAgICAgICcyMDAnOgogICAgICAgICAgZGVzY3JpcHRpb246IFN1Y2Nlc3MKICAvaWxvdmVhcGlzOgogICAgZ2V0OgogICAgICBzdW1tYXJ5OiBWaWV3IEFQSSBhZmZpcm1hdGlvbgogICAgICBvcGVyYXRpb25JZDogVmlldyBBUEkgYWZmaXJtYXRpb24KICAgICAgZGVzY3JpcHRpb246IFZpZXcgQVBJIGFmZmlybWF0aW9uIGluIEhUTUwgZm9ybWF0LgogICAgICBwcm9kdWNlczoKICAgICAgICAtIHRleHQvaHRtbAogICAgICByZXNwb25zZXM6CiAgICAgICAgJzIwMCc6CiAgICAgICAgICBkZXNjcmlwdGlvbjogU3VjY2VzcwogIC9pcDoKICAgIGdldDoKICAgICAgc3VtbWFyeTogVmlldyBJUCBhZGRyZXNzCiAgICAgIG9wZXJhdGlvbklkOiBWaWV3IElQIGFkZHJlc3MKICAgICAgZGVzY3JpcHRpb246IFZpZXcgdGhlIElQIGFkZHJlc3Mgb2YgdGhlIGNsaWVudCBpbiBKU09OIGZvcm1hdC4KICAgICAgcHJvZHVjZXM6CiAgICAgICAgLSBhcHBsaWNhdGlvbi9qc29uCiAgICAgIHJlc3BvbnNlczoKICAgICAgICAnMjAwJzoKICAgICAgICAgIGRlc2NyaXB0aW9uOiBTdWNjZXNzCiAgL3htbDoKICAgIGdldDoKICAgICAgc3VtbWFyeTogVmlldyBYTUwgcmVzcG9uc2UKICAgICAgb3BlcmF0aW9uSWQ6IFZpZXcgWE1MIHJlc3BvbnNlCiAgICAgIGRlc2NyaXB0aW9uOiBWaWV3IGEgc2FtcGxlIHJlc3BvbnNlIGluIFhNTCBmb3JtYXQuCiAgICAgIHByb2R1Y2VzOgogICAgICAgIC0gYXBwbGljYXRpb24veG1sCiAgICAgIHJlc3BvbnNlczoKICAgICAgICAnMjAwJzoKICAgICAgICAgIGRlc2NyaXB0aW9uOiBTdWNjZXNzCiAgL2pzb246CiAgICBnZXQ6CiAgICAgIHN1bW1hcnk6IFZpZXcgSlNPTiByZXNwb25zZQogICAgICBvcGVyYXRpb25JZDogVmlldyBKU09OIHJlc3BvbnNlCiAgICAgIGRlc2NyaXB0aW9uOiBWaWV3IGEgc2FtcGxlIHJlc3BvbnNlIGluIEpTT04gZm9ybWF0LgogICAgICBwcm9kdWNlczoKICAgICAgICAtIGFwcGxpY2F0aW9uL2pzb24KICAgICAgcmVzcG9uc2VzOgogICAgICAgICcyMDAnOgogICAgICAgICAgZGVzY3JpcHRpb246IFN1Y2Nlc3MKICAvZWNobzoKICAgIGdldDoKICAgICAgc3VtbWFyeTogVmlldyByZXF1ZXN0IGhlYWRlcnMgYW5kIGJvZHkKICAgICAgb3BlcmF0aW9uSWQ6IFZpZXcgcmVxdWVzdCBoZWFkZXJzIGFuZCBib2R5CiAgICAgIGRlc2NyaXB0aW9uOiBWaWV3IHRoZSByZXF1ZXN0IGhlYWRlcnMgYW5kIGJvZHkgaW4gSlNPTiBmb3JtYXQuCiAgICAgIHByb2R1Y2VzOgogICAgICAgIC0gYXBwbGljYXRpb24vanNvbgogICAgICByZXNwb25zZXM6CiAgICAgICAgJzIwMCc6CiAgICAgICAgICBkZXNjcmlwdGlvbjogU3VjY2VzcwogICAgcG9zdDoKICAgICAgc3VtbWFyeTogU2VuZCByZXF1ZXN0IGFuZCB2aWV3IHJlcXVlc3QgaGVhZGVycyBhbmQgYm9keQogICAgICBwcm9kdWNlczoKICAgICAgICAtIGFwcGxpY2F0aW9uL2pzb24KICAgICAgICAtIGFwcGxpY2F0aW9uL3htbAogICAgICAgIC0gYXBwbGljYXRpb24veC13d3ctZm9ybS11cmxlbmNvZGVkCiAgICAgIG9wZXJhdGlvbklkOiBTZW5kIHJlcXVlc3QgYW5kIHZpZXcgcmVxdWVzdCBoZWFkZXJzIGFuZCBib2R5CiAgICAgIGRlc2NyaXB0aW9uOiAnU2VuZCBhIHJlcXVlc3QgYW5kIHZpZXcgdGhlIHJlc3VsdGluZyByZXF1ZXN0IGhlYWRlcnMgYW5kIGJvZHkgaW4gSlNPTiBmb3JtYXQuPHA+VGhlIHJlcXVlc3QgcGF5bG9hZCBjYW4gYmUgc3BlY2lmaWVkIHVzaW5nIG9uZSBvZiB0aGUgZm9sbG93aW5nIGZvcm1hdHM6IGFwcGxpY2F0aW9uL2pzb24sIGFwcGxpY2F0aW9uL3gtd3d3LWZvcm0tdXJsZW5jb2RlZCwgb3IgYXBwbGljYXRpb24veG1sLicKICAgICAgcGFyYW1ldGVyczoKICAgICAgICAtIG5hbWU6IGJvZHkKICAgICAgICAgIGluOiBib2R5CiAgICAgICAgICBkZXNjcmlwdGlvbjogJ1JlcXVlc3QgcGF5bG9hZCBpbiBhcHBsaWNhdGlvbi9qc29uLCBhcHBsaWNhdGlvbi94LXd3dy1mb3JtLXVybGVuY29kZWQsIG9yIGFwcGxpY2F0aW9uL3htbCBmb3JtYXQuJwogICAgICAgICAgcmVxdWlyZWQ6IHRydWUKICAgICAgICAgIHNjaGVtYToKICAgICAgICAgICAgJHJlZjogJyMvZGVmaW5pdGlvbnMvcmVxdWVzdC1ib2R5JwogICAgICByZXNwb25zZXM6CiAgICAgICAgJzIwMCc6CiAgICAgICAgICBkZXNjcmlwdGlvbjogU3VjY2VzcwogIC9zdGF0dXNjb2RlL3tjb2RlfToKICAgIGdldDoKICAgICAgc3VtbWFyeTogVmlldyBzdGF0dXMgY29kZSBhbmQgbWVzc2FnZQogICAgICBvcGVyYXRpb25JZDogVmlldyBzdGF0dXMgY29kZSBhbmQgbWVzc2FnZQogICAgICBkZXNjcmlwdGlvbjogVmlldyBzdGF0dXMgY29kZSBhbmQgbWVzc2FnZSBmb3IgdGhlIHNwZWNpZmllZCB2YWx1ZS4KICAgICAgcHJvZHVjZXM6CiAgICAgICAgLSBhcHBsaWNhdGlvbi9qc29uCiAgICAgIHBhcmFtZXRlcnM6CiAgICAgICAgLSBuYW1lOiBjb2RlCiAgICAgICAgICBpbjogcGF0aAogICAgICAgICAgZGVzY3JpcHRpb246IEhUVFAgc3RhdHVzIGNvZGUuCiAgICAgICAgICByZXF1aXJlZDogdHJ1ZQogICAgICAgICAgdHlwZTogc3RyaW5nCiAgICAgIHJlc3BvbnNlczoKICAgICAgICAnMjAwJzoKICAgICAgICAgIGRlc2NyaXB0aW9uOiBTdWNjZXNzCiAgL2F1dGg6CiAgICBnZXQ6CiAgICAgIHNlY3VyaXR5OgogICAgICAtIGJhc2ljQXV0aDogW10KICAgICAgc3VtbWFyeTogVmFsaWRhdGUgYWNjZXNzIHVzaW5nIGJhc2ljIGF1dGhlbnRpY2F0aW9uCiAgICAgIG9wZXJhdGlvbklkOiBWYWxpZGF0ZSBhY2Nlc3MgdXNpbmcgYmFzaWMgYXV0aGVudGljYXRpb24KICAgICAgZGVzY3JpcHRpb246IFZhbGlkYXRlIGFjY2VzcyB1c2luZyBiYXNpYyBhdXRoZW50aWNhdGlvbi4KICAgICAgcHJvZHVjZXM6CiAgICAgICAgLSBhcHBsaWNhdGlvbi9qc29uCiAgICAgIHJlc3BvbnNlczoKICAgICAgICAnMjAwJzoKICAgICAgICAgIGRlc2NyaXB0aW9uOiBTdWNjZXNzCmRlZmluaXRpb25zOgogIHJlcXVlc3QtYm9keToKICAgIHByb3BlcnRpZXM6CiAgICAgIHJlcGxhY2UtbWU6CiAgICAgICAgdHlwZTogb2JqZWN0CiAgICAgICAgZGVzY3JpcHRpb246ICdSZXBsYWNlIHdpdGggcmVxdWVzdCBwYXlsb2FkIGluIGFwcGxpY2F0aW9uL2pzb24sIGFwcGxpY2F0aW9uL3gtd3d3LWZvcm0tdXJsZW5jb2RlZCwgb3IgYXBwbGljYXRpb24veG1sIGZvcm1hdC4nCg=="
+      },
+      "format": "YAML"
+    }
+  }
+}

samples/apidocs/site_siteId.json

@@ -0,0 +1,12 @@
+[
+	{
+		"id": "123",
+		"title": "MockProduct",
+		"description": "MockProduct",
+		"published": true,
+		"anonAllowed": true,
+		"apiProductName": "MockProduct",
+		"visibility": true,
+		"edgeAPIProductName": "MockProduct"
+	}
+]

samples/apiproduct-legacy.json

@@ -0,0 +1,40 @@
+[
+    {
+        "name": "MockProduct",
+        "displayName": "MockProduct",
+        "description": "MockProduct",
+        "apiResources": [
+            "/**",
+            "/"
+        ],
+        "approvalType": "auto",
+        "attributes": [
+            {
+                "name": "description",
+                "value": "Mock Product"
+            },
+            {
+                "name": "developer.quota.limit",
+                "value": "10000"
+            },
+            {
+                "name": "developer.quota.interval",
+                "value": "1"
+            },
+            {
+                "name": "developer.quota.timeunit",
+                "value": "month"
+            }
+        ],
+        "environments": [
+            "dev"
+        ],
+        "proxies": [
+            "mock"
+        ],
+        "quota": "10000",
+        "quotaInterval": "1",
+        "quotaTimeUnit": "month",
+        "scopes": []
+    }
+]

samples/appgroups.json

@@ -0,0 +1,22 @@
+[
+	{
+		"name": "sampleAppGroup1",
+		"channelUri": "channel1",
+		"channelId": "1",
+		"displayName": "Sample App Group 1",
+		"status": "active",
+		"attributes": [
+			{
+				"name": "foo",
+				"value": "bar"
+			}
+		]
+	},
+	{
+		"name": "sampleAppGroup2",
+		"channelUri": "channel2",
+		"channelId": "2",
+		"displayName": "Sample App Group 2",
+		"status": "active"
+	}
+]

samples/apps.json

@@ -0,0 +1,31 @@
+[
+  {
+    "attributes": [
+      {
+        "name": "DisplayName",
+        "value": "SampleApp"
+      },
+      {
+        "name": "Foo",
+        "value": "Bar"
+      }
+    ],
+    "credentials": [
+      {
+        "apiProducts": [
+          {
+            "apiproduct": "MockProduct",
+            "status": "approved"
+          }
+        ],
+        "consumerKey": "blah",
+        "consumerSecret": "blah",
+        "expiresAt": "-1",
+        "status": "approved"
+      }
+    ],
+    "developerId": "13a4ebde-79c6-4b33-848e-31a64f9d2145",
+    "name": "SampleApp",
+    "status": "approved"
+  }
+]

samples/datacollectors.json

@@ -0,0 +1,9 @@
+{
+  "dataCollectors": [
+    {
+      "name": "dc_sampleCollector",
+      "description": "Sample",
+      "type": "STRING"
+    }
+  ]
+}

samples/debugmask.json

@@ -0,0 +1,6 @@
+{
+    "variables": [
+        "request.header.x-api-key",
+        "request.header.x-apikey"
+    ]
+}

samples/developers.json

@@ -0,0 +1,12 @@
+{
+	"developer": [
+		{
+			"email": "[email protected]",
+			"firstName": "Sample",
+			"lastName": "Developer",
+			"userName": "sample",
+			"developerId": "13a4ebde-79c6-4b33-848e-31a64f9d2145",
+			"status": "active"
+		}
+	]
+}

samples/keystores.json

@@ -0,0 +1,4 @@
+[
+    "samplekeystore",
+    "testkeystore"
+]

samples/kvms/env_envname_mapname_kvmfile_0.json

@@ -0,0 +1,12 @@
+{
+  "keyValueEntries": [
+    {
+      "name": "foo",
+      "value": "bar"
+    },
+    {
+      "name": "hello",
+      "value": "world"
+    }
+  ]
+}

samples/kvms/proxy_proxyname_mapname_kvmfile_0.json

@@ -0,0 +1,12 @@
+{
+  "keyValueEntries": [
+    {
+      "name": "foo",
+      "value": "bar"
+    },
+    {
+      "name": "hello",
+      "value": "world"
+    }
+  ]
+}

samples/references.json

@@ -0,0 +1,7 @@
+[
+  {
+    "name": "reference",
+    "resourceType": "KeyStore",
+    "refers": "samplekeystore"
+  }
+]

samples/targetservers.json

@@ -0,0 +1,12 @@
+[
+    {
+        "name": "TS-Mock",
+        "host": "mocktarget.apigee.net",
+        "isEnabled": true,
+        "port": 443,
+        "sSLInfo": {
+            "enabled": true
+        },
+        "protocol": "HTTP"
+    }
+]