API spec v3.10 - update 1

Signed-off-by: George Dias <gdias@mitre.org>

.github/workflows/generate-clients.yml

@@ -2,7 +2,7 @@ name: Generate OpenAPI Clients
 # For testing use the PR name for 'branches:' - once done testing revert the 'branches:' name to main
 on:
   push:
-    branches: [ main ]
+    branches: [ V3_10 ]
   # pull_request:
   #   branches: [ main ]
 

.github/workflows/generate_docs.yml

@@ -1,9 +1,10 @@
 name: Generate eMASS Documentation
 
 # Run on each push to main
+# For testing use the PR name for 'branches:' - once done testing revert the 'branches:' name to main
 on:
   push:
-    branches: [ main ]
+    branches: [ V3_10 ]
   # pull_request:
   #   branches: [ main ]
 jobs:

.github/workflows/gh-pages.yml

@@ -1,7 +1,8 @@
+# For testing use the PR name for 'branches:' - once done testing revert the 'branches:' name to main
 name: Deploy to GitHub Pages
 on:
   push:
-    branches: [ main ]
+    branches: [ V3_10 ]
   # pull_request:
   #   branches: [ main ]
 

.github/workflows/publish-to-test-pypi.yml

@@ -1,19 +1,27 @@
 # publish a python package to the test pipy registry - await until the generate clients finishes
 name: Publish Python 🐍 distributions 📦 to TestPyPI
 
-# Push to TestPyPI unconditionally (need to rev version or del/yank same ver)
-# Used for testing the python package - to test comment the
+#-----------------------------------------------------------------------------------
+# Push to TestPyPI unconditionally (need to rev version, del/yank ver will not work)
+# 
+# For testing use:
+# on: push
+# (push to the TestPyPi registry on every push during development)
+#
+# Once test is completed use:
 # on:
 #   workflow_run:
-#     workflows: ['generate-eMASS-clients']
+#     workflows: [Generate OpenAPI Clients] -> old ['generate-eMASS-clients']
 #      types:
 #        - completed
-# and simply use on: push
-on:
-  workflow_run:
-    workflows: ['generate-eMASS-clients']
-    types:
-      - completed
+#-----------------------------------------------------------------------------------
+
+# on:
+#   workflow_run:
+#     workflows: [Generate OpenAPI Clients]
+#     types:
+#       - completed
+on: push
 
 jobs:
   build-n-publish:

docs/developers.md

@@ -65,7 +65,7 @@ curl -X GET "http://localhost:4010/api/systems?policy=rmf" -H  "accept: applicat
 ## Building an eMASS Client SDK
 The API clients are generated utilizing the [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) CLI.
 
-**Note:** Currently there are two (2) client SDKs (ruby, and typscript-axios) that are automatically generated utilizing GitHub action implemented within this repository. They are generated when a push to the main branch occurs and the API specification file has been modified.
+**Note:** Currently there are three (3) client SDKs (ruby, typscript-axios, and python) that are automatically generated utilizing GitHub action implemented within this repository. They are generated when a push to the main branch occurs and the API specification file has been modified.
 
 ### Generate an eMASS Client
 Follow these steps to generate an eMASS client for additional supported language provided by the [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) CLI:
@@ -122,6 +122,9 @@ Follow these steps to generate an eMASS client for additional supported language
   ```
   openapi-generators/openapitools-generator-action@v1
   ```
+
+An OpenAPI Generator CLI Docker Image solution is available and documented [here](https://github.com/OpenAPITools/openapi-generator#16---docker) as a Public Pre-built Docker image.
+
 ---
 
 NOTICE