Update documentation to include sync apiproduct command

Author: engswee

docs/flashpipe-cli.md

@@ -5,9 +5,10 @@ _FlashPipe_ provides a fully functional CLI with the following commands to inter
 - **[update package](#2-update-package)**
 - **[deploy](#3-deploy)**
 - **[sync](#4-sync)**
-- **[sync apim](#5-sync-apim)**
-- **[snapshot](#6-snapshot)**
-- **[snapshot restore](#7-snapshot-restore)**
+- **[sync apiproxy](#5-sync-apiproxy)**
+- **[sync apiproduct](#6-sync-apiproduct)**
+- **[snapshot](#7-snapshot)**
+- **[snapshot restore](#8-snapshot-restore)**
 
 
 These commands perform the _magic_ that significantly simplifies the steps required to execute the build and deploy steps in a CI/CD pipeline.
@@ -326,19 +327,19 @@ Environment variables set before call:
     FLASHPIPE_SYNC_PACKAGE_DETAILS: true
 ```
 
-### 5. sync apim
-This command is used to sync API Management artifacts between a tenant and a Git repository. It will compare any differences (new, deleted, changed) in files between tenant and the Git repository before synchronising them.
+### 5. sync apiproxy
+This command is used to sync API Proxies from API Management between a tenant and a Git repository. It will compare any differences (new, deleted, changed) in files between tenant and the Git repository before synchronising them.
 - dependent artifacts of the API Proxy are included like API Provider, Key Value Maps
 
 #### Usage
 ```bash
-flashpipe sync apim -h
+flashpipe sync apiproxy -h
 
-Synchronise API Management artifacts between SAP Integration Suite
+Synchronise API Management proxies (with dependent artifacts) between SAP Integration Suite
 tenant and a Git repository.
 
 Usage:
-  flashpipe sync apim [flags]
+  flashpipe sync apiproxy [flags]
 
 Flags:
       --dir-artifacts string           Directory containing contents of artifacts
@@ -348,7 +349,7 @@ Flags:
       --git-commit-msg string          Message used in commit (default "Sync repo from tenant")
       --git-commit-user string         User used in commit (default "github-actions[bot]")
       --git-skip-commit                Skip committing changes to Git repository
-  -h, --help                           help for apim
+  -h, --help                           help for apiproxy
       --ids-exclude strings            List of excluded artifact IDs
       --ids-include strings            List of included artifact IDs
       --target                         Target of sync. Allowed values: git, tenant (default "git")
@@ -364,7 +365,7 @@ Global Flags:
 ```
 
 #### CLI flags and environment variables list
-The following is the list of flags for the `sync apim` command and their corresponding environment variable name. The fourth column indicates whether the flag is valid for the specific value of --target.
+The following is the list of flags for the `sync apiproxy` command and their corresponding environment variable name. The fourth column indicates whether the flag is valid for the specific value of --target.
 
 | CLI flag name    | Environment variable name  | Mandatory | Applicable for value of --target | Shell expansion supported |
 |------------------|----------------------------|-----------|----------------------------------|---------------------------|
@@ -381,23 +382,95 @@ The following is the list of flags for the `sync apim` command and their corresp
 
 #### Example (OAuth with CLI flags)
 ```bash
-flashpipe sync apim --tmn-host ***.hana.ondemand.com --oauth-host ***.authentication.<region>.hana.ondemand.com --oauth-clientid <clientid> --oauth-clientsecret <clientsecret> --dir-git-repo "FlashPipe APIM Demo"
+flashpipe sync apiproxy --tmn-host ***.hana.ondemand.com --oauth-host ***.authentication.<region>.hana.ondemand.com --oauth-clientid <clientid> --oauth-clientsecret <clientsecret> --dir-git-repo "FlashPipe APIM Demo"
 ```
 
 #### Example (OAuth with environment variables)
 ```bash
-flashpipe sync apim
+flashpipe sync apiproxy
 
 Environment variables set before call:
     FLASHPIPE_TMN_HOST: ***.hana.ondemand.com
     FLASHPIPE_OAUTH_HOST: ***.authentication.<region>.hana.ondemand.com
     FLASHPIPE_OAUTH_CLIENTID: <clientid>
     FLASHPIPE_OAUTH_CLIENTSECRET: <clientsecret>
     FLASHPIPE_DIR_GIT_REPO: "FlashPipe APIM Demo"
-    FLASHPIPE_DIR_ARTIFACTS: "FlashPipe APIM Demo/Contents"
+    FLASHPIPE_DIR_ARTIFACTS: "FlashPipe APIM Demo/APIProxies"
 ```
 
-### 6. snapshot
+### 6. sync apiproduct
+This command is used to sync API Products from API Management between a tenant and a Git repository. It will compare any differences (new, deleted, changed) between tenant and the Git repository before synchronising them.
+
+_NOTE:_ Due to limitation of SAP's public API, updates are not synced to tenant.
+
+#### Usage
+```bash
+flashpipe sync apiproduct -h
+
+Synchronise API Management products between SAP Integration Suite
+tenant and a Git repository.
+
+Usage:
+  flashpipe sync apiproduct [flags]
+
+Flags:
+      --dir-artifacts string           Directory containing contents of artifacts
+      --dir-git-repo string            Directory of Git repository
+      --dir-work string                Working directory for in-transit files (default "/tmp")
+      --git-commit-email string        Email used in commit (default "41898282+github-actions[bot]@users.noreply.github.com")
+      --git-commit-msg string          Message used in commit (default "Sync repo from tenant")
+      --git-commit-user string         User used in commit (default "github-actions[bot]")
+      --git-skip-commit                Skip committing changes to Git repository
+  -h, --help                           help for apiproduct
+      --ids-exclude strings            List of excluded artifact IDs
+      --ids-include strings            List of included artifact IDs
+      --target                         Target of sync. Allowed values: git, tenant (default "git")
+
+Global Flags:
+      --config string               config file (default is $HOME/flashpipe.yaml)
+      --debug                       Show debug logs
+      --oauth-clientid string       Client ID for using OAuth
+      --oauth-clientsecret string   Client Secret for using OAuth
+      --oauth-host string           Host for OAuth token server excluding https:// 
+      --oauth-path string           Path for OAuth token server (default "/oauth/token")
+      --tmn-host string             Host for API Portal for API Management excluding https://
+```
+
+#### CLI flags and environment variables list
+The following is the list of flags for the `sync apiproduct` command and their corresponding environment variable name. The fourth column indicates whether the flag is valid for the specific value of --target.
+
+| CLI flag name    | Environment variable name  | Mandatory | Applicable for value of --target | Shell expansion supported |
+|------------------|----------------------------|-----------|----------------------------------|---------------------------|
+| dir-git-repo     | FLASHPIPE_DIR_GIT_REPO     | Yes       | git, tenant                      | Yes                       |
+| dir-artifacts    | FLASHPIPE_DIR_ARTIFACTS    | No        | git, tenant                      | Yes                       |
+| target           | FLASHPIPE_TARGET           | No        | git, tenant                      | No                        |
+| ids-include      | FLASHPIPE_IDS_INCLUDE      | No        | git, tenant                      | No                        |
+| ids-exclude      | FLASHPIPE_IDS_EXCLUDE      | No        | git, tenant                      | No                        |
+| git-commit-msg   | FLASHPIPE_GIT_COMMIT_MSG   | No        | git                              | No                        |
+| git-commit-user  | FLASHPIPE_GIT_COMMIT_USER  | No        | git                              | No                        |
+| git-commit-email | FLASHPIPE_GIT_COMMIT_EMAIL | No        | git                              | No                        |
+| git-skip-commit  | FLASHPIPE_GIT_SKIP_COMMIT  | No        | git                              | No                        |
+| dir-work         | FLASHPIPE_DIR_WORK         | No        | git, tenant                      | Yes                       |
+
+#### Example (OAuth with CLI flags)
+```bash
+flashpipe sync apiproduct --tmn-host ***.hana.ondemand.com --oauth-host ***.authentication.<region>.hana.ondemand.com --oauth-clientid <clientid> --oauth-clientsecret <clientsecret> --dir-git-repo "FlashPipe APIM Demo"
+```
+
+#### Example (OAuth with environment variables)
+```bash
+flashpipe sync apiproduct
+
+Environment variables set before call:
+    FLASHPIPE_TMN_HOST: ***.hana.ondemand.com
+    FLASHPIPE_OAUTH_HOST: ***.authentication.<region>.hana.ondemand.com
+    FLASHPIPE_OAUTH_CLIENTID: <clientid>
+    FLASHPIPE_OAUTH_CLIENTSECRET: <clientsecret>
+    FLASHPIPE_DIR_GIT_REPO: "FlashPipe APIM Demo"
+    FLASHPIPE_DIR_ARTIFACTS: "FlashPipe APIM Demo/APIProducts"
+```
+
+### 7. snapshot
 This command is used to capture a snapshot of the Cloud Integration tenant's artifacts and integration package details (optional) to a Git repository. It will compare any differences (new, deleted, changed) in files from tenant and commit/push to the Git repository.
 
 
@@ -471,7 +544,7 @@ Environment variables set before call:
     FLASHPIPE_DIR_GIT_REPO: "TrialTenant"
 ```
 
-### 7. snapshot restore
+### 8. snapshot restore
 This command is used to restore a snapshot of the Cloud Integration artifacts and integration package details from a Git repository back to the tenant. It will compare any differences (new, deleted, changed) in files from Git repository and update to the tenant.
 
 

docs/github-actions-sync-apim.md

@@ -39,12 +39,13 @@ Skip the templates and choose `set up a workflow yourself`.
 
 Provide a suitable name for the workflow file e.g. `sync-apim-to-git.yml` and replace the default content with the code sample below. Replace the tenant and authentication details accordingly - note that the host refers to the management node of the API Portal which differs from the tenant management node of Cloud Integration.
 
-**NOTE** - FlashPipe comes with companion GitHub Action [engswee/flashpipe-action](https://github.com/engswee/flashpipe-action) that simplifies usage in a workflow. The following action is used in the workflow:
-- [engswee/flashpipe-action/sync/apim@v1](https://github.com/engswee/flashpipe-action#sync-apim)
+**NOTE** - FlashPipe comes with companion GitHub Action [engswee/flashpipe-action](https://github.com/engswee/flashpipe-action) that simplifies usage in a workflow. The following actions are used in the workflow:
+- [engswee/flashpipe-action/sync/apiproxy@v1](https://github.com/engswee/flashpipe-action#sync-apiproxy)
+- [engswee/flashpipe-action/sync/apiproduct@v1](https://github.com/engswee/flashpipe-action#sync-apiproduct)
 
 ![Sync Workflow](images/setup/git-sync-apim/04b_sync_apim_git_workflow.png)
 
-<script src="https://gist.github.com/engswee/044767991065f41991b2c6a9fd8262c0.js"></script>
+<script src="https://gist.github.com/engswee/1a06264333060f8eb5c02690cb55957e.js"></script>
 
 Save and commit the new workflow file.
 
@@ -59,7 +60,8 @@ In the GitHub repository, go to `Actions`, select the workflow and click `Run wo
 ### 6. View execution results
 
 During or upon completion of the workflow run, the logs can be viewed by clicking on the workflow run.
-![Workflow Logs](images/setup/git-sync-apim/06a_logs_apim.png)
+![Workflow Logs APIProxy](images/setup/git-sync-apim/06a_logs_apim.png)
+![Workflow Logs APIProduct](images/setup/git-sync-apim/06a_logs_apiproduct.png)
 
 The APIM artifact files have now been downloaded from the tenant and committed to the repository.
 ![IFlow Files](images/setup/git-sync-apim/06b_apim_files.png)
@@ -76,7 +78,7 @@ Provide a suitable name for the workflow file e.g. `sync-apim-to-tenant.yml` and
 
 ![Sync Workflow](images/setup/git-sync-apim/b_01_sync_apim_to_tenant_workflow.png)
 
-<script src="https://gist.github.com/engswee/72d0a121f6c8c924cf771fb4d1d65573.js"></script>
+<script src="https://gist.github.com/engswee/4271fbcef81db0ec719bc8cc46bc1d69.js"></script>
 
 Save and commit the new workflow file.
 
@@ -89,6 +91,9 @@ In the GitHub repository, go to `Actions`, select the workflow and click `Run wo
 ### 3. View execution results
 
 During or upon completion of the workflow run, the logs can be viewed by clicking on the workflow run.
-![Workflow Logs](images/setup/git-sync-apim/b_03_sync_tenant_logs.png)
+![Workflow Logs APIProxy](images/setup/git-sync-apim/b_03_sync_tenant_logs.png)
+![Workflow Logs APIProduct](images/setup/git-sync-apim/b_03_sync_tenant_logs_apiproduct.png)
 
-As seen from the logs, changes in the APIM artifact were synced to the tenant. 
+As seen from the logs, APIM artifacts were synced to the tenant.
+
+_NOTE:_ Due to limitation of SAP's public API, updates of API Products are not synced to tenant, instead these will be skipped.

docs/images/setup/git-sync-apim/06a_logs_apim.png

@@ -6,7 +6,7 @@
 
 - 🔥🔥 Hot new feature 🔥🔥 - _FlashPipe_ now supports syncing of API Products from **API Management** 
   - New `sync apiproduct` command
-- Rename of `sync apim` command to `sync apiproxy` for handling API Proxies.
+- Rename of `sync apim` command to `sync apiproxy` for handling API Proxies
   - `sync apim` still works for backward compatibility
 - Update to latest Go version 1.24.4 and dependencies