8342d15b03
## Description > Need an api to vend out messages for users alerting them of breaking changes in upcoming releases. #### PR fixes following issue(s) Fixes #23064 #### Type of change - New feature (non-breaking change which adds functionality) ## Testing > #### How Has This Been Tested? - [x] Manual - [ ] Jest - [ ] Cypress > > #### Test Plan > This should be tested using curl by hitting the api endpoint endpoint without any context and get a message in return that was configured in a config file. ## Checklist: #### Dev activity - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag #### QA activity: - [ ] [Speedbreak features](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#speedbreakers-) have been covered - [ ] Test plan covers all impacted features and [areas of interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#areas-of-interest-) - [ ] Test plan has been peer reviewed by project stakeholders and other QA members - [ ] Manually tested functionality on DP - [ ] We had an implementation alignment call with stakeholders post QA Round 2 - [ ] Cypress test cases have been added and approved by SDET/manual QA - [ ] Added `Test Plan Approved` label after Cypress tests were reviewed - [ ] Added `Test Plan Approved` label after JUnit tests were reviewed --------- Co-authored-by: Hetu Nandu <hetunandu@gmail.com> Co-authored-by: Hetu Nandu <hetu@appsmith.com>
29 lines
819 B
TypeScript
29 lines
819 B
TypeScript
/***
|
|
* Product update is used to show a fixed banner to (all) users at the bottom
|
|
* of the screen. It should only be shown to
|
|
*
|
|
*/
|
|
|
|
type ProductUpdate = {
|
|
id: string; // ID is important for dismissal and remindLater to work
|
|
enabled: boolean; // Won't be shown till this is true
|
|
title: string;
|
|
message: string;
|
|
learnMoreLink: string;
|
|
canDismiss: boolean; // Can the user close this message.
|
|
remindLaterDays?: number; // If the user chooses to remind later, // it will be shown again after these many days
|
|
};
|
|
|
|
const update: ProductUpdate = {
|
|
enabled: false,
|
|
id: "1",
|
|
title: "Test issue",
|
|
message:
|
|
"Something is wrong. Lorem ipsum something something. You need to learn this",
|
|
learnMoreLink: "https://docs.appsmith.com",
|
|
canDismiss: true,
|
|
remindLaterDays: 1,
|
|
};
|
|
|
|
export default update;
|