Skip to content
This repository was archived by the owner on Feb 13, 2024. It is now read-only.

Commit 300e193

Browse files
author
[btpsa bot] docu generation
committed
[btpsa bot] Generate parameter documentation
1 parent c23ddb9 commit 300e193

4 files changed

+107
-1
lines changed

‎docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-0-then-allof-0-then-properties-parameters-properties-admin-user-name.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## admin\_user\_name Type
2+
3+
`string` ([Admin User Name](btpsa-usecase-properties-services-items-allof-1-then-allof-0-then-allof-0-then-properties-parameters-properties-admin-user-name.md))
4+
5+
## admin\_user\_name Constraints
6+
7+
**maximum length**: the maximum number of characters for this string is: `40`
8+
9+
**minimum length**: the minimum number of characters for this string is: `0`
10+
11+
**pattern**: the string must match the following regular expression: 
12+
13+
```regexp
14+
^(?!SAP_|_)[\.A-Z0-9_-]{0,40}$
15+
```
16+
17+
[try pattern](https://regexr.com/?expression=%5E\(%3F!SAP_%7C_\)%5B%5C.A-Z0-9_-%5D%7B0%2C40%7D%24 "try regular expression with regexr.com")

‎docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-0-then-allof-0-then-properties-parameters-properties-login-attribute.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## login\_attribute Type
2+
3+
`string` ([Login Attribute](btpsa-usecase-properties-services-items-allof-1-then-allof-0-then-allof-0-then-properties-parameters-properties-login-attribute.md))
4+
5+
## login\_attribute Constraints
6+
7+
**enum**: the value of this property must be equal to one of the following values:
8+
9+
| Value | Explanation |
10+
| :------------ | :---------- |
11+
| `"email"` | |
12+
| `"user_name"` | |
13+
14+
## login\_attribute Default Value
15+
16+
The default value is:
17+
18+
```json
19+
"email"
20+
```

‎docs/generated/btpsa-usecase-properties-services-items-allof-1-then-allof-0-then-allof-0-then-properties-parameters.md

+69
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@
77
| Property | Type | Required | Nullable | Defined by |
88
| :-------------------------------------------------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
99
| [admin\_email](#admin_email) | `string` | Required | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-0-then-allof-0-then-properties-parameters-properties-admin-email-address.md "undefined#/properties/services/items/allOf/1/then/allOf/0/then/allOf/0/then/properties/parameters/properties/admin_email") |
10+
| [admin\_user\_name](#admin_user_name) | `string` | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-0-then-allof-0-then-properties-parameters-properties-admin-user-name.md "undefined#/properties/services/items/allOf/1/then/allOf/0/then/allOf/0/then/properties/parameters/properties/admin_user_name") |
1011
| [description](#description) | `string` | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-0-then-allof-0-then-properties-parameters-properties-abap-system-description.md "undefined#/properties/services/items/allOf/1/then/allOf/0/then/allOf/0/then/properties/parameters/properties/description") |
1112
| [is\_development\_allowed](#is_development_allowed) | `boolean` | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-0-then-allof-0-then-properties-parameters-properties-development-system.md "undefined#/properties/services/items/allOf/1/then/allOf/0/then/allOf/0/then/properties/parameters/properties/is_development_allowed") |
13+
| [login\_attribute](#login_attribute) | `string` | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-0-then-allof-0-then-properties-parameters-properties-login-attribute.md "undefined#/properties/services/items/allOf/1/then/allOf/0/then/allOf/0/then/properties/parameters/properties/login_attribute") |
1214
| [sapsystemname](#sapsystemname) | `string` | Optional | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-0-then-allof-0-then-properties-parameters-properties-abap-system-id.md "undefined#/properties/services/items/allOf/1/then/allOf/0/then/allOf/0/then/properties/parameters/properties/sapsystemname") |
1315
| [size\_of\_persistence](#size_of_persistence) | `integer` | Required | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-0-then-allof-0-then-properties-parameters-properties-hana-memory-size.md "undefined#/properties/services/items/allOf/1/then/allOf/0/then/allOf/0/then/properties/parameters/properties/size_of_persistence") |
1416
| [size\_of\_runtime](#size_of_runtime) | `integer` | Required | cannot be null | [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-0-then-allof-0-then-properties-parameters-properties-abap-runtime-size.md "undefined#/properties/services/items/allOf/1/then/allOf/0/then/allOf/0/then/properties/parameters/properties/size_of_runtime") |
@@ -45,6 +47,38 @@ Enter the administrator's email address
4547

4648
[try pattern](https://regexr.com/?expression=%5E%5B%5E%3C%3E\(\)%5C%5B%5C%5D%5C%5C%2C%3B%3A%5Cs%40%22%60%5D%2B%40\(%5Ba-zA-Z%5C-0-9%5D%2B%5C.\)%2B%5Ba-zA-Z%5D%7B2%2C%7D%24 "try regular expression with regexr.com")
4749

50+
## admin\_user\_name
51+
52+
Optionally enter the username of the administrator. The username must not begin with SAP\_ or \_, must only contain uppercase letters, digits, underscores, hyphens and periods, and must not be longer than 40 characters.
53+
54+
`admin_user_name`
55+
56+
* is optional
57+
58+
* Type: `string` ([Admin User Name](btpsa-usecase-properties-services-items-allof-1-then-allof-0-then-allof-0-then-properties-parameters-properties-admin-user-name.md))
59+
60+
* cannot be null
61+
62+
* defined in: [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-0-then-allof-0-then-properties-parameters-properties-admin-user-name.md "undefined#/properties/services/items/allOf/1/then/allOf/0/then/allOf/0/then/properties/parameters/properties/admin_user_name")
63+
64+
### admin\_user\_name Type
65+
66+
`string` ([Admin User Name](btpsa-usecase-properties-services-items-allof-1-then-allof-0-then-allof-0-then-properties-parameters-properties-admin-user-name.md))
67+
68+
### admin\_user\_name Constraints
69+
70+
**maximum length**: the maximum number of characters for this string is: `40`
71+
72+
**minimum length**: the minimum number of characters for this string is: `0`
73+
74+
**pattern**: the string must match the following regular expression: 
75+
76+
```regexp
77+
^(?!SAP_|_)[\.A-Z0-9_-]{0,40}$
78+
```
79+
80+
[try pattern](https://regexr.com/?expression=%5E\(%3F!SAP_%7C_\)%5B%5C.A-Z0-9_-%5D%7B0%2C40%7D%24 "try regular expression with regexr.com")
81+
4882
## description
4983

5084
Enter a description for the ABAP system
@@ -101,6 +135,41 @@ The default value is:
101135
true
102136
```
103137

138+
## login\_attribute
139+
140+
Which attribute should be used for login.
141+
142+
`login_attribute`
143+
144+
* is optional
145+
146+
* Type: `string` ([Login Attribute](btpsa-usecase-properties-services-items-allof-1-then-allof-0-then-allof-0-then-properties-parameters-properties-login-attribute.md))
147+
148+
* cannot be null
149+
150+
* defined in: [JSON Schema for BTPSA use case definitions](btpsa-usecase-properties-services-items-allof-1-then-allof-0-then-allof-0-then-properties-parameters-properties-login-attribute.md "undefined#/properties/services/items/allOf/1/then/allOf/0/then/allOf/0/then/properties/parameters/properties/login_attribute")
151+
152+
### login\_attribute Type
153+
154+
`string` ([Login Attribute](btpsa-usecase-properties-services-items-allof-1-then-allof-0-then-allof-0-then-properties-parameters-properties-login-attribute.md))
155+
156+
### login\_attribute Constraints
157+
158+
**enum**: the value of this property must be equal to one of the following values:
159+
160+
| Value | Explanation |
161+
| :------------ | :---------- |
162+
| `"email"` | |
163+
| `"user_name"` | |
164+
165+
### login\_attribute Default Value
166+
167+
The default value is:
168+
169+
```json
170+
"email"
171+
```
172+
104173
## sapsystemname
105174

106175
Enter a valid system ID (SID) for the ABAP system. The ID must consist of exactly three alphanumeric characters. Only uppercase letters are allowed. The first character must be a letter (not a digit). The ID does not have to be technically unique. The following IDs are reserved and cannot be used: ADD ALL AMD AND ANY ARE ASC AUX AVG BIT CDC COM CON DBA END EPS FOR GET GID IBM INT KEY LOG LPT MAP MAX MIN MON NIX NOT NUL OFF OLD OMS OUT PAD PRN RAW REF ROW SAP SET SGA SHG SID SQL SUM SYS TMP TOP UID USE USR VAR.

‎libs/btpsa-usecase.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,7 @@
366366
"then" :{
367367
"properties": {
368368
"plan": { "description": "service plan >16_abap_64_db< for >abap< is available in data centers:\n- {'region': 'eu10', 'name': 'Europe (Frankfurt)'}\n- {'region': 'jp10', 'name': 'Japan (Tokyo)'}\n- {'region': 'us10', 'name': 'US East (VA)'}" }
369-
, "parameters" : {"$schema": "http://json-schema.org/draft-07/schema", "_controlsOrder": ["admin_email", "description", "is_development_allowed", "sapsystemname", "size_of_runtime", "size_of_persistence"], "_show_form_view": true, "additionalProperties": false, "properties": {"admin_email": {"description": "Enter the administrator\u0027s email address", "maxLength": 256, "minLength": 6, "pattern": "^[^\u003c\u003e()\\[\\]\\\\,;:\\s@\"`]+@([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}$", "title": "Admin Email Address", "type": "string"}, "description": {"description": "Enter a description for the ABAP system", "maxLength": 256, "pattern": "^[^\u0027\\x00-\\x1f]*$", "title": "ABAP System Description", "type": "string"}, "is_development_allowed": {"default": true, "description": "Specify, if development shall be allowed on this ABAP system", "title": "Development System", "type": "boolean"}, "sapsystemname": {"default": "H01", "description": "Enter a valid system ID (SID) for the ABAP system. The ID must consist of exactly three alphanumeric characters. Only uppercase letters are allowed. The first character must be a letter (not a digit). The ID does not have to be technically unique. The following IDs are reserved and cannot be used: ADD ALL AMD AND ANY ARE ASC AUX AVG BIT CDC COM CON DBA END EPS FOR GET GID IBM INT KEY LOG LPT MAP MAX MIN MON NIX NOT NUL OFF OLD OMS OUT PAD PRN RAW REF ROW SAP SET SGA SHG SID SQL SUM SYS TMP TOP UID USE USR VAR.", "maxLength": 3, "minLength": 3, "pattern": "^(?!ADD|ALL|AMD|AND|ANY|ARE|ASC|AUX|AVG|BIT|CDC|COM|CON|DBA|END|EPS|FOR|GET|GID|IBM|INT|KEY|LOG|LPT|MAP|MAX|MIN|MON|NIX|NOT|NUL|OFF|OLD|OMS|OUT|PAD|PRN|RAW|REF|ROW|SAP|SET|SGA|SHG|SID|SQL|SUM|SYS|TMP|TOP|UID|USE|USR|VAR)[A-Z][A-Z0-9]{2}$", "title": "ABAP System ID", "type": "string"}, "size_of_persistence": {"const": 4, "default": 4, "description": "Enter the size of the HANA memory in blocks of 15 GB on AWS", "title": "HANA Memory Size", "type": "integer"}, "size_of_runtime": {"const": 1, "default": 1, "description": "Enter the size of the ABAP runtime in blocks of 16 GB", "title": "ABAP Runtime Size", "type": "integer"}}, "required": ["admin_email", "size_of_persistence", "size_of_runtime"], "type": "object"}
369+
, "parameters" : {"$schema": "http://json-schema.org/draft-07/schema", "_controlsOrder": ["admin_email", "description", "is_development_allowed", "sapsystemname", "size_of_runtime", "size_of_persistence"], "_show_form_view": true, "additionalProperties": false, "properties": {"admin_email": {"description": "Enter the administrator\u0027s email address", "maxLength": 256, "minLength": 6, "pattern": "^[^\u003c\u003e()\\[\\]\\\\,;:\\s@\"`]+@([a-zA-Z\\-0-9]+\\.)+[a-zA-Z]{2,}$", "title": "Admin Email Address", "type": "string"}, "admin_user_name": {"description": "Optionally enter the username of the administrator. The username must not begin with SAP_ or _, must only contain uppercase letters, digits, underscores, hyphens and periods, and must not be longer than 40 characters.", "maxLength": 40, "minLength": 0, "pattern": "^(?!SAP_|_)[\\.A-Z0-9_-]{0,40}$", "title": "Admin User Name", "type": "string"}, "description": {"description": "Enter a description for the ABAP system", "maxLength": 256, "pattern": "^[^\u0027\\x00-\\x1f]*$", "title": "ABAP System Description", "type": "string"}, "is_development_allowed": {"default": true, "description": "Specify, if development shall be allowed on this ABAP system", "title": "Development System", "type": "boolean"}, "login_attribute": {"default": "email", "description": "Which attribute should be used for login.", "enum": ["email", "user_name"], "title": "Login Attribute", "type": "string"}, "sapsystemname": {"default": "H01", "description": "Enter a valid system ID (SID) for the ABAP system. The ID must consist of exactly three alphanumeric characters. Only uppercase letters are allowed. The first character must be a letter (not a digit). The ID does not have to be technically unique. The following IDs are reserved and cannot be used: ADD ALL AMD AND ANY ARE ASC AUX AVG BIT CDC COM CON DBA END EPS FOR GET GID IBM INT KEY LOG LPT MAP MAX MIN MON NIX NOT NUL OFF OLD OMS OUT PAD PRN RAW REF ROW SAP SET SGA SHG SID SQL SUM SYS TMP TOP UID USE USR VAR.", "maxLength": 3, "minLength": 3, "pattern": "^(?!ADD|ALL|AMD|AND|ANY|ARE|ASC|AUX|AVG|BIT|CDC|COM|CON|DBA|END|EPS|FOR|GET|GID|IBM|INT|KEY|LOG|LPT|MAP|MAX|MIN|MON|NIX|NOT|NUL|OFF|OLD|OMS|OUT|PAD|PRN|RAW|REF|ROW|SAP|SET|SGA|SHG|SID|SQL|SUM|SYS|TMP|TOP|UID|USE|USR|VAR)[A-Z][A-Z0-9]{2}$", "title": "ABAP System ID", "type": "string"}, "size_of_persistence": {"const": 4, "default": 4, "description": "Enter the size of the HANA memory in blocks of 15 GB on AWS", "title": "HANA Memory Size", "type": "integer"}, "size_of_runtime": {"const": 1, "default": 1, "description": "Enter the size of the ABAP runtime in blocks of 16 GB", "title": "ABAP Runtime Size", "type": "integer"}}, "required": ["admin_email", "size_of_persistence", "size_of_runtime"], "type": "object"}
370370

371371
}, "required" : ["parameters"]
372372

0 commit comments

Comments
 (0)