Skip to content

Commit

Permalink
Merge pull request #242 from eclipse-tractusx/release/v1.8.0-RC3
Browse files Browse the repository at this point in the history
build(1.8.0-RC3): merge release into main
  • Loading branch information
evegufy authored Jan 31, 2024
2 parents 61743e3 + dd5ccee commit 4b0dbfe
Show file tree
Hide file tree
Showing 397 changed files with 1,183 additions and 261 deletions.
86 changes: 86 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
{
"fileHeaderComment.parameter": {
"*": {
"commentbegin": "/********************************************************************************",
"commentend": " ********************************************************************************/",
"commentprefix": "",
"commentbegin#": "###############################################################",
"commentend#": "###############################################################",
"commentprefix#": "#",
"commentbegin<!->": "<!--",
"commentend<!->": "-->",
"commentprefix<!->": "-",
"cx_header_default": [
"* Copyright (c) 2024 Contributors to the Eclipse Foundation",
" *",
" * See the NOTICE file(s) distributed with this work for additional",
" * information regarding copyright ownership.",
" *",
" * This program and the accompanying materials are made available under the",
" * terms of the Apache License, Version 2.0 which is available at",
" * https://www.apache.org/licenses/LICENSE-2.0.",
" *",
" * Unless required by applicable law or agreed to in writing, software",
" * distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT",
" * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the",
" * License for the specific language governing permissions and limitations",
" * under the License.",
" *",
" * SPDX-License-Identifier: Apache-2.0"
],
"cx_header_with_#": [
"Copyright (c) 2024 Contributors to the Eclipse Foundation",
"",
" See the NOTICE file(s) distributed with this work for additional",
" information regarding copyright ownership.",
"",
" This program and the accompanying materials are made available under the",
" terms of the Apache License, Version 2.0 which is available at",
" https://www.apache.org/licenses/LICENSE-2.0.",
"",
" Unless required by applicable law or agreed to in writing, software",
" distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT",
" WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the",
" License for the specific language governing permissions and limitations",
" under the License.",
"",
" SPDX-License-Identifier: Apache-2.0"
],
"cx_header_with_<!->": [
"Copyright (c) 2024 Contributors to the Eclipse Foundation",
"-",
"- See the NOTICE file(s) distributed with this work for additional",
"- information regarding copyright ownership.",
"-",
"- This program and the accompanying materials are made available under the",
"- terms of the Apache License, Version 2.0 which is available at",
"- https://www.apache.org/licenses/LICENSE-2.0.",
"-",
"- Unless required by applicable law or agreed to in writing, software",
"- distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT",
"- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the",
"- License for the specific language governing permissions and limitations",
"- under the License.",
"-",
"- SPDX-License-Identifier: Apache-2.0"
]
}
},
"fileHeaderComment.template": {
"cx_header_default": [
"${commentbegin}",
"${commentprefix} ${cx_header_default}",
"${commentend}"
],
"cx_header_with_<!->": [
"${commentbegin<!->}",
"${commentprefix<!->} ${cx_header_with_<!->}",
"${commentend<!->}"
],
"cx_header_with_#": [
"${commentbegin#}",
"${commentprefix#} ${cx_header_with_#}",
"${commentend#}"
]
}
}
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@

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

## 1.8.0-RC3

### Change

- removed references to consortia environments
- removed image reference to catena-ng in documentation
- adjusted directory structure for app and service release process documentation
- enhanced local development documentation for frontend in regards to backend and interface connection

### Bugfix

- added standard library template to sections under company roles

## 1.8.0-RC2

### Change
Expand Down
16 changes: 16 additions & 0 deletions FILEHEADER.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Copyright and License Header

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.

## Use the 'File Header Comment' VS Code extension

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.

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.

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.

Currently the following templates are available:

- cx_header_default
- cx*header_with*#
Original file line number Diff line number Diff line change
Expand Up @@ -551,7 +551,8 @@ Response "Success" => set status to "DONE"
##### Details "Activation"

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

<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ In the technical integration / setup of the connector, 3 different scenarios are
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)
<br>
<br>
<img width="1313" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/be138852-6112-4914-9572-c7d9f332e408">
<img width="1313" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/connector-registration-overview.png">
<br>
<br>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

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

Expand Down Expand Up @@ -151,7 +151,7 @@ Response Body

Data Mapping

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

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## 1. Create new Connector Registration - self-owned

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

Expand Down Expand Up @@ -135,7 +135,7 @@ Request Body

## 2. Create new Connector Registration - managed

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

<br>
<br>
Expand Down Expand Up @@ -224,7 +224,7 @@ Request Body
> }
> ]
>
> <img width="740" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/892595c3-6afa-41ec-bdcf-e09fc567541b">
> <img width="740" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/connector-application-endpoint.png">
<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ In case the endpoint runs on an 500 error the following error will get displayed

<br>

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

<br>

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

<br>

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

<br>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<br>

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

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

Status #1 - currently not needed/relevant

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

<br>

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

<br>

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

<br>

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

<br>

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

<br>

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

<br>

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

<br>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The initial overlay is used to create the IdP record with the respective IdP typ
<br>

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

<br>
Expand Down Expand Up @@ -69,7 +69,7 @@ After the idp record creation, the idp needs to get configured with the respecti
<br>

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

<br>
Expand Down Expand Up @@ -117,7 +117,7 @@ when calling the endpoint - validate the acting user assigned company and check
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.

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

<br>
Expand All @@ -135,7 +135,7 @@ Implementation details:
<br>

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

<br>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
### Identity Provider Deletion

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

<br>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
### Identity Provider Disable

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

<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Response Body

##### Data Mapping

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

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Functional Description: [here](/docs/user/06.%20Certificates/01.%20UseCase%20Par
<br>

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

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

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Functional Description: [here](/docs/user/06.%20Certificates/02.%20Other%20Certi
<br>

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

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

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

Expand Down Expand Up @@ -78,7 +78,7 @@ Backend Logic:

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

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

<br>
<br>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The credential admin board enables the administrator to view credential requests and approve/reject them.

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

The administrator can:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The views mainly differ in the access permission as well as possible "edit" func
Below the screen for "my user account" is displayed. This view is only accessible for users own account.

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

<br>
Expand Down Expand Up @@ -69,7 +69,7 @@ Response Body
##### User Information

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

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

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

Displays the user assigned permission per app.
Expand Down
Loading

0 comments on commit 4b0dbfe

Please sign in to comment.