PR for release 1.1.0 (#321)

* [FEATURE REQUEST] Support of custom IdPs in Role assignment (#319) * fix issue with wrong parameters-handling * [btpsa bot] Generate parameter documentation * [btpsa bot] Generate parameter documentation * add dependabot configuration for npm (#320) * [btpsa bot] Generate parameter documentation Co-authored-by: Rui Nogueira <rui.nogueira@sap.com> Co-authored-by: [btpsa bot] docu generation <btpsabot@users.noreply.github.com>
SAP-samples · Nov 23, 2022 · 575f5c3 · 575f5c3
1 parent cabc3f7
commit 575f5c3
Show file tree

Hide file tree

Showing 55 changed files with 677 additions and 153 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -4,13 +4,19 @@ updates:
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      # Check for updates to GitHub Actions every weekday
+      # Check for updates to GitHub Actions once a week on Monday
       interval: "weekly"
       day: "monday"
   - package-ecosystem: "pip"
     directory: "/config/python"
     schedule:
-      # Check for updates to GitHub Actions every weekday
+      # Check for updates to GitHub Actions once a week on Monday
       interval: "weekly"
       day: "monday"
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions once a week on Monday
+      interval: "weekly"
+      day: "monday"    
 
diff --git a/config/templates/libs/BTPSA-PARAMETERS.json b/config/templates/libs/BTPSA-PARAMETERS.json
@@ -117,6 +117,15 @@
             "title": "provider subaccount id of custom app on SAP BTP",
             "default": null
         },
+        "defaultIdp": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "description": "default identity provider for role collections",
+            "title": "default IdP",
+            "default": null
+        },
         "directoryid": {
             "type": [
                 "string",

diff --git a/config/templates/libs/BTPSA-USECASE.json b/config/templates/libs/BTPSA-USECASE.json
@@ -91,6 +91,12 @@
                         "description": "user groups to be assigned from the parameter file",
                         "title": "user groups from parameter file"
                     },
+                    "idp":{
+                        "type": "string",
+                        "description": "the identity provider that hosts the user. ",
+                        "title": "IdP name",
+                        "default": null
+                    },
                     "level": {
                         "type": "string",
                         "description": "level of the role collection",
@@ -287,6 +293,12 @@
                                     "type": "array",
                                     "description": "list of user groups to assign the role collection",
                                     "title": "list of user groups to assign the role collection"
+                                },
+                                "idp":{
+                                    "type": "string",
+                                    "description": "the identity provider that hosts the user. ",
+                                    "title": "IdP name",
+                                    "default": null
                                 }
                             }
                         }

diff --git a/docs/generated/btpsa-parameters-properties-default-idp.md b/docs/generated/btpsa-parameters-properties-default-idp.md
@@ -0,0 +1,3 @@
+## defaultIdp Type
+
+`string` ([default IdP](btpsa-parameters-properties-default-idp.md))
diff --git a/docs/generated/btpsa-parameters.md b/docs/generated/btpsa-parameters.md
@@ -22,6 +22,7 @@ all of
 | [cfspacequota](#cfspacequota)                                                                   | `object`  | Optional | cannot be null | [JSON Schema for service parameters used in BTPSA](btpsa-parameters-properties-cf-space-quota.md "undefined#/properties/cfspacequota")                                                                                                                             |
 | [clusterregion](#clusterregion)                                                                 | `string`  | Optional | cannot be null | [JSON Schema for service parameters used in BTPSA](btpsa-parameters-properties-region-for-sap-btp-kyma-runtime-cluster.md "undefined#/properties/clusterregion")                                                                                                   |
 | [customAppProviderSubaccountId](#customappprovidersubaccountid)                                 | `string`  | Optional | cannot be null | [JSON Schema for service parameters used in BTPSA](btpsa-parameters-properties-provider-subaccount-id-of-custom-app-on-sap-btp.md "undefined#/properties/customAppProviderSubaccountId")                                                                           |
+| [defaultIdp](#defaultidp)                                                                       | `string`  | Optional | can be null    | [JSON Schema for service parameters used in BTPSA](btpsa-parameters-properties-default-idp.md "undefined#/properties/defaultIdp")                                                                                                                                  |
 | [directoryid](#directoryid)                                                                     | `string`  | Optional | can be null    | [JSON Schema for service parameters used in BTPSA](btpsa-parameters-properties-directory-id-in-sap-btp-global-account.md "undefined#/properties/directoryid")                                                                                                      |
 | [directoryname](#directoryname)                                                                 | `string`  | Optional | can be null    | [JSON Schema for service parameters used in BTPSA](btpsa-parameters-properties-directory-name-for-use-case.md "undefined#/properties/directoryname")                                                                                                               |
 | [envvariables](#envvariables)                                                                   | `object`  | Optional | cannot be null | [JSON Schema for service parameters used in BTPSA](btpsa-parameters-properties-list-of-environment-variables-on-os-level-to-be-used-within-commands-defined-in-the-executebeforeaccountsetup-and-executeafteraccountsetup.md "undefined#/properties/envvariables") |
@@ -218,6 +219,24 @@ id of provider sub account of custom app
 
 `string` ([provider subaccount id of custom app on SAP BTP](btpsa-parameters-properties-provider-subaccount-id-of-custom-app-on-sap-btp.md))
 
+## defaultIdp
+
+default identity provider for role collections
+
+`defaultIdp`
+
+*   is optional
+
+*   Type: `string` ([default IdP](btpsa-parameters-properties-default-idp.md))
+
+*   can be null
+
+*   defined in: [JSON Schema for service parameters used in BTPSA](btpsa-parameters-properties-default-idp.md "undefined#/properties/defaultIdp")
+
+### defaultIdp Type
+
+`string` ([default IdP](btpsa-parameters-properties-default-idp.md))
+
 ## directoryid
 
 id of the directory that should be used

diff --git a/...rties-role-collections-to-be-assigned-to-a-service-items-properties-idp-name.md b/...rties-role-collections-to-be-assigned-to-a-service-items-properties-idp-name.md
@@ -0,0 +1,3 @@
+## idp Type
+
+`string` ([IdP name](btpsa-usecase-properties-role-collections-to-be-assigned-to-a-service-items-properties-idp-name.md))
diff --git a/.../btpsa-usecase-properties-role-collections-to-be-assigned-to-a-service-items.md b/.../btpsa-usecase-properties-role-collections-to-be-assigned-to-a-service-items.md
@@ -8,6 +8,7 @@
 | :-------------------------------------------------------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | [assignedRoles](#assignedroles)                                             | `array`  | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-role-collections-to-be-assigned-to-a-service-items-properties-roles-for-custom-role-collection.md "undefined#/properties/assignrolecollections/items/properties/assignedRoles")                      |
 | [assignedUserGroupsFromParameterFile](#assignedusergroupsfromparameterfile) | `array`  | Required | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-role-collections-to-be-assigned-to-a-service-items-properties-user-groups-from-parameter-file.md "undefined#/properties/assignrolecollections/items/properties/assignedUserGroupsFromParameterFile") |
+| [idp](#idp)                                                                 | `string` | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-role-collections-to-be-assigned-to-a-service-items-properties-idp-name.md "undefined#/properties/assignrolecollections/items/properties/idp")                                                        |
 | [level](#level)                                                             | `string` | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-role-collections-to-be-assigned-to-a-service-items-properties-level-of-the-role-collection.md "undefined#/properties/assignrolecollections/items/properties/level")                                  |
 | [name](#name)                                                               | `string` | Required | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-role-collections-to-be-assigned-to-a-service-items-properties-name-of-the-role-collection.md "undefined#/properties/assignrolecollections/items/properties/name")                                    |
 | [type](#type)                                                               | `string` | Required | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-role-collections-to-be-assigned-to-a-service-items-properties-type-of-the-role-collection.md "undefined#/properties/assignrolecollections/items/properties/type")                                    |
@@ -48,6 +49,24 @@ user groups to be assigned from the parameter file
 
 `array` ([user groups from parameter file](btpsa-usecase-properties-role-collections-to-be-assigned-to-a-service-items-properties-user-groups-from-parameter-file.md))
 
+## idp
+
+the identity provider that hosts the user.
+
+`idp`
+
+*   is optional
+
+*   Type: `string` ([IdP name](btpsa-usecase-properties-role-collections-to-be-assigned-to-a-service-items-properties-idp-name.md))
+
+*   cannot be null
+
+*   defined in: [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-role-collections-to-be-assigned-to-a-service-items-properties-idp-name.md "undefined#/properties/assignrolecollections/items/properties/idp")
+
+### idp Type
+
+`string` ([IdP name](btpsa-usecase-properties-role-collections-to-be-assigned-to-a-service-items-properties-idp-name.md))
+
 ## level
 
 level of the role collection

diff --git a/...perties-services-items-allof-1-then-allof-12-then-allof-0-if-properties-plan.md b/...perties-services-items-allof-1-then-allof-12-then-allof-0-if-properties-plan.md
@@ -7,5 +7,5 @@ unknown
 **constant**: the value of this property must be equal to:
 
 ```json
-"default"
+"central"
 ```
diff --git a/...tpsa-usecase-properties-services-items-allof-1-then-allof-12-then-allof-0-if.md b/...tpsa-usecase-properties-services-items-allof-1-then-allof-12-then-allof-0-if.md
@@ -31,5 +31,5 @@ unknown
 **constant**: the value of this property must be equal to:
 
 ```json
-"default"
+"central"
 ```
diff --git a/...sa-usecase-properties-services-items-allof-1-then-allof-12-then-allof-0-then.md b/...sa-usecase-properties-services-items-allof-1-then-allof-12-then-allof-0-then.md
@@ -10,27 +10,9 @@ unknown
 
 ## plan
 
-service plan >default< for >auditlog-management< is available in data centers:
-
-*   {'region': 'ap10', 'name': 'Australia (Sydney)'}
-*   {'region': 'ap11', 'name': 'Singapore'}
-*   {'region': 'ap12', 'name': 'South Korea (Seoul)'}
-*   {'region': 'ap20', 'name': 'Australia (Sydney) Azure'}
-*   {'region': 'ap21', 'name': 'Singapore'}
-*   {'region': 'br10', 'name': 'Brazil (Sao Paulo)'}
-*   {'region': 'ca10', 'name': 'Canada (Montreal)'}
-*   {'region': 'ch20', 'name': 'cf-ch20'}
+service plan >central< for >auditlog-management< is available in data centers:
+
 *   {'region': 'eu10', 'name': 'Europe (Frankfurt)'}
-*   {'region': 'eu11', 'name': 'Europe (Frankfurt) EU Access - AWS'}
-*   {'region': 'eu20', 'name': 'Europe (Netherlands)'}
-*   {'region': 'eu30', 'name': 'Europe (Frankfurt)'}
-*   {'region': 'in30', 'name': 'India (Mumbai)'}
-*   {'region': 'jp10', 'name': 'Japan (Tokyo)'}
-*   {'region': 'jp20', 'name': 'Japan (Tokyo)'}
-*   {'region': 'us10', 'name': 'US East (VA)'}
-*   {'region': 'us20', 'name': 'US West (WA)'}
-*   {'region': 'us21', 'name': 'US East (VA)'}
-*   {'region': 'us30', 'name': 'US Central (IA)'}
 
 `plan`
 

diff --git a/...perties-services-items-allof-1-then-allof-12-then-allof-1-if-properties-plan.md b/...perties-services-items-allof-1-then-allof-12-then-allof-1-if-properties-plan.md
@@ -0,0 +1,11 @@
+## plan Type
+
+unknown
+
+## plan Constraints
+
+**constant**: the value of this property must be equal to:
+
+```json
+"default"
+```
diff --git a/...e-properties-services-items-allof-1-then-allof-12-then-allof-1-if-properties.md b/...e-properties-services-items-allof-1-then-allof-12-then-allof-1-if-properties.md
@@ -0,0 +1,3 @@
+## properties Type
+
+unknown
diff --git a/...tpsa-usecase-properties-services-items-allof-1-then-allof-12-then-allof-1-if.md b/...tpsa-usecase-properties-services-items-allof-1-then-allof-12-then-allof-1-if.md
@@ -0,0 +1,35 @@
+## if Type
+
+unknown
+
+# if Properties
+
+| Property      | Type          | Required | Nullable       | Defined by                                                                                                                                                                                                                                  |
+| :------------ | :------------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [plan](#plan) | Not specified | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-12-then-allof-1-if-properties-plan.md "undefined#/properties/services/items/allOf/1/then/allOf/12/then/allOf/1/if/properties/plan") |
+
+## plan
+
+
+
+`plan`
+
+*   is optional
+
+*   Type: unknown
+
+*   cannot be null
+
+*   defined in: [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-12-then-allof-1-if-properties-plan.md "undefined#/properties/services/items/allOf/1/then/allOf/12/then/allOf/1/if/properties/plan")
+
+### plan Type
+
+unknown
+
+### plan Constraints
+
+**constant**: the value of this property must be equal to:
+
+```json
+"default"
+```
diff --git a/...rties-services-items-allof-1-then-allof-12-then-allof-1-then-properties-plan.md b/...rties-services-items-allof-1-then-allof-12-then-allof-1-then-properties-plan.md
@@ -0,0 +1,3 @@
+## plan Type
+
+unknown
diff --git a/...properties-services-items-allof-1-then-allof-12-then-allof-1-then-properties.md b/...properties-services-items-allof-1-then-allof-12-then-allof-1-then-properties.md
@@ -0,0 +1,3 @@
+## properties Type
+
+unknown
diff --git a/...sa-usecase-properties-services-items-allof-1-then-allof-12-then-allof-1-then.md b/...sa-usecase-properties-services-items-allof-1-then-allof-12-then-allof-1-then.md
@@ -0,0 +1,47 @@
+## then Type
+
+unknown
+
+# then Properties
+
+| Property      | Type          | Required | Nullable       | Defined by                                                                                                                                                                                                                                      |
+| :------------ | :------------ | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [plan](#plan) | Not specified | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-12-then-allof-1-then-properties-plan.md "undefined#/properties/services/items/allOf/1/then/allOf/12/then/allOf/1/then/properties/plan") |
+
+## plan
+
+service plan >default< for >auditlog-management< is available in data centers:
+
+*   {'region': 'ap10', 'name': 'Australia (Sydney)'}
+*   {'region': 'ap11', 'name': 'Singapore'}
+*   {'region': 'ap12', 'name': 'South Korea (Seoul)'}
+*   {'region': 'ap20', 'name': 'Australia (Sydney) Azure'}
+*   {'region': 'ap21', 'name': 'Singapore'}
+*   {'region': 'br10', 'name': 'Brazil (Sao Paulo)'}
+*   {'region': 'ca10', 'name': 'Canada (Montreal)'}
+*   {'region': 'ch20', 'name': 'cf-ch20'}
+*   {'region': 'eu10', 'name': 'Europe (Frankfurt)'}
+*   {'region': 'eu11', 'name': 'Europe (Frankfurt) EU Access - AWS'}
+*   {'region': 'eu20', 'name': 'Europe (Netherlands)'}
+*   {'region': 'eu30', 'name': 'Europe (Frankfurt)'}
+*   {'region': 'in30', 'name': 'India (Mumbai)'}
+*   {'region': 'jp10', 'name': 'Japan (Tokyo)'}
+*   {'region': 'jp20', 'name': 'Japan (Tokyo)'}
+*   {'region': 'us10', 'name': 'US East (VA)'}
+*   {'region': 'us20', 'name': 'US West (WA)'}
+*   {'region': 'us21', 'name': 'US East (VA)'}
+*   {'region': 'us30', 'name': 'US Central (IA)'}
+
+`plan`
+
+*   is optional
+
+*   Type: unknown
+
+*   cannot be null
+
+*   defined in: [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-12-then-allof-1-then-properties-plan.md "undefined#/properties/services/items/allOf/1/then/allOf/12/then/allOf/1/then/properties/plan")
+
+### plan Type
+
+unknown
diff --git a/...d/btpsa-usecase-properties-services-items-allof-1-then-allof-12-then-allof-1.md b/...d/btpsa-usecase-properties-services-items-allof-1-then-allof-12-then-allof-1.md
@@ -0,0 +1,3 @@
+## 1 Type
+
+unknown
diff --git a/...usecase-properties-services-items-allof-1-then-allof-12-then-properties-plan.md b/...usecase-properties-services-items-allof-1-then-allof-12-then-properties-plan.md
@@ -8,4 +8,5 @@ unknown
 
 | Value       | Explanation |
 | :---------- | :---------- |
+| `"central"` |             |
 | `"default"` |             |
diff --git a/...generated/btpsa-usecase-properties-services-items-allof-1-then-allof-12-then.md b/...generated/btpsa-usecase-properties-services-items-allof-1-then-allof-12-then.md
@@ -6,6 +6,8 @@ all of
 
 *   [Untitled undefined type in JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-12-then-allof-0.md "check type definition")
 
+*   [Untitled undefined type in JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-12-then-allof-1.md "check type definition")
+
 # then Properties
 
 | Property      | Type          | Required | Nullable       | Defined by                                                                                                                                                                                                            |
@@ -37,6 +39,7 @@ unknown
 
 | Value       | Explanation |
 | :---------- | :---------- |
+| `"central"` |             |
 | `"default"` |             |
 
 ## name

diff --git a/...generated/btpsa-usecase-properties-services-items-allof-1-then-allof-52-then.md b/...generated/btpsa-usecase-properties-services-items-allof-1-then-allof-52-then.md
@@ -41,7 +41,7 @@ unknown
 
 ## name
 
-IoT Services: The SAP Business Technology Platform Internet of Things service for the Cloud Foundry environment connects devices to SAP Business Technology Platform to provide scalable ingestion of IoT data and device management. The respective services provide a secure connection to remote devices using a broad variety of IoT protocols and manage the device lifecycle from onboarding to decommissioning.
+Internet of Things: The SAP Business Technology Platform Internet of Things service for the Cloud Foundry environment connects devices to SAP Business Technology Platform to provide scalable ingestion of IoT data and device management. The respective services provide a secure connection to remote devices using a broad variety of IoT protocols and manage the device lifecycle from onboarding to decommissioning.
 
 `name`
 

diff --git a/...generated/btpsa-usecase-properties-services-items-allof-1-then-allof-53-then.md b/...generated/btpsa-usecase-properties-services-items-allof-1-then-allof-53-then.md
@@ -44,7 +44,7 @@ unknown
 
 ## name
 
-SAP IoT Application Enablement: SAP IoT business services allow you to put raw sensor data into business object context and then use query models, rules, events and actions to leverage the data near real-time in analytical or transactional business applications.
+SAP IoT: SAP IoT business services allow you to put raw sensor data into business object context and then use query models, rules, events and actions to leverage the data near real-time in analytical or transactional business applications.
 
 `name`
 

diff --git a/...generated/btpsa-usecase-properties-services-items-allof-1-then-allof-62-then.md b/...generated/btpsa-usecase-properties-services-items-allof-1-then-allof-62-then.md
@@ -41,7 +41,7 @@ unknown
 
 ## name
 
-Machine Learning Foundation: SAP Leonardo Machine Learning Foundation enables you to enhance business processes and software applications with intelligence. Unlock knowledge from structured and unstructured data such as images, text, time series and tabular data. By consuming easy-to-use APIs you can detect the content of pictures, extract keywords from natural language texts or analyze and forecast time-series data. All this can be done without prior investmentintospecial hardware or expertise in machine learning. Besides using pre-trained ML services you can also deploy custom ML models or tune existing models with your own training data. This allows you to easily serve customized ML models for critical business processes in a scalable and secure manner.
+SAP Leonardo ML Foundation: SAP Leonardo Machine Learning Foundation enables you to enhance business processes and software applications with intelligence. Unlock knowledge from structured and unstructured data such as images, text, time series and tabular data. By consuming easy-to-use APIs you can detect the content of pictures, extract keywords from natural language texts or analyze and forecast time-series data. All this can be done without prior investmentintospecial hardware or expertise in machine learning. Besides using pre-trained ML services you can also deploy custom ML models or tune existing models with your own training data. This allows you to easily serve customized ML models for critical business processes in a scalable and secure manner.
 
 `name`
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## defaultIdp Type

		`string` ([default IdP](btpsa-parameters-properties-default-idp.md))
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## idp Type

		`string` ([IdP name](btpsa-usecase-properties-role-collections-to-be-assigned-to-a-service-items-properties-idp-name.md))
-Original file line number
+Diff line change
@@ Expand Up / @@ -41,7 +41,7 @@ unknown @@
     ## name
-    IoT Services: The SAP Business Technology Platform Internet of Things service for the Cloud Foundry environment connects devices to SAP Business Technology Platform to provide scalable ingestion of IoT data and device management. The respective services provide a secure connection to remote devices using a broad variety of IoT protocols and manage the device lifecycle from onboarding to decommissioning.
+    Internet of Things: The SAP Business Technology Platform Internet of Things service for the Cloud Foundry environment connects devices to SAP Business Technology Platform to provide scalable ingestion of IoT data and device management. The respective services provide a secure connection to remote devices using a broad variety of IoT protocols and manage the device lifecycle from onboarding to decommissioning.
     `name`
@@ Expand Down @@