@sap/ux-specification 1.120.22 → 1.120.24

package/dist/schemas/v2/OverviewPageConfig.json

@@ -2,13 +2,13 @@
   "type": "object",
   "properties": {
     "globalFilterModel": {
-      "description": "Represents the name of global filter OData model, which  contains entities definition that are relevant for global filters.",
+      "description": "Represents the name of the global OData filter model.",
       "pattern": "^[a-zA-Z0-9_\\\\.\\\\-\\\\|@]*$",
       "type": "string",
       "artifactType": "Manifest"
     },
     "globalFilterEntityType": {
-      "description": "Represents the entity to use as global filter in the smart filter bar control.",
+      "description": "Represents the entity type to use as global filter in the smart filter bar control.",
       "pattern": "^[a-zA-Z0-9_\\\\.\\\\-\\\\|@]*$",
       "type": "string",
       "artifactType": "Manifest"
@@ -70,7 +70,7 @@
       "artifactType": "Manifest"
     },
     "considerAnalyticalParameters": {
-      "description": "Flag to enable/disable analytical parameter support for Smart filter bar. The default value is false.",
+      "description": "Flag to enable or disable analytical parameter support for the smart filter bar. The default value is false.",
       "type": "boolean",
       "artifactType": "Manifest"
     },
@@ -80,7 +80,7 @@
       "artifactType": "Manifest"
     },
     "useDateRangeType": {
-      "description": "Flag to enable/disable semantic date range control for Smart filter bar. The default value is false.",
+      "description": "Flag to enable or disable semantic date range control for the smart filter bar. The default value is false.",
       "type": "boolean",
       "artifactType": "Manifest"
     },
@@ -94,14 +94,14 @@
       "properties": {
         "dateSettings": {
           "$ref": "#/definitions/DateRangeOVP",
-          "description": "Represents the object to store date type filter fields configuration"
+          "description": "Represents the object to store the configuration for the date type's filter fields."
         }
       },
       "additionalProperties": false,
       "artifactType": "Manifest"
     },
     "dataLoadSettings": {
-      "description": "Represents the object to define data loading behaviour for an overview page application",
+      "description": "Represents the object to define data loading behaviour for an overview page application.",
       "type": "object",
       "additionalProperties": {},
       "properties": {
@@ -255,7 +255,7 @@
           }
         },
         "exclude": {
-          "description": "The exclude property is set to True by default. This means excluding all values given as selectedValues from the list of date range filters. If the exclude property is set to False, the application shows only selected values in the list of date range filters.",
+          "description": "This property is set to True by default. This excludes all values given as selectedValues from the list of date range filters.\nIf the exclude property is set to False, the application shows only selected values in the list of date range filters.",
           "type": "boolean"
         }
       },
@@ -266,7 +266,7 @@
       "type": "object",
       "properties": {
         "selectedValues": {
-          "description": "The selectedValues property is a set of standard date range values that you want to include or exclude.",
+          "description": "Defines a set of standard date range values that you want to include or exclude.",
           "type": "array",
           "items": {
             "enum": [
@@ -341,7 +341,7 @@
                 "description": "Choose 'key' to define filter values for single values of the date range, or 'category' to filter by a whole subset."
               },
               "contains": {
-                "description": "The 'contains' string specifies a filter describing a set of values of the date range type.",
+                "description": "Specifies a filter describing a set of values of the date range type.",
                 "type": "string"
               },
               "equals": {
@@ -402,7 +402,7 @@
                 }
               },
               "exclude": {
-                "description": "The exclude property is set to True by default. This means excluding all values given as selectedValues from the list of date range filters. If the exclude property is set to False, the application shows only selected values in the list of date range filters.",
+                "description": "This property is set to True by default which excludes all values given as selectedValues from the list of date range filters.\nIf this property is set to False, the application shows only selected values in the list of date range filters.",
                 "type": "boolean"
               }
             },
@@ -748,17 +748,17 @@
           "artifactType": "Manifest"
         },
         "addODataSelect": {
-          "description": "add $Select parameter in data fetch URL",
+          "description": "Determines if the $Select parameter shall be added to data fetch requests.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
         "sortBy": {
-          "description": "Defines the property by which the list shall be sorted.",
+          "description": "Defines the property by which the list is sorted.",
           "type": "string",
           "artifactType": "Manifest"
         },
         "sortOrder": {
-          "description": "Sort order (ascending or descending)",
+          "description": "Sort order (ascending or descending).",
           "enum": [
             "ascending",
             "descending"
@@ -772,7 +772,7 @@
           "artifactType": "Manifest"
         },
         "showRefresh": {
-          "description": "Show or hide refresh option under card more actions, default value is true.",
+          "description": "Determines if the refresh icon is shown under a card's more actions. The default value is true.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
@@ -782,12 +782,12 @@
           "artifactType": "Manifest"
         },
         "showFilterInHeader": {
-          "description": "Represents a switch to Show or Hide Filters in Cards Headers in OVP application.",
+          "description": "Determines if filters are shown in card headers.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
         "showSortingInHeader": {
-          "description": "Represents a switch to Show or Hide Sorting in Cards Headers in OVP application.",
+          "description": "Determines if sorting is shown in card headers.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
@@ -806,27 +806,27 @@
       "type": "object",
       "properties": {
         "cols": {
-          "description": "Represents the number of the number of grid columns",
+          "description": "Represents the number of grid columns.",
           "type": "number",
           "artifactType": "Manifest"
         },
         "rows": {
-          "description": "Represents the number of the number of grid rows",
+          "description": "Represents the number of grid rows.",
           "type": "number",
           "artifactType": "Manifest"
         },
         "showOnlyHeader": {
-          "description": "Represents if user wants to show only header part of card in resizable layout",
+          "description": "Determines if only the header part of a card is shown in the resizable layout.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
         "minimumTitleRow": {
-          "description": "If user wants to show more text in title then he/she can configure no of lines to be shown in title(Maximum allowed 3 lines)",
+          "description": "Sets the number of lines for the title row. The maximum is 3.",
           "type": "number",
           "artifactType": "Manifest"
         },
         "minimumSubTitleRow": {
-          "description": "If user wants to show more text in title then he/she can configure no of lines to be shown in sub-title(Maximum allowed 2 lines)",
+          "description": "Sets the number of lines for the subtitle row. The maximum is 2.",
           "type": "number",
           "artifactType": "Manifest"
         }
@@ -1067,12 +1067,12 @@
       "type": "object",
       "properties": {
         "model": {
-          "description": "Represents the model for the List Card",
+          "description": "Represents the model for the list card.",
           "type": "string",
           "artifactType": "Manifest"
         },
         "template": {
-          "description": "Represents the card component path to use for this List Card.",
+          "description": "Represents the card component path to use.",
           "enum": [
             "sap.ovp.cards.list",
             "sap.ovp.cards.v4.list"
@@ -1097,12 +1097,12 @@
       "properties": {
         "listFlavor": {
           "$ref": "#/definitions/ListFlavorType",
-          "description": "Represents the flavor of the list to use in this card. The flavor can be bar chart, carousel or standard.",
+          "description": "Represents the flavor of the list to use in this card.",
           "artifactType": "Manifest"
         },
         "listType": {
           "$ref": "#/definitions/ListTypeType",
-          "description": "Represents the type of list to use for this card. The list can be extended to display more information or condensed to take up less space on the card.",
+          "description": "Represents the type of list to use for this card.\nThe list can be extended to display more information or condensed to take up less space.",
           "artifactType": "Manifest"
         },
         "showLineItemDetail": {
@@ -1327,17 +1327,17 @@
           "artifactType": "Manifest"
         },
         "addODataSelect": {
-          "description": "add $Select parameter in data fetch URL",
+          "description": "Determines if the $Select parameter shall be added to data fetch requests.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
         "sortBy": {
-          "description": "Defines the property by which the list shall be sorted.",
+          "description": "Defines the property by which the list is sorted.",
           "type": "string",
           "artifactType": "Manifest"
         },
         "sortOrder": {
-          "description": "Sort order (ascending or descending)",
+          "description": "Sort order (ascending or descending).",
           "enum": [
             "ascending",
             "descending"
@@ -1351,7 +1351,7 @@
           "artifactType": "Manifest"
         },
         "showRefresh": {
-          "description": "Show or hide refresh option under card more actions, default value is true.",
+          "description": "Determines if the refresh icon is shown under a card's more actions. The default value is true.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
@@ -1361,12 +1361,12 @@
           "artifactType": "Manifest"
         },
         "showFilterInHeader": {
-          "description": "Represents a switch to Show or Hide Filters in Cards Headers in OVP application.",
+          "description": "Determines if filters are shown in card headers.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
         "showSortingInHeader": {
-          "description": "Represents a switch to Show or Hide Sorting in Cards Headers in OVP application.",
+          "description": "Determines if sorting is shown in card headers.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
@@ -1403,12 +1403,12 @@
       "type": "object",
       "properties": {
         "model": {
-          "description": "Represents the model for the StackCard.",
+          "description": "Represents the model for the card.",
           "type": "string",
           "artifactType": "Manifest"
         },
         "template": {
-          "description": "Represents the Stack Card component path to use for this card.",
+          "description": "Represents the component path to use for this card.",
           "type": "string",
           "const": "sap.ovp.cards.stack",
           "artifactType": "Manifest"
@@ -1645,17 +1645,17 @@
           "artifactType": "Manifest"
         },
         "addODataSelect": {
-          "description": "add $Select parameter in data fetch URL",
+          "description": "Determines if the $Select parameter shall be added to data fetch requests.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
         "sortBy": {
-          "description": "Defines the property by which the list shall be sorted.",
+          "description": "Defines the property by which the list is sorted.",
           "type": "string",
           "artifactType": "Manifest"
         },
         "sortOrder": {
-          "description": "Sort order (ascending or descending)",
+          "description": "Sort order (ascending or descending).",
           "enum": [
             "ascending",
             "descending"
@@ -1669,7 +1669,7 @@
           "artifactType": "Manifest"
         },
         "showRefresh": {
-          "description": "Show or hide refresh option under card more actions, default value is true.",
+          "description": "Determines if the refresh icon is shown under a card's more actions. The default value is true.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
@@ -1679,12 +1679,12 @@
           "artifactType": "Manifest"
         },
         "showFilterInHeader": {
-          "description": "Represents a switch to Show or Hide Filters in Cards Headers in OVP application.",
+          "description": "Determines if filters are shown in card headers.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
         "showSortingInHeader": {
-          "description": "Represents a switch to Show or Hide Sorting in Cards Headers in OVP application.",
+          "description": "Determines if sorting is shown in card headers.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
@@ -1749,12 +1749,12 @@
       "type": "object",
       "properties": {
         "model": {
-          "description": "Represents the model for the Link list Card.",
+          "description": "Represents the model for the link list card.",
           "type": "string",
           "artifactType": "Manifest"
         },
         "template": {
-          "description": "Represents the Link list Card component path to use for this card.",
+          "description": "Represents the component path to use for this card.",
           "enum": [
             "sap.ovp.cards.linklist",
             "sap.ovp.cards.v4.linklist"
@@ -1778,7 +1778,7 @@
       "properties": {
         "listFlavor": {
           "$ref": "#/definitions/LinkListFlavorType",
-          "description": "listFlavor represents the flavor of the list to use in this card. The flavor can be bar chart, carousel or standard.",
+          "description": "listFlavor represents the flavor of the list to use in this card.",
           "artifactType": "Manifest"
         },
         "headerAnnotationPath": {
@@ -1787,7 +1787,7 @@
           "artifactType": "Manifest"
         },
         "staticContent": {
-          "description": "staticContent represents the static content of a static link list card.",
+          "description": "staticContent represents the content of a static link list card.",
           "type": "array",
           "items": {
             "$ref": "#/definitions/StaticContent"
@@ -1996,17 +1996,17 @@
           "artifactType": "Manifest"
         },
         "addODataSelect": {
-          "description": "add $Select parameter in data fetch URL",
+          "description": "Determines if the $Select parameter shall be added to data fetch requests.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
         "sortBy": {
-          "description": "Defines the property by which the list shall be sorted.",
+          "description": "Defines the property by which the list is sorted.",
           "type": "string",
           "artifactType": "Manifest"
         },
         "sortOrder": {
-          "description": "Sort order (ascending or descending)",
+          "description": "Sort order (ascending or descending).",
           "enum": [
             "ascending",
             "descending"
@@ -2020,7 +2020,7 @@
           "artifactType": "Manifest"
         },
         "showRefresh": {
-          "description": "Show or hide refresh option under card more actions, default value is true.",
+          "description": "Determines if the refresh icon is shown under a card's more actions. The default value is true.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
@@ -2030,12 +2030,12 @@
           "artifactType": "Manifest"
         },
         "showFilterInHeader": {
-          "description": "Represents a switch to Show or Hide Filters in Cards Headers in OVP application.",
+          "description": "Determines if filters are shown in card headers.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
         "showSortingInHeader": {
-          "description": "Represents a switch to Show or Hide Sorting in Cards Headers in OVP application.",
+          "description": "Determines if sorting is shown in card headers.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
@@ -2061,30 +2061,30 @@
       "type": "object",
       "properties": {
         "title": {
-          "description": "The language-dependent title of the StaticContent.",
-          "i18nClassification": "TIT: Title of the StaticContent",
+          "description": "The language-dependent title of the static content.",
+          "i18nClassification": "TIT: Title of the static content",
           "type": "string"
         },
         "subTitle": {
-          "description": "The language-dependent subtitle of the StaticContent.",
-          "i18nClassification": "TIT: Subtitle of the StaticContent",
+          "description": "The language-dependent subtitle of the static content.",
+          "i18nClassification": "TIT: Subtitle of the static content",
           "type": "string"
         },
         "imageUri": {
-          "description": "The uri for the image of the StaticContent.",
+          "description": "The URI for the image of the static content.",
           "type": "string"
         },
         "targetUri": {
-          "description": "The uri for the target of the StaticContent.",
+          "description": "The URI for the target of the static content.",
           "type": "string"
         },
         "imageAltText": {
-          "description": "The alternative text for the image of the StaticContent.",
-          "i18nClassification": "ALT: The alternative text for the image of the StaticContent",
+          "description": "The alternative text for the image of the static content.",
+          "i18nClassification": "ALT: The alternative text for the image of the static content.",
           "type": "string"
         },
         "semanticObject": {
-          "description": "Used to provide intent based navigation.",
+          "description": "Used to provide intent-based navigation.",
           "type": "string"
         },
         "action": {
@@ -2108,12 +2108,12 @@
       "type": "object",
       "properties": {
         "model": {
-          "description": "Represents the model for the TableCard.",
+          "description": "Represents the model for the table card.",
           "type": "string",
           "artifactType": "Manifest"
         },
         "template": {
-          "description": "Represents the Table Card component path to use for this card.",
+          "description": "Represents the component path to use for this card.",
           "enum": [
             "sap.ovp.cards.table",
             "sap.ovp.cards.v4.table"
@@ -2137,7 +2137,7 @@
       "type": "object",
       "properties": {
         "showLineItemDetail": {
-          "description": "Flag for show line item detail in list and table card.",
+          "description": "Flag for showing line item details in list and table cards.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
@@ -2353,17 +2353,17 @@
           "artifactType": "Manifest"
         },
         "addODataSelect": {
-          "description": "add $Select parameter in data fetch URL",
+          "description": "Determines if the $Select parameter shall be added to data fetch requests.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
         "sortBy": {
-          "description": "Defines the property by which the list shall be sorted.",
+          "description": "Defines the property by which the list is sorted.",
           "type": "string",
           "artifactType": "Manifest"
         },
         "sortOrder": {
-          "description": "Sort order (ascending or descending)",
+          "description": "Sort order (ascending or descending).",
           "enum": [
             "ascending",
             "descending"
@@ -2377,7 +2377,7 @@
           "artifactType": "Manifest"
         },
         "showRefresh": {
-          "description": "Show or hide refresh option under card more actions, default value is true.",
+          "description": "Determines if the refresh icon is shown under a card's more actions. The default value is true.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
@@ -2387,12 +2387,12 @@
           "artifactType": "Manifest"
         },
         "showFilterInHeader": {
-          "description": "Represents a switch to Show or Hide Filters in Cards Headers in OVP application.",
+          "description": "Determines if filters are shown in card headers.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
         "showSortingInHeader": {
-          "description": "Represents a switch to Show or Hide Sorting in Cards Headers in OVP application.",
+          "description": "Determines if sorting is shown in card headers.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
@@ -2419,7 +2419,7 @@
           "artifactType": "Manifest"
         },
         "template": {
-          "description": "Represents the Analytical Card component path to use for this card.",
+          "description": "Represents the component path to use for this card.",
           "enum": [
             "sap.ovp.cards.charts.analytical",
             "sap.ovp.cards.v4.charts.analytical"
@@ -2466,7 +2466,7 @@
         },
         "navigation": {
           "$ref": "#/definitions/CardNavigationType",
-          "description": "Represents the configuration to alter the navigation mode in OVP Analytical Cards.",
+          "description": "Represents the configuration to alter the navigation mode.",
           "artifactType": "Manifest"
         },
         "valueSelectionInfo": {
@@ -2562,7 +2562,7 @@
           ]
         },
         "bEnableStableColors": {
-          "description": "Enables the configuration of an analytical card with column stack chart, to map the dimension values to specific colors",
+          "description": "Enables the configuration of an analytical card with a column stack chart to map the dimension values to specific colors.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
@@ -2768,17 +2768,17 @@
           "artifactType": "Manifest"
         },
         "addODataSelect": {
-          "description": "add $Select parameter in data fetch URL",
+          "description": "Determines if the $Select parameter shall be added to data fetch requests.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
         "sortBy": {
-          "description": "Defines the property by which the list shall be sorted.",
+          "description": "Defines the property by which the list is sorted.",
           "type": "string",
           "artifactType": "Manifest"
         },
         "sortOrder": {
-          "description": "Sort order (ascending or descending)",
+          "description": "Sort order (ascending or descending).",
           "enum": [
             "ascending",
             "descending"
@@ -2792,7 +2792,7 @@
           "artifactType": "Manifest"
         },
         "showRefresh": {
-          "description": "Show or hide refresh option under card more actions, default value is true.",
+          "description": "Determines if the refresh icon is shown under a card's more actions. The default value is true.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
@@ -2802,12 +2802,12 @@
           "artifactType": "Manifest"
         },
         "showFilterInHeader": {
-          "description": "Represents a switch to Show or Hide Filters in Cards Headers in OVP application.",
+          "description": "Determines if filters are shown in card headers.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
         "showSortingInHeader": {
-          "description": "Represents a switch to Show or Hide Sorting in Cards Headers in OVP application.",
+          "description": "Determines if sorting is shown in card headers.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
@@ -2856,7 +2856,7 @@
         },
         "navigation": {
           "$ref": "#/definitions/CardNavigationType",
-          "description": "Represents the configuration to alter the navigation mode in OVP Analytical Cards.",
+          "description": "Represents the configuration to alter the navigation mode.",
           "artifactType": "Manifest"
         },
         "valueSelectionInfo": {
@@ -2952,7 +2952,7 @@
           ]
         },
         "bEnableStableColors": {
-          "description": "Enables the configuration of an analytical card with column stack chart, to map the dimension values to specific colors",
+          "description": "Enables the configuration of an analytical card with a column stack chart to map the dimension values to specific colors.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
@@ -3158,17 +3158,17 @@
           "artifactType": "Manifest"
         },
         "addODataSelect": {
-          "description": "add $Select parameter in data fetch URL",
+          "description": "Determines if the $Select parameter shall be added to data fetch requests.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
         "sortBy": {
-          "description": "Defines the property by which the list shall be sorted.",
+          "description": "Defines the property by which the list is sorted.",
           "type": "string",
           "artifactType": "Manifest"
         },
         "sortOrder": {
-          "description": "Sort order (ascending or descending)",
+          "description": "Sort order (ascending or descending).",
           "enum": [
             "ascending",
             "descending"
@@ -3182,7 +3182,7 @@
           "artifactType": "Manifest"
         },
         "showRefresh": {
-          "description": "Show or hide refresh option under card more actions, default value is true.",
+          "description": "Determines if the refresh icon is shown under a card's more actions. The default value is true.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
@@ -3192,12 +3192,12 @@
           "artifactType": "Manifest"
         },
         "showFilterInHeader": {
-          "description": "Represents a switch to Show or Hide Filters in Cards Headers in OVP application.",
+          "description": "Determines if filters are shown in card headers.",
           "type": "boolean",
           "artifactType": "Manifest"
         },
         "showSortingInHeader": {
-          "description": "Represents a switch to Show or Hide Sorting in Cards Headers in OVP application.",
+          "description": "Determines if sorting is shown in card headers.",
           "type": "boolean",
           "artifactType": "Manifest"
         },