-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
release: merge release into main (#118)
- Loading branch information
Showing
24 changed files
with
345 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| ## Summary | ||
|
|
||
|
|
||
| The app change process is implemented to support app providers to change apps which are active. | ||
| <br> | ||
| <br> | ||
| There is a number of change scenarios, in the first implementation round the following change scenarios are considered | ||
| <br> | ||
|
|
||
| * App Deactivation | ||
| * Add App Role - not yet supported | ||
| * Change Documents - not yet supported | ||
| * Change Description | ||
| * Change Image | ||
|
|
||
| <br> | ||
|
|
||
| On purpose, the change scenarios are kept limited for the first release of "app change" to ensure that the implementation is supporting a number of key scenarios within the given / available implementation slot. | ||
|
|
||
| <br> | ||
| <br> | ||
|
|
||
| Functional Details: [click here](/docs/04.%20App(s)/06.%20App%20Change%20Process/01.%20Summary.md) | ||
|
|
||
| <br> | ||
| <br> |
40 changes: 40 additions & 0 deletions
40
developer/04. Apps/06. App Change Process/02. Change App Lead Image.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| ## Summary | ||
|
|
||
|
|
||
| App Providers can adjust the app lead image via the "App Overview" page. | ||
| The change has direct impact on the app card displayed on the marketplace as well as the app detail page and other connected pages where the lead image is fetched. | ||
| Please note that a delay of displaying the new lead image could appear, in case a longer cache hold of the image is configured. | ||
|
|
||
| Functional Description: [click](./docs/04.%20App(s)/06.%20App%20Change%20Process/02.%20Change%20App%20Lead%20Image.md) | ||
|
|
||
| <br> | ||
|
|
||
| ## Implementation | ||
|
|
||
| ```diff | ||
| POST /api/apps/AppChange/{appId}/appLeadImage | ||
| ``` | ||
|
|
||
| <br> | ||
|
|
||
| Request Body | ||
|
|
||
| image file - png/jpeg | ||
|
|
||
| <br> | ||
|
|
||
| #### Validation: | ||
|
|
||
| * only png and jpeg are allowed | ||
| * the user can only update the image; if the user assigned company_id is the same as the app/offer provider_company_id | ||
| * app status = "ACTIVE" | ||
|
|
||
|
|
||
| #### Logic: | ||
|
|
||
| * if all pre-requisites/validations are met, the document is getting stored in the portal.documents table | ||
| * link between the document and the app/offer is created in table portal.offer_assigned_documents | ||
| * previous leadImage status is changed from "LOCKED" to "INACTIVE" in table portal.documents | ||
|
|
||
| <br> | ||
| <br> |
44 changes: 44 additions & 0 deletions
44
developer/04. Apps/06. App Change Process/03. Change App Description.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| ## Summary | ||
|
|
||
|
|
||
| App Providers can adjust the app description (short and long) via the "App Overview" page. | ||
| The change has direct impact on the app details displayed in the marketplace other connected pages where the app description is used/displayed. | ||
|
|
||
| Functional Description: [click](./docs/04.%20App(s)/06.%20App%20Change%20Process/03.%20Change%20App%20Description.md) | ||
|
|
||
| <br> | ||
|
|
||
| ## Implementation | ||
|
|
||
| ```diff | ||
| PUT /api/apps/AppChange/{appId}/appupdate/description | ||
| ``` | ||
|
|
||
| <br> | ||
|
|
||
| Request Body | ||
|
|
||
| [ | ||
| { | ||
| "languageCode": "string", | ||
| "longDescription": "string", | ||
| "shortDescription": "string" | ||
| } | ||
| ] | ||
|
|
||
| <br> | ||
|
|
||
| #### Validation: | ||
|
|
||
| * app id is found in table offers and has the offer_type_id "APP" | ||
| * calling user need to belong to the same company as the app (check via offer.provider_company_id) | ||
| * status of the app is "ACTIVE" | ||
|
|
||
|
|
||
| #### Logic: | ||
|
|
||
| * store the long and short description for the respective language inside the portal table offer_descriptions | ||
| * important: if records are already existing; overwrite the existing record | ||
|
|
||
| <br> | ||
| <br> |
2 changes: 1 addition & 1 deletion
2
...6. App Change Process/App Deactivation.md → ...pp Change Process/04. App Deactivation.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
26 changes: 26 additions & 0 deletions
26
developer/04. Apps/06. App Change Process/05. App Instance Url.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| ## App Tenant URL Change | ||
|
|
||
| The app tenant url change is in a different area located as the app offer details change. | ||
| To change the app url of a specific instance, the app subscription management board need to get opened. | ||
| Inside the board all active subscriptions can get viewed and filtered. Select the respective relevant subscription and click on "Details". | ||
|
|
||
| <br> | ||
|
|
||
| Functional Description: [Link](/docs/04.%20App(s)/06.%20App%20Change%20Process/03.%20Change%20App%20Tenant%20URL.md) | ||
|
|
||
| <br> | ||
| <br> | ||
|
|
||
| ### Trigger App Instance Url Switch | ||
|
|
||
| ``` | ||
| ! PUT /api/apps/appchange/{appId}/subscription/{subscriptionId}/tenantUrl | ||
| ``` | ||
| Request Body | ||
|
|
||
| { | ||
| "url": "string" | ||
| } | ||
|
|
||
| <br> | ||
| <br> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
30 changes: 30 additions & 0 deletions
30
docs/04. App(s)/06. App Change Process/02. Change App Lead Image.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| ## Summary | ||
|
|
||
| App Providers can adjust the app lead image via the "App Overview" page. | ||
| The change has direct impact on the app card displayed on the marketplace as well as the app detail page and other connected pages where the lead image is fetched. | ||
| Please note that a delay of displaying the new lead image could appear, in case a longer cache hold of the image is configured. | ||
|
|
||
| <br> | ||
|
|
||
| To change the app lead image, select "Change Image" via the app management app card sub-menu | ||
| <br> | ||
| <img width="254" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/af2ea87d-d9c6-4870-9aa4-3afd01f6e2d6"> | ||
| <br> | ||
| <br> | ||
|
|
||
| By selecting the button "upload new image" the dropzone element will get displayed and the user can upload the new jpeg/png file. | ||
| Please make sure that the image has a valid size - ideally below 0.8 MB | ||
|
|
||
| <br> | ||
|
|
||
| Important; the change is not reversible. However you can upload a new image whenever you like. | ||
|
|
||
| <br> | ||
| <br> | ||
|
|
||
| <p align="center"> | ||
| <img width="836" alt="image" src="https://github.com/catenax-ng/tx-portal-assets/assets/94133633/0020d840-a15e-4890-883f-9f15be69f8bd"> | ||
| </p> | ||
|
|
||
| <br> | ||
| <br> |
Oops, something went wrong.