Skip to content

Commit 4b0dbfe

Browse files
authored
Merge pull request #242 from eclipse-tractusx/release/v1.8.0-RC3
build(1.8.0-RC3): merge release into main
2 parents 61743e3 + dd5ccee commit 4b0dbfe

File tree

397 files changed

+1183
-261
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

397 files changed

+1183
-261
lines changed

.vscode/settings.json

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
{
2+
"fileHeaderComment.parameter": {
3+
"*": {
4+
"commentbegin": "/********************************************************************************",
5+
"commentend": " ********************************************************************************/",
6+
"commentprefix": "",
7+
"commentbegin#": "###############################################################",
8+
"commentend#": "###############################################################",
9+
"commentprefix#": "#",
10+
"commentbegin<!->": "<!--",
11+
"commentend<!->": "-->",
12+
"commentprefix<!->": "-",
13+
"cx_header_default": [
14+
"* Copyright (c) 2024 Contributors to the Eclipse Foundation",
15+
" *",
16+
" * See the NOTICE file(s) distributed with this work for additional",
17+
" * information regarding copyright ownership.",
18+
" *",
19+
" * This program and the accompanying materials are made available under the",
20+
" * terms of the Apache License, Version 2.0 which is available at",
21+
" * https://www.apache.org/licenses/LICENSE-2.0.",
22+
" *",
23+
" * Unless required by applicable law or agreed to in writing, software",
24+
" * distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT",
25+
" * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the",
26+
" * License for the specific language governing permissions and limitations",
27+
" * under the License.",
28+
" *",
29+
" * SPDX-License-Identifier: Apache-2.0"
30+
],
31+
"cx_header_with_#": [
32+
"Copyright (c) 2024 Contributors to the Eclipse Foundation",
33+
"",
34+
" See the NOTICE file(s) distributed with this work for additional",
35+
" information regarding copyright ownership.",
36+
"",
37+
" This program and the accompanying materials are made available under the",
38+
" terms of the Apache License, Version 2.0 which is available at",
39+
" https://www.apache.org/licenses/LICENSE-2.0.",
40+
"",
41+
" Unless required by applicable law or agreed to in writing, software",
42+
" distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT",
43+
" WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the",
44+
" License for the specific language governing permissions and limitations",
45+
" under the License.",
46+
"",
47+
" SPDX-License-Identifier: Apache-2.0"
48+
],
49+
"cx_header_with_<!->": [
50+
"Copyright (c) 2024 Contributors to the Eclipse Foundation",
51+
"-",
52+
"- See the NOTICE file(s) distributed with this work for additional",
53+
"- information regarding copyright ownership.",
54+
"-",
55+
"- This program and the accompanying materials are made available under the",
56+
"- terms of the Apache License, Version 2.0 which is available at",
57+
"- https://www.apache.org/licenses/LICENSE-2.0.",
58+
"-",
59+
"- Unless required by applicable law or agreed to in writing, software",
60+
"- distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT",
61+
"- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the",
62+
"- License for the specific language governing permissions and limitations",
63+
"- under the License.",
64+
"-",
65+
"- SPDX-License-Identifier: Apache-2.0"
66+
]
67+
}
68+
},
69+
"fileHeaderComment.template": {
70+
"cx_header_default": [
71+
"${commentbegin}",
72+
"${commentprefix} ${cx_header_default}",
73+
"${commentend}"
74+
],
75+
"cx_header_with_<!->": [
76+
"${commentbegin<!->}",
77+
"${commentprefix<!->} ${cx_header_with_<!->}",
78+
"${commentend<!->}"
79+
],
80+
"cx_header_with_#": [
81+
"${commentbegin#}",
82+
"${commentprefix#} ${cx_header_with_#}",
83+
"${commentend#}"
84+
]
85+
}
86+
}

CHANGELOG.md

+13
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,19 @@
22

33
New features, fixed bugs, known defects and other noteworthy changes to each release of the Catena-X Portal Assets.
44

5+
## 1.8.0-RC3
6+
7+
### Change
8+
9+
- removed references to consortia environments
10+
- removed image reference to catena-ng in documentation
11+
- adjusted directory structure for app and service release process documentation
12+
- enhanced local development documentation for frontend in regards to backend and interface connection
13+
14+
### Bugfix
15+
16+
- added standard library template to sections under company roles
17+
518
## 1.8.0-RC2
619

720
### Change

FILEHEADER.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Copyright and License Header
2+
3+
Where possible, all source code, property files, and metadata files (including application, test, and generated source code as well as other types of files such as XML, HTML, etc.) must include a header with appropriate copyright and license notices.
4+
5+
## Use the 'File Header Comment' VS Code extension
6+
7+
It's recommended to use the [File Header Comment](https://marketplace.visualstudio.com/items?itemName=doi.fileheadercomment) VS Code extension because it allows us to share the header within the team by the .vscode/settings.json.
8+
9+
Install the extension and assign some [keyboard shortcut](https://code.visualstudio.com/docs/getstarted/keybindings#_keyboard-shortcuts-editor) to the extension insertFileHeaderCommentOther, Ctrl+Alt+I for instance.
10+
11+
Every time you create a new file or edit a file that you created and doesn't yet have a header, use the keyboard shortcut to insert the according header template in the file.
12+
13+
Currently the following templates are available:
14+
15+
- cx_header_default
16+
- cx*header_with*#

docs/developer/01. Onboarding/03. Registration Approval/03. Registration Approval Process.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -551,7 +551,8 @@ Response "Success" => set status to "DONE"
551551
##### Details "Activation"
552552

553553
<p align="center">
554-
<img width="687" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/e5663f3b-6e45-46f1-aee7-d2f0a3d4f59e">
554+
<img width="687" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/identity-wallet-overview.png
555+
">
555556
</p>p>
556557

557558
<br>

docs/developer/02. Technical Integration/01. Connector Registration/01. Summary.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ In the technical integration / setup of the connector, 3 different scenarios are
2121
For the scenario "bring your own connector", the user will be able to register the connector by entering the relevant information. In the case of a "connector as a service" case, the relevant data fields need to get still defined by the Product Team CaaS (not in scope for release 1)
2222
<br>
2323
<br>
24-
<img width="1313" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/be138852-6112-4914-9572-c7d9f332e408">
24+
<img width="1313" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/connector-registration-overview.png">
2525
<br>
2626
<br>
2727

docs/developer/02. Technical Integration/01. Connector Registration/02. View Connector.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<br>
66
<p align="center">
7-
<img width="826" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/5f14e599-8d68-4ff4-8a4a-5db57dc98af7">
7+
<img width="826" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/connector-registration-webpage.png">
88
</p>
99
<br>
1010

@@ -151,7 +151,7 @@ Response Body
151151

152152
Data Mapping
153153

154-
<img width="938" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/fc2a4838-094d-47f3-bbc1-3a1e3a2b0f9a">
154+
<img width="938" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/connector-registration-webpage-data-mapping.png">
155155

156156
<br>
157157
<br>

docs/developer/02. Technical Integration/01. Connector Registration/03. Create new Connector Registration.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## 1. Create new Connector Registration - self-owned
22

33
<br>
4-
<img width="1267" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/4f3056d5-a2a3-4dc5-8225-aaf4db5a04dc">
4+
<img width="1267" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/connector-registration-self-owned.png">
55
<br>
66
<br>
77

@@ -135,7 +135,7 @@ Request Body
135135

136136
## 2. Create new Connector Registration - managed
137137

138-
<img width="1309" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/4f0167ec-aaee-46d1-8646-064d6a7ed7c6">
138+
<img width="1309" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/connector-registration-managed.png">
139139

140140
<br>
141141
<br>
@@ -224,7 +224,7 @@ Request Body
224224
> }
225225
> ]
226226
>
227-
> <img width="740" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/892595c3-6afa-41ec-bdcf-e09fc567541b">
227+
> <img width="740" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/connector-application-endpoint.png">
228228
229229
<br>
230230
<br>

docs/developer/02. Technical Integration/01. Connector Registration/07. Error Handling.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ In case the endpoint runs on an 500 error the following error will get displayed
2424

2525
<br>
2626

27-
<img width="1256" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/a1e3b734-1062-444c-8e70-4da02ceaa0d4">
27+
<img width="1256" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/managed-connectors-overview-load-failed.png">
2828

2929
<br>
3030

@@ -34,7 +34,7 @@ In case the endpoint runs on an 4xx error the following error will get displayed
3434

3535
<br>
3636

37-
<img width="1249" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/2693f37c-8224-4f1e-9ce4-4ddcfbb0ee7d">
37+
<img width="1249" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/managed-connectors-overview-error.png">
3838

3939
<br>
4040

docs/developer/02. Technical Integration/02. Identity Provider Management/02. Company IdPs.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<br>
44

55
<p align="center">
6-
<img width="613" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/67fb1a76-2cfe-48c1-9630-cdaefd655718">
6+
<img width="613" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/idp-overview-webpage.png">
77
</p>
88

99
Functional Link: [Link](/docs/user/02.%20Technical%20Integration/02.%20Identity%20Provider%20Management/02.%20Company%20IdPs.md)
@@ -20,7 +20,7 @@ Hover Content
2020

2121
Status #1 - currently not needed/relevant
2222

23-
<img width="139" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/1f7828a9-b1bd-4031-b0a1-d9bf7030aca9">
23+
<img width="139" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/idp-progress-dots.png">
2424

2525
<br>
2626

@@ -30,7 +30,7 @@ Display the status element as shown below, if the IdP is available but no "clien
3030

3131
<br>
3232

33-
<img width="146" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/65b50af3-a022-4fdb-9706-59dcf5041890">
33+
<img width="146" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/idp-progress-dots-partial.png">
3434

3535
<br>
3636

@@ -46,7 +46,7 @@ Display the status element as shown below, if the IdP is available, has a "clien
4646

4747
<br>
4848

49-
<img width="123" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/179fa508-0202-434f-bc8d-c85d815ff092">
49+
<img width="123" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/idp-progress-dots-failed.png">
5050

5151
<br>
5252

@@ -62,7 +62,7 @@ IdP active. Means => the IdP is enabled (enabled=true)
6262

6363
<br>
6464

65-
<img width="136" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/5380c4e6-cc34-4165-bd0b-4c3e3b70deff">
65+
<img width="136" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/idp-progress-dots-success.png">
6666

6767
<br>
6868

docs/developer/02. Technical Integration/02. Identity Provider Management/02. Configure Company IdP.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The initial overlay is used to create the IdP record with the respective IdP typ
1111
<br>
1212

1313
<p align="center">
14-
<img width="680" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/59a5444f-c789-4d0f-8473-9618983bd711">
14+
<img width="680" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/create-idp-start.png>
1515
</p>
1616

1717
<br>
@@ -69,7 +69,7 @@ After the idp record creation, the idp needs to get configured with the respecti
6969
<br>
7070

7171
<p align="center">
72-
<img width="683" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/e98d5fa8-9fe4-4200-af31-8c1fa4cd3586">
72+
<img width="683" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/create-idp-step-one-done.png">
7373
</p>
7474

7575
<br>
@@ -117,7 +117,7 @@ when calling the endpoint - validate the acting user assigned company and check
117117
The final step is the user connection test. For this the acting user needs to enter the own user ID into the input field. This user ID will get stored and is the unique identifier when performing the login. Via this ID the existing user account inside the portal iam solution is getting linked to the company IdP user account. This enables the user to login with the already assigned user roles.
118118

119119
<p align="center">
120-
<img width="682" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/1aed7ae6-d88c-4165-a9f1-2a42ff35d8c8">
120+
<img width="682" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/create-idp-step-two-done.png">
121121
</p>
122122

123123
<br>
@@ -135,7 +135,7 @@ Implementation details:
135135
<br>
136136

137137
<p align="center">
138-
<img width="684" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/bf670818-6fab-4a75-8ace-afad4e0132ab">
138+
<img width="684" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/create-idp-step-three-done.png">
139139
</p>
140140

141141
<br>

docs/developer/02. Technical Integration/02. Identity Provider Management/04. Delete Identity Provider.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
### Identity Provider Deletion
22

33
<p align="center">
4-
<img width="786" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/845ed775-f581-49ef-813d-5fb2fa72d2e1">
4+
<img width="786" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/delete-company-idp.png">
55
</p>
66

77
<br>

docs/developer/02. Technical Integration/02. Identity Provider Management/05. Disable Identity Provider.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
### Identity Provider Disable
22

33
<p align="center">
4-
<img width="659" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/fdc815e0-2488-4f81-b7cb-df8441a9294a">
4+
<img width="659" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/idp-overview-webpage-disable.png">
55
</p>
66

77
<br>

docs/developer/02. Technical Integration/03. Company Configuration/05. Change Company Role.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Response Body
4949

5050
##### Data Mapping
5151

52-
<img width="777" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/e325b77a-be56-40c0-8255-3cc801efdd25">
52+
<img width="777" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/change-company-role-data-mapping.png">
5353

5454
<br>
5555
<br>

docs/developer/02. Technical Integration/04. Credentials/01. Get UseCase Credential.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Functional Description: [here](/docs/user/06.%20Certificates/01.%20UseCase%20Par
1212
<br>
1313

1414
<p align="center">
15-
<img width="700" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/87be492d-4b3c-4bd2-8801-6a69f3f1819a">
15+
<img width="700" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/usecase-credential-backend-schema.png">
1616
</p>
1717

1818
<br>
@@ -21,7 +21,7 @@ Functional Description: [here](/docs/user/06.%20Certificates/01.%20UseCase%20Par
2121
### Displaying available Credential Types
2222

2323
<br>
24-
<img width="636" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/c5ded524-278e-4995-8013-3987a3af7938">
24+
<img width="636" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/usecase-credential-application-overview.png">
2525
<br>
2626
<br>
2727

docs/developer/02. Technical Integration/04. Credentials/02. Other Certificates.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Functional Description: [here](/docs/user/06.%20Certificates/02.%20Other%20Certi
1717
<br>
1818

1919
<p align="center">
20-
<img width="700" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/87be492d-4b3c-4bd2-8801-6a69f3f1819a">
20+
<img width="700" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/usecase-credential-backend-schema.png">
2121
</p>
2222

2323
<br>
@@ -26,7 +26,7 @@ Functional Description: [here](/docs/user/06.%20Certificates/02.%20Other%20Certi
2626
### Display certificates and status
2727

2828
<br>
29-
<img width="836" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/d3e200ec-cb6b-4992-a21c-1d7dcbf57495">
29+
<img width="836" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/uploaded-certificates-overview.png">
3030
<br>
3131
<br>
3232

@@ -78,7 +78,7 @@ Backend Logic:
7878

7979
[x] if the api response is empty, no certificate can get uploaded - in this case the upload button should be inactive
8080

81-
<img width="203" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/efc6a740-1151-4544-b55f-847790925a57">
81+
<img width="203" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/upload-certificate-button.png">
8282

8383
<br>
8484
<br>

docs/developer/02. Technical Integration/04. Credentials/03. Credential Admin Board.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The credential admin board enables the administrator to view credential requests and approve/reject them.
44

55
<p align="center">
6-
<img width="636" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/2600802f-7fb2-444f-8977-d215af462f94">
6+
<img width="636" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/credential-request-overview.png">
77
</p>
88

99
The administrator can:

docs/developer/03. User Management/01. User Account/02. My User Account.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The views mainly differ in the access permission as well as possible "edit" func
99
Below the screen for "my user account" is displayed. This view is only accessible for users own account.
1010

1111
<p align='center'>
12-
<img width="710" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/26c21558-0a3b-4071-b6da-b5ed2f4db31b">
12+
<img width="710" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/my-account-overview.png">
1313
</p>
1414

1515
<br>
@@ -69,7 +69,7 @@ Response Body
6969
##### User Information
7070

7171
<p align="center">
72-
<img width="724" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/d6d51720-2660-4ac6-9fd0-b6304cb80c79">
72+
<img width="724" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/my-account-details.png">
7373
</p>
7474

7575
<br>
@@ -88,7 +88,7 @@ Information are mainly fetched from company_users table as well as:
8888
##### User Assigned Permissions
8989

9090
<p align="center">
91-
<img width="679" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/8cef8cfc-4638-4a53-8207-3759999b6983">
91+
<img width="679" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/my-account-app-permissions.png">
9292
</p>
9393

9494
Displays the user assigned permission per app.

0 commit comments

Comments
 (0)